Skip to main content

Class: AiAgentContextReference

Methods

append

append(data, file?): Promise<void>

Appends data to an existing context entry on the agent. This will result in an error if an entry is not found.

Parameters

NameTypeDescription
dataAiChatBotContextDataAn object containing options for appending the entry.
file?FileThe file to append.

Returns

Promise<void>


delete

delete(): Promise<void>

Deletes an existing context entry for the agent. Throws an error if an entry with the specified context ID does not exist.

Returns

Promise<void>

A promise that resolves when the context entry is successfully deleted.


insert

insert(data, file?): Promise<void>

Adds a new context entry to the agent. Throws an error if an entry with the same ID already exists.

Parameters

NameTypeDescription
dataAiChatBotContextDataAn object containing options for creating the entry.
file?BlobAndFilename | FileThe file to upload (optional).

Returns

Promise<void>

A promise that resolves when the context entry is successfully created.


update

update(data): Promise<void>

Updates an existing context entry for the agent. Throws an error if an entry with the specified context ID does not exist.

Parameters

NameTypeDescription
dataPartial<AiChatBotContextData>An object containing options for updating the entry.

Returns

Promise<void>

A promise that resolves when the context entry is successfully updated.