Class: AiAgentContextReference
Hierarchy
AiAgentContextReference
Methods
append
▸ append(data, file?): Promise<void>
Appends data to an existing context entry on the chatbot profile. This will result in an error if an entry has not
Parameters
| Name | Type | Description |
|---|---|---|
data | AiChatBotContextData | An object containing options for appending the entry. |
file? | File | The file to append. |
Returns
Promise<void>
delete
▸ delete(): Promise<void>
Deletes an existing context entry on the chatbot profile. This will result in an error if an entry has not yet been created for the current context id.
Returns
Promise<void>
A promise that resolves when the context is successfully deleted.
insert
▸ insert(data, file?): Promise<void>
Adds a new context entry to the chatbot profile. This will result in an error if an entry already exists with the same id.
Parameters
| Name | Type | Description |
|---|---|---|
data | AiChatBotContextData | An object containing options for creating the entry. |
file? | File | The file to insert. |
Returns
Promise<void>
A promise that resolves when the context is successfully created.
update
▸ update(data): Promise<void>
Updates an existing context entry on the chatbot profile. This will result in an error if an entry has not yet been created for the current context id.
Parameters
| Name | Type | Description |
|---|---|---|
data | Partial<AiChatBotContextData> | An object containing options for updating the entry. |
Returns
Promise<void>
A promise that resolves when the context is successfully updated.