Class AiClient

AiClient class serves as a facade for interacting with different AI services. It provides simplified access to AI chatbot and assistant functionalities through its methods.

Index

Methods

agent assistant audio executeAiApiCall executeAiQuery files getApplicationAiSettings image knowledgeBase listAgents listKnowledgeBases matchMaking setAiProviderApiKeySecret setApplicationAiSettings

Methods

agent

agent(
agentId?: string,
options?: AiAgentClientOptions | undefined,
): AiAgentReference
Returns a reference to the specified AI agent. If no ID is provided, the built-in agent is used by default.
Parameters
- agentId: string = BUILT_IN_AGENT_ID
- options: AiAgentClientOptions | undefined = undefined
Returns AiAgentReference

assistant

assistant(): AiAssistantClient
Retrieves the AI assistant client.

Returns AiAssistantClient
An instance of AiAssistantClient.

audio

audio(): AiAudioClient
Retrieves an AI audio client.

Returns AiAudioClient

executeAiApiCall

executeAiApiCall(
    integrationId: string,
    prompt: string,
    options?: AiAgentApiIntegrationOptions,
    sessionContext?: AiSessionContext,
): Promise<ExecuteAiApiResponse>
Executes an AI-powered API call using a specific integration. The AI will select appropriate endpoints, generate request bodies, and analyze responses to answer the provided prompt.
Parameters
- integrationId: string
  The API integration to use
- prompt: string
  Natural language description of what to accomplish
- Optionaloptions: AiAgentApiIntegrationOptions
  Optional configuration including allowed endpoints and verbose updates
- OptionalsessionContext: AiSessionContext
  Optional session context for audit trails and tracing
Returns Promise<ExecuteAiApiResponse>
Promise resolving to the API call result with answer and execution details

executeAiQuery

executeAiQuery(
    integrationId: string,
    prompt: string,
    options?: AiQueryOptions,
): Promise<AiQueryResponse>
Executes an AI query using a specific DB integration, sending a prompt to the AI and returning its response. This function allows for direct interaction with the AI's capabilities by sending text prompts and receiving the AI's responses, which can be used for various applications such as automating tasks, generating content, or obtaining information.
Parameters
- integrationId: string
  The identifier for the DB integration which is used to direct the query to the appropriate DB.
- prompt: string
  The text prompt to send to the AI. This should be formulated in a way that the AI can understand and respond to, taking into account the nature of the task or the information sought.
- Optionaloptions: AiQueryOptions
  Additional options to customize the query execution.
Returns Promise<AiQueryResponse>
A promise that resolves to an ExecuteAiQueryResponse. This response includes the AI's reply to the provided prompt, along with any other relevant information that is part of the AI's response. The promise can be awaited to handle the response asynchronously.
Example
```
const response = await squid.ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
console.log(response);
```
Can be used with an API key or using a security rule with @secureAiQuery() decorator.

For more details on the usage and capabilities of the AI Assistant, refer to the documentation provided at https://docs.squid.cloud/docs/ai.

files

files(provider: AiFileProviderType): AiFilesClient
Creates a client to manage files for a specific AI provider.
Parameters
- provider: AiFileProviderType
  The AI provider (openai, gemini, or anthropic).
Returns AiFilesClient
An AiFilesClient bound to the specified provider.
Example
```
const openaiFiles = squid.ai().files('openai');
const fileId = await openaiFiles.uploadFile({ file });
await openaiFiles.deleteFile(fileId);
```

getApplicationAiSettings

getApplicationAiSettings(): Promise<ApplicationAiSettings>
Returns name of the secret that stores API key for the given AI provider type. This API key is used for all requests to the AI provider done from the application.

Returns Promise<ApplicationAiSettings>

image

image(): AiImageClient
Retrieves an AI image client.

Returns AiImageClient

knowledgeBase

knowledgeBase(knowledgeBaseId: string): AiKnowledgeBaseReference
Returns a reference to the specified AI knowledge base.
Parameters
- knowledgeBaseId: string
Returns AiKnowledgeBaseReference

listAgents

listAgents(): Promise<AiAgent<undefined>[]>
Lists all available AI agents.

Returns Promise<AiAgent<undefined>[]>

listKnowledgeBases

listKnowledgeBases(): Promise<AiKnowledgeBase[]>
Lists all available AI agents.

Returns Promise<AiKnowledgeBase[]>

matchMaking

matchMaking(): AiMatchMakingClient
Retrieves an AI match-making client.

Returns AiMatchMakingClient
Deprecated
- Use knowledgebase('kbId').searchContextsWith*() instead.

setAiProviderApiKeySecret

setAiProviderApiKeySecret(
    providerType:
        | "anthropic"
        | "flux"
        | "gemini"
        | "openai"
        | "grok"
        | "stability"
        | "voyage"
        | "external",
    secretKey: string | undefined,
): Promise<ApplicationAiSettings>
Sets the name of the secret that stores API key for the given AI provider type. This API key is used for all requests to the AI provider done from the application. To delete the existing secret key use 'undefined' for the name of the secret. Returns the updated state of the AI application settings.
Parameters
- providerType:
      | "anthropic"
      | "flux"
      | "gemini"
      | "openai"
      | "grok"
      | "stability"
      | "voyage"
      | "external"
- secretKey: string | undefined
Returns Promise<ApplicationAiSettings>

setApplicationAiSettings

setApplicationAiSettings(settings: ApplicationAiSettings): Promise<void>
Sets new application AI settings. Overwrites the existing value.
Parameters
- settings: ApplicationAiSettings
Returns Promise<void>

Class AiClient

Index

Methods

Methods

agent

Parameters

Returns AiAgentReference

assistant

Returns AiAssistantClient

audio

Returns AiAudioClient

executeAiApiCall

Parameters

Returns Promise<ExecuteAiApiResponse>

executeAiQuery

Parameters

Returns Promise<AiQueryResponse>

Example

files

Parameters

Returns AiFilesClient

Example

getApplicationAiSettings

Returns Promise<ApplicationAiSettings>

image

Returns AiImageClient

knowledgeBase

Parameters

Returns AiKnowledgeBaseReference

listAgents

Returns Promise<AiAgent<undefined>[]>

listKnowledgeBases

Returns Promise<AiKnowledgeBase[]>

matchMaking

Returns AiMatchMakingClient

Deprecated

setAiProviderApiKeySecret

Parameters

Returns Promise<ApplicationAiSettings>

setApplicationAiSettings

Parameters

Returns Promise<void>

Settings

On This Page