@squidcloud/client 1.0.145 → 1.0.146-beta

package/dist/typescript-client/src/admin-client.d.ts

@@ -0,0 +1,23 @@
+import { IntegrationClient } from './integration-client';
+import { SecretClient } from './secret.client';
+/**
+ * AdminClient provides access to application administrative operations,
+ * including integrations and secrets management.
+ * @category Platform
+ */
+export declare class AdminClient {
+    private readonly rpcManager;
+    private readonly region;
+    private readonly appId;
+    private readonly consoleRegion;
+    private readonly integrationClient;
+    private readonly secretClient;
+    /**
+     * Returns the IntegrationClient for managing integrations.
+     */
+    integrations(): IntegrationClient;
+    /**
+     * Returns the SecretClient for managing secrets.
+     */
+    secrets(): SecretClient;
+}

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -0,0 +1,181 @@
+import { Observable } from 'rxjs';
+import { AiAgent, AiChatMessage, AiChatModelSelection, AiConnectedAgentMetadata, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
+import { JobId } from '../../../internal-common/src/public-types/job.public-types';
+import { Paths } from '../../../internal-common/src/public-types/typescript.public-types';
+import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskResponse, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
+/**
+ * Parameters for creating or updating an AI agent.
+ * Excludes the `id` field, as it is derived from the agent instance.
+ * @category AI
+ */
+export type UpsertAgentRequestParams = Omit<UpsertAgentRequest, 'id'>;
+/**
+ * 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.
+ * @category AI
+ */
+export declare class AiAgentReference {
+    private readonly agentId;
+    private readonly agentApiKey;
+    private readonly ongoingChatSequences;
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly jobClient;
+    private readonly backendFunctionManager;
+    /**
+     * Retrieves metadata and configuration of the AI agent.
+     */
+    get(): Promise<AiAgent | undefined>;
+    /**
+     * Creates or updates the AI agent with the provided parameters.
+     */
+    upsert(agent: UpsertAgentRequestParams): Promise<void>;
+    /**
+     * Deletes the AI agent.
+     */
+    delete(): Promise<void>;
+    /**
+     * Updates the agent's instruction prompt.
+     */
+    updateInstructions(instructions: string): Promise<void>;
+    /**
+     * Changes the AI model used by the agent.
+     */
+    updateModel(model: AiChatModelSelection): Promise<void>;
+    /**
+     * Updates the list of agents connected to this agent.
+     */
+    updateConnectedAgents(connectedAgents: Array<AiConnectedAgentMetadata>): Promise<void>;
+    /**
+     * Updates the agent's guardrails with the provided options.
+     */
+    updateGuardrails(guardrails: GuardrailsOptions): Promise<void>;
+    /**
+     * Updates the agent's custom guardrails with the provided custom guardrail.
+     */
+    updateCustomGuardrails(customGuardrail: string): Promise<void>;
+    /**
+     * Deletes the custom guardrails for the agent.
+     */
+    deleteCustomGuardrail(): Promise<void>;
+    /**
+     * Regenerates the api key for the agent.
+     * Will throw an error if the agent does not exist.
+     *
+     * @returns the new api key
+     */
+    regenerateApiKey(): Promise<string>;
+    /**
+     * Fetches the default api key for the agent
+     * @returns the api key if one exists
+     */
+    getApiKey(): Promise<string | undefined>;
+    /**
+     * Sends a prompt to the agent and receives streamed text responses.
+     * @param prompt The text prompt to send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    chat<T extends AiChatModelName | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
+    /**
+     * Transcribes the given file and performs a chat interaction.
+     * @param fileToTranscribe The audio file to transcribe and send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    transcribeAndChat(fileToTranscribe: File, options?: AiChatOptionsWithoutVoice, jobId?: JobId): Promise<TranscribeAndChatResponse>;
+    /**
+     * Sends a prompt and returns a full string response.
+     * @param prompt The text prompt to send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
+    /**
+     * Sends a prompt and returns the string response and file annotations.
+     * @param prompt The text prompt to send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    askWithAnnotations<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
+    /**
+     * 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)).
+     * The result is of type AiAskResponse which contains the response string and optional annotations.
+     * @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.
+     * @param options Optional parameters for the AI ask request.
+     */
+    askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
+    /**
+     * Observes live status messages from the agent.
+     */
+    observeStatusUpdates(): Observable<AiStatusMessage>;
+    /**
+     * Returns a list of all chat history messages with the given 'memoryId'.
+     * Includes both user and & AI messages.
+     */
+    getChatHistory(memoryId: string): Promise<Array<AiChatMessage>>;
+    /**
+     * Transcribes audio and sends it to the agent for response.
+     * @param fileToTranscribe The audio file to transcribe and send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    transcribeAndAsk<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
+    /**
+     * Transcribes audio and gets both text and voice response from the agent.
+     * @param fileToTranscribe The audio file to transcribe and send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    transcribeAndAskWithVoiceResponse<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
+    /**
+     * Sends a prompt and gets both text and voice response from the agent.
+     * @param prompt The text prompt to send to the agent.
+     * @param options Optional parameters for the AI ask request.
+     * @param jobId (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.
+     */
+    askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
+    /**
+     * Sets a value at a specific path within the agent's options.
+     */
+    setAgentOptionInPath(path: Paths<AllAiAgentChatOptions> | string, value: unknown): Promise<void>;
+    /**
+     * Submits a feedback string for the agent. Requires an API Key.
+     * This feedback may update the agent's instructions, connected integrations, and may be forwarded to connected agents.
+     * @param feedback The feedback to provide for the agent.
+     */
+    provideFeedback(feedback: string): Promise<string>;
+    /**
+     * Helper to replace ${id:fileId} tags in the AI output with their corresponding Markdown.
+     * @param aiResponse
+     * @param annotations
+     * @private
+     */
+    private replaceFileTags;
+    private askInternal;
+    private chatInternal;
+    /**
+     * Calls rpcManager post but with the agent api key if one was given during construction
+     */
+    private post;
+}

package/dist/typescript-client/src/agent/ai-agent-client.d.ts

@@ -0,0 +1,37 @@
+import { AiAgent, AiAgentId } from '../public-types';
+import { AiAgentReference } from './ai-agent-client-reference';
+/**
+ * Allows the user to provide custom options to the agent client
+ *
+ * @category AI
+ */
+export type AiAgentClientOptions = {
+    /**
+     * Allows providing an agent API key that can be used instead of the app API key
+     */
+    apiKey?: string;
+};
+/**
+ * AiAgentClient manages AI agent interactions, including listing agents,
+ * handling real-time chat responses, and processing AI status updates
+ * through WebSocket notifications.
+ * @category AI
+ */
+export declare class AiAgentClient {
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly jobClient;
+    private readonly backendFunctionManager;
+    private readonly ongoingChatSequences;
+    /**
+     * Retrieves an instance of AiAgentReference for a specific agent ID.
+     * This reference provides methods for interacting with the agent.
+     */
+    agent(id: AiAgentId, options?: AiAgentClientOptions | undefined): AiAgentReference;
+    /**
+     * Lists all agents available in the system.
+     * @returns A promise that resolves to an array of AiAgent instances.
+     */
+    listAgents(): Promise<Array<AiAgent>>;
+    private handleChatResponse;
+}

package/dist/typescript-client/src/agent/ai-agent-client.types.d.ts

@@ -0,0 +1,69 @@
+import { Observable } from 'rxjs';
+import { AiAnnotation, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
+/**
+ * Response format for transcribing audio and generating a chat response.
+ * Contains the transcribed text and a stream of AI-generated responses.
+ * @category AI
+ */
+export interface TranscribeAndChatResponse {
+    /** Transcribed text from the audio input. */
+    transcribedPrompt: string;
+    /** Stream of AI-generated responses. */
+    responseStream: Observable<string>;
+}
+/**
+ * Response format for transcribing audio and generating a text and voice response.
+ * Includes the transcribed prompt, the AI-generated response as text, and an audio file.
+ * @category AI
+ */
+export interface TranscribeAndAskWithVoiceResponse {
+    /** Transcribed text from the audio input. */
+    transcribedPrompt: string;
+    /** AI-generated response as a string. */
+    responseString: string;
+    /** AI-generated voice response as an audio file. */
+    voiceResponseFile: File;
+}
+/**
+ * Response from an AI agent when asked a question or given a task.
+ * @category AI
+ */
+export interface AskResponse {
+    /** The main text response from the AI agent. */
+    responseString: string;
+    /** Optional annotations that provide additional context or metadata about the response. */
+    annotations?: Record<string, AiAnnotation>;
+}
+/**
+ * Response format for AI-generated voice responses.
+ * Contains the AI-generated text response and the corresponding audio file.
+ * @category AI
+ */
+export interface AskWithVoiceResponse {
+    /** AI-generated response as a string. */
+    responseString: string;
+    /** AI-generated voice response as an audio file. */
+    voiceResponseFile: File;
+}
+/**
+ * Chat options that exclude voice-specific configurations.
+ * @category AI
+ */
+export type AiChatOptionsWithoutVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
+    model?: T;
+};
+/**
+ * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
+ * @category AI
+ */
+export type AiAskOptions<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
+    model?: T;
+};
+/**
+ * Options for AI-generated responses that include voice-specific settings but excludes smooth typing.
+ * @category AI
+ */
+export type AiAskOptionsWithVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
+    model?: T;
+};

