Skip to main content

Class: AiChatbotInstructionReference

Hierarchy

Methods

delete

delete(): Promise<void>

Deletes an existing instruction entry on the chatbot profile. This will result in an error if an entry has not yet been created for the current instruction id.

Returns

Promise<void>

A promise that resolves when the instruction is successfully deleted.

Inherited from

AiAgentInstructionReference.delete


insert

insert(data): Promise<void>

Adds a new instruction entry to the chatbot profile. This will result in an error if an entry already exists with the same id.

Parameters

NameTypeDescription
dataInstructionDataAn object containing options for creating the entry.

Returns

Promise<void>

A promise that resolves when the instruction is successfully created.

Inherited from

AiAgentInstructionReference.insert


update

update(data): Promise<void>

Updates an existing instruction entry on the chatbot profile. This will result in an error if an entry has not yet been created for the current instruction id.

Parameters

NameTypeDescription
dataInstructionDataAn object containing options for updating the entry.

Returns

Promise<void>

A promise that resolves when the instruction is successfully updated.

Inherited from

AiAgentInstructionReference.update