Class AiAgentReference

AiAgentReference provides methods for managing AI agents, including retrieving, updating, and deleting agents, handling agent contexts, and interacting with chat or voice-based AI functionalities.

Methods

ask

ask(prompt: string, options?: AskOptionsWithoutVoice): Promise<string>
Sends a prompt and receives a full string response.
Parameters
- prompt: string
- Optionaloptions: AskOptionsWithoutVoice
Returns Promise<string>

askWithVoiceResponse

askWithVoiceResponse(
    prompt: string,
    options?: Omit<
        | BaseAiAgentChatOptions
        | GeminiChatOptions
        | OpenAiChatOptions
        | OpenAiReasoningChatOptions
        | AnthropicChatOptions,
        "smoothTyping",
    >,
): Promise<AskWithVoiceResponse>
Sends a prompt and gets both text and voice response from the agent.
Parameters
- prompt: string
- Optionaloptions: Omit<
      | BaseAiAgentChatOptions
      | GeminiChatOptions
      | OpenAiChatOptions
      | OpenAiReasoningChatOptions
      | AnthropicChatOptions,
      "smoothTyping",
  >
Returns Promise<AskWithVoiceResponse>

chat

chat(prompt: string, options?: ChatOptionsWithoutVoice): Observable<string>
Sends a prompt to the agent and receives streamed text responses.
Parameters
- prompt: string
- Optionaloptions: ChatOptionsWithoutVoice
Returns Observable<string>

delete

delete(): Promise<void>
Deletes the AI agent.

Returns Promise<void>

deleteContext

deleteContext(contextId: string): Promise<void>
Deletes a specific context by its ID.
Parameters
- contextId: string
Returns Promise<void>

deleteContexts

deleteContexts(contextIds: string[]): Promise<void>
Deletes multiple agent contexts.
Parameters
- contextIds: string[]
Returns Promise<void>

deleteCustomGuardrail

deleteCustomGuardrail(): Promise<void>
Deletes the custom guardrails for the agent.

Returns Promise<void>

get

get(): Promise<undefined | AiAgent<undefined>>
Retrieves metadata and configuration of the AI agent.

Returns Promise<undefined | AiAgent<undefined>>

getContext

getContext(contextId: string): Promise<undefined | AiAgentContext>
Retrieves a specific agent context by its ID.
Parameters
- contextId: string
Returns Promise<undefined | AiAgentContext>

listContexts

listContexts(): Promise<AiAgentContext[]>
Lists all contexts associated with the agent.

Returns Promise<AiAgentContext[]>

observeStatusUpdates

observeStatusUpdates(
options?: AiObserveStatusOptions,
): Observable<AiStatusMessage>
Observes live status messages from the agent.
Parameters
- Optionaloptions: AiObserveStatusOptions
Returns Observable<AiStatusMessage>

provideFeedback

provideFeedback(feedback: string): Promise<void>
Sends user feedback to the agent.
Parameters
- feedback: string
Returns Promise<void>

resetFeedback

resetFeedback(): Promise<void>
Resets any feedback previously provided to the agent.

Returns Promise<void>

search

search(options: AiSearchOptions): Promise<AiSearchResultChunk[]>
Performs a semantic search using the agent's knowledge base.
Parameters
- options: AiSearchOptions
Returns Promise<AiSearchResultChunk[]>

transcribeAndAsk

transcribeAndAsk(
fileToTranscribe: File,
options?: AskOptionsWithoutVoice,
): Promise<AiTranscribeAndAskResponse>
Transcribes audio and sends it to the agent for response.
Parameters
- fileToTranscribe: File
- Optionaloptions: AskOptionsWithoutVoice
Returns Promise<AiTranscribeAndAskResponse>

transcribeAndAskWithVoiceResponse

transcribeAndAskWithVoiceResponse(
    fileToTranscribe: File,
    options?: Omit<
        | BaseAiAgentChatOptions
        | GeminiChatOptions
        | OpenAiChatOptions
        | OpenAiReasoningChatOptions
        | AnthropicChatOptions,
        "smoothTyping",
    >,
): Promise<TranscribeAndAskWithVoiceResponse>
Transcribes audio and gets both text and voice response from the agent.
Parameters
- fileToTranscribe: File
- Optionaloptions: Omit<
      | BaseAiAgentChatOptions
      | GeminiChatOptions
      | OpenAiChatOptions
      | OpenAiReasoningChatOptions
      | AnthropicChatOptions,
      "smoothTyping",
  >
Returns Promise<TranscribeAndAskWithVoiceResponse>