package/dist/typescript-client/src/ai-assistant-client.d.ts

@@ -1,73 +1,72 @@
-import { RpcManager } from './rpc.manager';
-import { AssistantToolType, FunctionName } from '@squidcloud/common';
-import { BlobAndFilename } from './types';
-/**
- * Client class for interacting with an AI Assistant server.
- * Provides functionalities like creating and deleting assistants and threads,
- * querying assistants, and managing files associated with assistants and threads.
- */
-export declare class AiAssistantClient {
-    private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
-    /**
-     * Creates a new AI assistant with specified characteristics.
-     * @param name - The name of the assistant.
-     * @param instructions - Instructions for the assistant.
-     * @param functions - Array of function names annotated with "@aiFunction" in your Squid backend that will be
-     *   available tol the assistant.
-     * @param toolTypes - Optional array of tool types. If you want to use files for retrieval, you must add them using
-     *   the addFileToAssistant method.
-     * @returns A promise that resolves to the created assistant's ID.
-     */
-    createAssistant(name: string, instructions: string, functions: Array<FunctionName>, toolTypes?: Array<AssistantToolType>): Promise<string>;
-    /**
-     * Deletes an AI assistant.
-     * @param assistantId - The ID of the assistant to be deleted.
-     * @returns A promise that resolves when the assistant is deleted.
-     */
-    deleteAssistant(assistantId: string): Promise<void>;
-    /**
-     * Creates a new thread for an AI assistant. A thread is a long-lived conversation with the assistant that you can
-     * always send questions to.
-     * @param assistantId - The ID of the assistant for which the thread is created.
-     * @returns A promise that resolves to the created thread's ID.
-     */
-    createThread(assistantId: string): Promise<string>;
-    /**
-     * Deletes a thread of an AI assistant.
-     * @param threadId - The ID of the thread to be deleted.
-     * @returns A promise that resolves when the thread is deleted.
-     */
-    deleteThread(threadId: string): Promise<void>;
-    /**
-     * Queries an AI assistant within a specific thread.
-     * @param assistantId - The ID of the assistant.
-     * @param threadId - The ID of the thread.
-     * @param prompt - The query prompt.
-     * @param fileIds - Optional array of file IDs to include in the query. These file IDs need to be added using the
-     *   addFileToThread method.
-     * @returns A promise that resolves to the assistant's response.
-     */
-    queryAssistant(assistantId: string, threadId: string, prompt: string, fileIds?: string[]): Promise<string>;
-    /**
-     * Adds a file to an AI assistant that can be available for retrieval or code analyzer.
-     * @param assistantId - The ID of the assistant.
-     * @param file - The file or blob and filename to be added.
-     * @returns A promise that resolves to the ID of the added file.
-     */
-    addFileToAssistant(assistantId: string, file: File | BlobAndFilename): Promise<string>;
-    /**
-     * Removes a file from an AI assistant.
-     * @param assistantId - The ID of the assistant.
-     * @param fileId - The ID of the file to be removed.
-     * @returns A promise that resolves when the file is removed.
-     */
-    removeFileFromAssistant(assistantId: string, fileId: string): Promise<void>;
-    /**
-     * Adds a file to a specific thread of an AI assistant. These files can be used when asking a question in the thread.
-     * @param threadId - The ID of the thread.
-     * @param file - The file or blob and filename to be added.
-     * @returns A promise that resolves to the ID of the added file.
-     */
-    addFileToThread(threadId: string, file: File | BlobAndFilename): Promise<string>;
-}
+import { AssistantToolType, QueryAssistantOptions } from './public-types';
+/**
+ * Client class for interacting with an AI Assistant server.
+ * Provides functionalities like creating and deleting assistants and threads,
+ * querying assistants, and managing files associated with assistants and threads.
+ * @category AI
+ */
+export declare class AiAssistantClient {
+    private readonly rpcManager;
+    /**
+     * Creates a new AI assistant with specified characteristics.
+     * @param name - The name of the assistant.
+     * @param instructions - Instructions for the assistant.
+     * @param functions - Array of function names annotated with "@aiFunction" in your Squid backend that will be
+     *   available to the assistant.
+     * @param toolTypes - Optional array of tool types. If you want to use files for retrieval, you must add them using
+     *   the addFileToAssistant method.
+     * @returns A promise that resolves to the created assistant's ID.
+     */
+    createAssistant(name: string, instructions: string, functions: Array<string>, toolTypes?: Array<AssistantToolType>): Promise<string>;
+    /**
+     * Deletes an AI assistant.
+     * @param assistantId - The ID of the assistant to be deleted.
+     * @returns A promise that resolves when the assistant is deleted.
+     */
+    deleteAssistant(assistantId: string): Promise<void>;
+    /**
+     * Creates a new thread for an AI assistant. A thread is a long-lived conversation with the assistant that you can
+     * always send questions to.
+     * @param assistantId - The ID of the assistant for which the thread is created.
+     * @returns A promise that resolves to the created thread's ID.
+     */
+    createThread(assistantId: string): Promise<string>;
+    /**
+     * Deletes a thread of an AI assistant.
+     * @param threadId - The ID of the thread to be deleted.
+     * @returns A promise that resolves when the thread is deleted.
+     */
+    deleteThread(threadId: string): Promise<void>;
+    /**
+     * Queries an AI assistant within a specific thread.
+     * @param assistantId - The ID of the assistant.
+     * @param threadId - The ID of the thread.
+     * @param prompt - The query prompt.
+     * @param fileIds - Optional array of file IDs to include in the query. These file IDs need to be added using the
+     *   addFileToThread method.
+     * @param options - Optional query options.
+     * @returns A promise that resolves to the assistant's response.
+     */
+    queryAssistant(assistantId: string, threadId: string, prompt: string, fileIds?: string[], options?: QueryAssistantOptions): Promise<string>;
+    /**
+     * Adds a file to an AI assistant that can be available for retrieval or code analyzer.
+     * @param assistantId - The ID of the assistant.
+     * @param file - The file to be added.
+     * @returns A promise that resolves to the ID of the added file.
+     */
+    addFileToAssistant(assistantId: string, file: File): Promise<string>;
+    /**
+     * Removes a file from an AI assistant.
+     * @param assistantId - The ID of the assistant.
+     * @param fileId - The ID of the file to be removed.
+     * @returns A promise that resolves when the file is removed.
+     */
+    removeFileFromAssistant(assistantId: string, fileId: string): Promise<void>;
+    /**
+     * Adds a file to a specific thread of an AI assistant. These files can be used when asking a question in the thread.
+     * @param threadId - The ID of the thread.
+     * @param file - The file to be added.
+     * @returns A promise that resolves to the ID of the added file.
+     */
+    addFileToThread(threadId: string, file: File): Promise<string>;
+}

