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<T extends undefined | string = undefined>(
    prompt: string,
    options?: AiAskOptions<T>,
    jobId?: string,
): Promise<string>
Sends a prompt and receives a full string response.
Type Parameters
- T extends undefined | string = undefined
Parameters
- prompt: string
  The text prompt to send to the agent.
- Optionaloptions: AiAskOptions<T>
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
Returns Promise<string>

askAsync

askAsync<T extends undefined | string = undefined>(
    prompt: string,
    jobId: string,
    options?: AiAskOptions<T>,
): Promise<void>
Sends a prompt and not wait for the result - the result can be tracked using the job ID (squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId)). @param prompt The text prompt to send to the agent. @param jobId A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId)or squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
Type Parameters
- T extends undefined | string = undefined
Parameters
- prompt: string
- jobId: string
- Optionaloptions: AiAskOptions<T>
  Optional parameters for the AI ask request.
Returns Promise<void>

askWithVoiceResponse

askWithVoiceResponse<T extends undefined | string>(
    prompt: string,
    options?: AiAskOptionsWithVoice<T>,
    jobId?: string,
): Promise<AskWithVoiceResponse>
Sends a prompt and gets both text and voice response from the agent.
Type Parameters
- T extends undefined | string
Parameters
- prompt: string
  The text prompt to send to the agent.
- Optionaloptions: AiAskOptionsWithVoice<T>
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
Returns Promise<AskWithVoiceResponse>

chat

chat<T extends undefined | string>(
    prompt: string,
    options?: AiChatOptionsWithoutVoice<T>,
    jobId?: string,
): Observable<string>
Sends a prompt to the agent and receives streamed text responses.
Type Parameters
- T extends undefined | string
Parameters
- prompt: string
  The text prompt to send to the agent.
- Optionaloptions: AiChatOptionsWithoutVoice<T>
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
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<T extends undefined | string>(
    fileToTranscribe: File,
    options?: AiAskOptions<T>,
    jobId?: string,
): Promise<AiTranscribeAndAskResponse>
Transcribes audio and sends it to the agent for response.
Type Parameters
- T extends undefined | string
Parameters
- fileToTranscribe: File
  The audio file to transcribe and send to the agent.
- Optionaloptions: AiAskOptions<T>
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
Returns Promise<AiTranscribeAndAskResponse>

transcribeAndAskWithVoiceResponse

transcribeAndAskWithVoiceResponse<T extends undefined | string>(
    fileToTranscribe: File,
    options?: AiAskOptionsWithVoice<T>,
    jobId?: string,
): Promise<TranscribeAndAskWithVoiceResponse>
Transcribes audio and gets both text and voice response from the agent.
Type Parameters
- T extends undefined | string
Parameters
- fileToTranscribe: File
  The audio file to transcribe and send to the agent.
- Optionaloptions: AiAskOptionsWithVoice<T>
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
Returns Promise<TranscribeAndAskWithVoiceResponse>

transcribeAndChat

transcribeAndChat(
    fileToTranscribe: File,
    options?: AiChatOptionsWithoutVoice,
    jobId?: string,
): Promise<TranscribeAndChatResponse>
Transcribes the given file and performs a chat interaction.
Parameters
- fileToTranscribe: File
  The audio file to transcribe and send to the agent.
- Optionaloptions: AiChatOptionsWithoutVoice
  Optional parameters for the AI ask request.
- OptionaljobId: string
  (Optional) A unique identifier for this request. Use it with squid.jobs().awaitJob(jobId) or squid.jobs().getJob(jobId) to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
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: string): Promise<void>
Changes the AI model used by the agent.
Parameters
- model: string
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

Type Parameters

Parameters

Returns Promise<string>

askAsync

Type Parameters

Parameters

Returns Promise<void>

askWithVoiceResponse

Type Parameters

Parameters

Returns Promise<AskWithVoiceResponse>

chat

Type Parameters

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

Type Parameters

Parameters

Returns Promise<AiTranscribeAndAskResponse>

transcribeAndAskWithVoiceResponse

Type Parameters

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>