transcribeAndChat

transcribeAndChat(
fileToTranscribe: File,
options?: ChatOptionsWithoutVoice,
): Promise<TranscribeAndChatResponse>
Transcribes the given file and performs a chat interaction.
Parameters
- fileToTranscribe: File
- Optionaloptions: ChatOptionsWithoutVoice
Returns Promise<TranscribeAndChatResponse>

updateConnectedAgents

updateConnectedAgents(
connectedAgents: AiConnectedAgentMetadata[],
): Promise<void>
Updates the list of agents connected to this agent.
Parameters
- connectedAgents: AiConnectedAgentMetadata[]
Returns Promise<void>

updateCustomGuardrails

updateCustomGuardrails(customGuardrail: string): Promise<void>
Updates the agent's custom guardrails with the provided custom guardrail.
Parameters
- customGuardrail: string
Returns Promise<void>

updateGuardrails

updateGuardrails(guardrails: GuardrailsOptions): Promise<void>
Updates the agent's guardrails with the provided options.
Parameters
- guardrails: GuardrailsOptions
Returns Promise<void>

updateInstructions

updateInstructions(instructions: string): Promise<void>
Updates the agent's instruction prompt.
Parameters
- instructions: string
Returns Promise<void>

updateModel

updateModel(
    model:
        | "o1"
        | "o1-mini"
        | "o3"
        | "o3-mini"
        | "o4-mini"
        | "gpt-4o"
        | "gpt-4o-mini"
        | "gemini-1.5-pro"
        | "gemini-2.0-flash"
        | "claude-3-5-haiku-latest"
        | "claude-3-5-sonnet-latest"
        | "claude-3-7-sonnet-latest",
): Promise<void>
Changes the AI model used by the agent.
Parameters
- model:
      | "o1"
      | "o1-mini"
      | "o3"
      | "o3-mini"
      | "o4-mini"
      | "gpt-4o"
      | "gpt-4o-mini"
      | "gemini-1.5-pro"
      | "gemini-2.0-flash"
      | "claude-3-5-haiku-latest"
      | "claude-3-5-sonnet-latest"
      | "claude-3-7-sonnet-latest"
Returns Promise<void>

upsert

upsert(agent: UpsertAgentRequestParams): Promise<void>
Creates or updates the AI agent with the provided parameters.
Parameters
- agent: UpsertAgentRequestParams
Returns Promise<void>

upsertContext

upsertContext(contextRequest: AgentContextRequest, file?: File): Promise<void>
Adds or updates a single agent context.
Parameters
- contextRequest: AgentContextRequest
- Optionalfile: File
Returns Promise<void>

upsertContexts

upsertContexts(
contextRequests: AgentContextRequest[],
files?: File[],
): Promise<void>
Adds or updates multiple agent contexts.
Parameters
- contextRequests: AgentContextRequest[]
- Optionalfiles: File[]
Returns Promise<void>

Class AiAgentReference

Index

Methods

Methods

ask

Parameters

Returns Promise<string>

askWithVoiceResponse

Parameters

Returns Promise<AskWithVoiceResponse>

chat

Parameters

Returns Observable<string>

delete

Returns Promise<void>

deleteContext

Parameters

Returns Promise<void>

deleteContexts

Parameters

Returns Promise<void>

deleteCustomGuardrail

Returns Promise<void>

get

Returns Promise<undefined | AiAgent<undefined>>

getContext

Parameters

Returns Promise<undefined | AiAgentContext>

listContexts

Returns Promise<AiAgentContext[]>

observeStatusUpdates

Parameters

Returns Observable<AiStatusMessage>

provideFeedback

Parameters

Returns Promise<void>

resetFeedback

Returns Promise<void>

search

Parameters

Returns Promise<AiSearchResultChunk[]>

transcribeAndAsk

Parameters

Returns Promise<AiTranscribeAndAskResponse>

transcribeAndAskWithVoiceResponse

Parameters

Returns Promise<TranscribeAndAskWithVoiceResponse>

transcribeAndChat

Parameters

Returns Promise<TranscribeAndChatResponse>

updateConnectedAgents

Parameters

Returns Promise<void>

updateCustomGuardrails

Parameters

Returns Promise<void>

updateGuardrails

Parameters

Returns Promise<void>

updateInstructions

Parameters

Returns Promise<void>

updateModel

Parameters

Returns Promise<void>

upsert

Parameters

Returns Promise<void>

upsertContext

Parameters

Returns Promise<void>

upsertContexts

Parameters

Returns Promise<void>

Settings

On This Page