package/dist/typescript-client/src/ai-audio-client.d.ts

@@ -0,0 +1,25 @@
+import { AiAudioCreateSpeechOptions, AiAudioTranscribeOptions } from './public-types';
+/**
+ * AiAudioClient provides methods for AI-driven audio processing,
+ * including speech transcription and text-to-speech synthesis.
+ * @category AI
+ */
+export declare class AiAudioClient {
+    private readonly rpcManager;
+    /**
+     * Transcribes the spoken content of an audio file into text.
+     *
+     * @param file - The audio file to transcribe.
+     * @param options - Options specifying the transcription model and behavior.
+     * @returns A Promise that resolves to the transcribed text.
+     */
+    transcribe(file: File, options?: AiAudioTranscribeOptions): Promise<string>;
+    /**
+     * Converts a text input into a spoken audio file using AI-generated speech.
+     *
+     * @param input - The text to convert to speech.
+     * @param options - Options for customizing speech synthesis (e.g., voice, speed).
+     * @returns A Promise that resolves to an audio File containing the synthesized speech.
+     */
+    createSpeech(input: string, options: AiAudioCreateSpeechOptions): Promise<File>;
+}

package/dist/typescript-client/src/ai-client.d.ts

@@ -0,0 +1,129 @@
+import { AiQueryOptions, AiQueryResponse, ExecuteAiApiResponse } from '../../internal-common/src/public-types/ai-query.public-types';
+import { AiAgentClientOptions } from './agent/ai-agent-client';
+import { AiAgentReference } from './agent/ai-agent-client-reference';
+import { AiAssistantClient } from './ai-assistant-client';
+import { AiAudioClient } from './ai-audio-client';
+import { AiFilesClient } from './ai-files-client';
+import { AiImageClient } from './ai-image-client';
+import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
+import { AiMatchMakingClient } from './ai-matchmaking-client';
+import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+/**
+ * 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.
+ * @category AI
+ */
+export declare class AiClient {
+    private readonly socketManager;
+    private readonly rpcManager;
+    private readonly jobClient;
+    private readonly backendFunctionManager;
+    private readonly aiAssistantClient;
+    private aiAgentClient?;
+    private aiKnowledgeBaseClient?;
+    /**
+     * Returns a reference to the specified AI agent.
+     * If no ID is provided, the built-in agent is used by default.
+     */
+    agent(agentId?: AiAgentId, options?: AiAgentClientOptions | undefined): AiAgentReference;
+    /**
+     * Returns a reference to the specified AI knowledge base.
+     */
+    knowledgeBase(knowledgeBaseId: AiKnowledgeBaseId): AiKnowledgeBaseReference;
+    /**
+     * Lists all available AI agents.
+     */
+    listAgents(): Promise<Array<AiAgent>>;
+    /**
+     * Lists all available AI agents.
+     */
+    listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
+    /**
+     * Retrieves the AI assistant client.
+     * @returns An instance of AiAssistantClient.
+     */
+    assistant(): AiAssistantClient;
+    /**
+     * Retrieves an AI image client.
+     */
+    image(): AiImageClient;
+    /**
+     * Retrieves an AI audio client.
+     */
+    audio(): AiAudioClient;
+    /**
+     * Retrieves an AI match-making client.
+     * @deprecated - Use `knowledgebase('kbId').searchContextsWith*()` instead.
+     */
+    matchMaking(): AiMatchMakingClient;
+    /**
+     * Creates a client to manage files for a specific AI provider.
+     *
+     * @param provider - The AI provider (openai, gemini, or anthropic).
+     * @returns An AiFilesClient bound to the specified provider.
+     * @example
+     * ```typescript
+     * const openaiFiles = squid.ai().files('openai');
+     * const fileId = await openaiFiles.uploadFile({ file });
+     * await openaiFiles.deleteFile(fileId);
+     * ```
+     */
+    files(provider: AiFileProviderType): AiFilesClient;
+    /**
+     * 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.
+     *
+     * @param integrationId The identifier for the DB integration which is used to direct the query to the
+     *                      appropriate DB.
+     * @param prompt        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.
+     * @param options       Additional options to customize the query execution.
+     * @returns             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
+     * {@link https://docs.squid.cloud/docs/ai}.
+     */
+    executeAiQuery(integrationId: IntegrationId, prompt: string, options?: AiQueryOptions): Promise<AiQueryResponse>;
+    /**
+     * 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.
+     *
+     * @param integrationId - The API integration to use
+     * @param prompt - Natural language description of what to accomplish
+     * @param options - Optional configuration including allowed endpoints and verbose updates
+     * @param sessionContext - Optional session context for audit trails and tracing
+     * @returns Promise resolving to the API call result with answer and execution details
+     */
+    executeAiApiCall(integrationId: IntegrationId, prompt: string, options?: AiAgentApiIntegrationOptions, sessionContext?: AiSessionContext): Promise<ExecuteAiApiResponse>;
+    /**
+     * 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.
+     */
+    getApplicationAiSettings(): Promise<ApplicationAiSettings>;
+    /** Sets new application AI settings. Overwrites the existing value. */
+    setApplicationAiSettings(settings: ApplicationAiSettings): Promise<void>;
+    /**
+     * 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.
+     */
+    setAiProviderApiKeySecret(providerType: AiProviderType, secretKey: SecretKey | undefined): Promise<ApplicationAiSettings>;
+    private getAiAgentClient;
+    private getAiKnowledgeBaseClient;
+}

package/dist/typescript-client/src/ai-files-client.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Options for uploading a file to an AI provider.
+ * @category AI
+ */
+export interface UploadAiFileOptions {
+    /** The file to upload. */
+    file: File;
+    /** Optional expiration time in seconds for automatic cleanup. */
+    expirationInSeconds?: number;
+}
+/**
+ * AiFilesClient provides methods for managing files with a specific AI provider.
+ * The provider is bound when the client is created via `squid.ai().files(provider)`.
+ * @category AI
+ */
+export declare class AiFilesClient {
+    private readonly provider;
+    private readonly rpcManager;
+    /**
+     * Uploads a file to the AI provider for use with AI features like code interpreter.
+     *
+     * @param options - Options for uploading the file.
+     * @returns A Promise that resolves to the file ID assigned by the provider.
+     */
+    uploadFile(options: UploadAiFileOptions): Promise<string>;
+    /**
+     * Deletes a file from the AI provider's storage.
+     *
+     * @param fileId - The ID of the file to delete.
+     * @returns A Promise that resolves to true if the file was deleted, false if it didn't exist.
+     */
+    deleteFile(fileId: string): Promise<boolean>;
+}