Skip to main content

Class: AiChatbotContextReference

Hierarchy

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

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

Returns

Promise<void>

Inherited from

AiAgentContextReference.append


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.

Inherited from

AiAgentContextReference.delete


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

NameTypeDescription
dataAiChatBotContextDataAn object containing options for creating the entry.
file?FileThe file to insert.

Returns

Promise<void>

A promise that resolves when the context is successfully created.

Inherited from

AiAgentContextReference.insert


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

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

Returns

Promise<void>

A promise that resolves when the context is successfully updated.

Inherited from

AiAgentContextReference.update