@squidcloud/client 1.0.148 → 1.0.150

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

@@ -1,73 +1,73 @@
-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 { 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>;
+}

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

@@ -1,174 +1,174 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiModelName, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiChatbotClient {
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly integrationId;
-    private readonly ongoingChatSequences;
-    constructor(rpcManager: RpcManager, socketManager: SocketManager, integrationId: IntegrationId);
-    /**
-     * Retrieves a profile reference for the provided id. A profile reference
-     * can be used to create and update profiles, add instructions and context
-     * and start chats.
-     *
-     * @param id - The id of the profile.
-     * @returns The profile reference.
-     */
-    profile(id: string): AiChatbotProfileReference;
-    /**
-     * Sends a prompt to the specified profile id.
-     *
-     * @param profileId - The profile id.
-     * @param prompt - The prompt.
-     * @param options - The options to send to the chat model.
-     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
-     * that has been received so far.
-     */
-    chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
-    private handleChatResponse;
-}
-export declare class AiChatbotProfileReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string);
-    /**
-     * Sends a prompt to the current profile.
-     *
-     * @param prompt - The prompt.
-     * @param options - The chat options.
-     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
-     * that has been received so far.
-     */
-    chat(prompt: string, options?: AiChatbotChatOptions): Observable<string>;
-    /**
-     * Retrieves a context reference for the current profile. A context reference can be used to add a new context entry
-     * to the profile, or update/delete an existing entry context.
-     *
-     * @param id - The id of the context entry. If no id is passed, an id will be
-     * generated and the reference will point to a new context entry.
-     * @returns The context reference.
-     */
-    context(id?: string): AiChatbotContextReference;
-    /**
-     * Retrieves an instruction reference for the current profile. An instruction reference can be used to add a new
-     * instruction entry to the profile, or update/delete an existing instruction entry.
-     *
-     * @param id - The id of the instruction entry. If no id is passed, an id will be
-     * generated and the reference will point to a new instruction entry.
-     * @returns The instruction reference.
-     */
-    instruction(id?: string): AiChatbotInstructionReference;
-    /**
-     * Adds a new profile to the chat bot. This will result in an error if a profile already exists with the same id.
-     *
-     * @param data An object containing options for creating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
-     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
-     * @returns A promise that resolves when the profile is successfully created.
-     */
-    insert(data: {
-        modelName: AiModelName;
-        isPublic: boolean;
-    }): Promise<void>;
-    /**
-     * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
-     * current profile id.
-     *
-     * @param data An object containing options for updating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
-     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
-     * @returns A promise that resolves when the profile is successfully updated.
-     */
-    update(data: {
-        modelName?: AiModelName;
-        isPublic?: boolean;
-    }): Promise<void>;
-    /**
-     * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
-     * current profile id.
-     *
-     * @returns A promise that resolves when the profile is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-declare class AiChatbotContextReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new context entry to the chatbot profile. This will result in an error if an entry already exists with
-     * the same id.
-     *
-     * @param data An object containing options for creating the entry.
-     * @param data.title - The title of the entry.
-     * @param data.context - The context data.
-     * @param file - The file to insert.
-     * @returns A promise that resolves when the context is successfully created.
-     */
-    insert(data: {
-        title: string;
-        context: AiChatbotContext;
-    }, file?: File): Promise<void>;
-    /**
-     * Updates an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
-     * been created for the current context id.
-     *
-     * @param data An object containing options for updated the entry.
-     * @param data.title - The title of the entry.
-     * @param data.context - The context data.
-     * @returns A promise that resolves when the context is successfully updated.
-     */
-    update(data: {
-        title?: string;
-        context?: AiChatbotContext;
-    }): Promise<void>;
-    /**
-     * Deletes an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
-     * been created for the current context id.
-     *
-     * @returns A promise that resolves when the context is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-declare class AiChatbotInstructionReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new instruction entry to the chatbot profile. This will result in an error if an entry already exists with
-     * the same id.
-     *
-     * @param data An object containing options for creating the entry.
-     * @param data.instruction - The instruction data.
-     * @returns A promise that resolves when the instruction is successfully created.
-     */
-    insert(data: {
-        instruction: string;
-    }): 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.
-     *
-     * @param data An object containing options for updated the entry.
-     * @param data.instruction - The instruction data.
-     * @returns A promise that resolves when the instruction is successfully updated.
-     */
-    update(data: {
-        instruction: string;
-    }): 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 A promise that resolves when the instruction is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-export {};
+import { AiChatbotChatOptions, AiChatbotContext, AiModelName, IntegrationId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { RpcManager } from './rpc.manager';
+import { SocketManager } from './socket.manager';
+export declare class AiChatbotClient {
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly integrationId;
+    private readonly ongoingChatSequences;
+    constructor(rpcManager: RpcManager, socketManager: SocketManager, integrationId: IntegrationId);
+    /**
+     * Retrieves a profile reference for the provided id. A profile reference
+     * can be used to create and update profiles, add instructions and context
+     * and start chats.
+     *
+     * @param id - The id of the profile.
+     * @returns The profile reference.
+     */
+    profile(id: string): AiChatbotProfileReference;
+    /**
+     * Sends a prompt to the specified profile id.
+     *
+     * @param profileId - The profile id.
+     * @param prompt - The prompt.
+     * @param options - The options to send to the chat model.
+     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
+     * that has been received so far.
+     */
+    chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
+    private handleChatResponse;
+}
+export declare class AiChatbotProfileReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string);
+    /**
+     * Sends a prompt to the current profile.
+     *
+     * @param prompt - The prompt.
+     * @param options - The chat options.
+     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
+     * that has been received so far.
+     */
+    chat(prompt: string, options?: AiChatbotChatOptions): Observable<string>;
+    /**
+     * Retrieves a context reference for the current profile. A context reference can be used to add a new context entry
+     * to the profile, or update/delete an existing entry context.
+     *
+     * @param id - The id of the context entry. If no id is passed, an id will be
+     * generated and the reference will point to a new context entry.
+     * @returns The context reference.
+     */
+    context(id?: string): AiChatbotContextReference;
+    /**
+     * Retrieves an instruction reference for the current profile. An instruction reference can be used to add a new
+     * instruction entry to the profile, or update/delete an existing instruction entry.
+     *
+     * @param id - The id of the instruction entry. If no id is passed, an id will be
+     * generated and the reference will point to a new instruction entry.
+     * @returns The instruction reference.
+     */
+    instruction(id?: string): AiChatbotInstructionReference;
+    /**
+     * Adds a new profile to the chat bot. This will result in an error if a profile already exists with the same id.
+     *
+     * @param data An object containing options for creating the profile.
+     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
+     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
+     * @returns A promise that resolves when the profile is successfully created.
+     */
+    insert(data: {
+        modelName: AiModelName;
+        isPublic: boolean;
+    }): Promise<void>;
+    /**
+     * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
+     * current profile id.
+     *
+     * @param data An object containing options for updating the profile.
+     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
+     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
+     * @returns A promise that resolves when the profile is successfully updated.
+     */
+    update(data: {
+        modelName?: AiModelName;
+        isPublic?: boolean;
+    }): Promise<void>;
+    /**
+     * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
+     * current profile id.
+     *
+     * @returns A promise that resolves when the profile is successfully deleted.
+     */
+    delete(): Promise<void>;
+}
+declare class AiChatbotContextReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    private readonly id;
+    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
+    /**
+     * Adds a new context entry to the chatbot profile. This will result in an error if an entry already exists with
+     * the same id.
+     *
+     * @param data An object containing options for creating the entry.
+     * @param data.title - The title of the entry.
+     * @param data.context - The context data.
+     * @param file - The file to insert.
+     * @returns A promise that resolves when the context is successfully created.
+     */
+    insert(data: {
+        title: string;
+        context: AiChatbotContext;
+    }, file?: File): Promise<void>;
+    /**
+     * Updates an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
+     * been created for the current context id.
+     *
+     * @param data An object containing options for updated the entry.
+     * @param data.title - The title of the entry.
+     * @param data.context - The context data.
+     * @returns A promise that resolves when the context is successfully updated.
+     */
+    update(data: {
+        title?: string;
+        context?: AiChatbotContext;
+    }): Promise<void>;
+    /**
+     * Deletes an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
+     * been created for the current context id.
+     *
+     * @returns A promise that resolves when the context is successfully deleted.
+     */
+    delete(): Promise<void>;
+}
+declare class AiChatbotInstructionReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    private readonly id;
+    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
+    /**
+     * Adds a new instruction entry to the chatbot profile. This will result in an error if an entry already exists with
+     * the same id.
+     *
+     * @param data An object containing options for creating the entry.
+     * @param data.instruction - The instruction data.
+     * @returns A promise that resolves when the instruction is successfully created.
+     */
+    insert(data: {
+        instruction: string;
+    }): 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.
+     *
+     * @param data An object containing options for updated the entry.
+     * @param data.instruction - The instruction data.
+     * @returns A promise that resolves when the instruction is successfully updated.
+     */
+    update(data: {
+        instruction: string;
+    }): 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 A promise that resolves when the instruction is successfully deleted.
+     */
+    delete(): Promise<void>;
+}
+export {};

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

@@ -1,8 +1,8 @@
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiChatbotClientFactory {
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly chatbotsMap;
-    constructor(rpcManager: RpcManager, socketManager: SocketManager);
-}
+import { RpcManager } from './rpc.manager';
+import { SocketManager } from './socket.manager';
+export declare class AiChatbotClientFactory {
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly chatbotsMap;
+    constructor(rpcManager: RpcManager, socketManager: SocketManager);
+}

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

@@ -1,61 +1,61 @@
-import { IntegrationId } from '@squidcloud/common';
-import { AiChatbotClient } from './ai-chatbot-client';
-import { AiChatbotClientFactory } from './ai-chatbot-client.factory';
-import { RpcManager } from './rpc.manager';
-import { AiAssistantClient } from './ai-assistant-client';
-export interface ExecuteAiQueryRequest {
-    integrationId: IntegrationId;
-    prompt: string;
-}
-export interface ExecuteAiQueryResponse {
-    answer: string;
-    explanation?: string;
-    executedQuery?: string;
-}
-/**
- * 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.
- */
-export declare class AiClient {
-    private readonly aiChatbotClientFactory;
-    private readonly rpcManager;
-    private readonly aiAssistantClient;
-    constructor(aiChatbotClientFactory: AiChatbotClientFactory, rpcManager: RpcManager);
-    /**
-     * Retrieves an AI chatbot client for a specific AI integration.
-     * @param aiIntegrationId - The identifier for the AI integration.
-     * @returns An instance of AiChatbotClient associated with the given AI integration ID.
-     */
-    chatbot(aiIntegrationId: IntegrationId): AiChatbotClient;
-    /**
-     * Retrieves the AI assistant client.
-     * @returns An instance of AiAssistantClient.
-     */
-    assistant(): AiAssistantClient;
-    /**
-     * 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.
-     * @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 ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
-     * console.log(response);
-     * ```
-     *
-     * 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): Promise<ExecuteAiQueryResponse>;
-}
+import { IntegrationId } from '@squidcloud/common';
+import { AiChatbotClient } from './ai-chatbot-client';
+import { AiChatbotClientFactory } from './ai-chatbot-client.factory';
+import { RpcManager } from './rpc.manager';
+import { AiAssistantClient } from './ai-assistant-client';
+export interface ExecuteAiQueryRequest {
+    integrationId: IntegrationId;
+    prompt: string;
+}
+export interface ExecuteAiQueryResponse {
+    answer: string;
+    explanation?: string;
+    executedQuery?: string;
+}
+/**
+ * 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.
+ */
+export declare class AiClient {
+    private readonly aiChatbotClientFactory;
+    private readonly rpcManager;
+    private readonly aiAssistantClient;
+    constructor(aiChatbotClientFactory: AiChatbotClientFactory, rpcManager: RpcManager);
+    /**
+     * Retrieves an AI chatbot client for a specific AI integration.
+     * @param aiIntegrationId - The identifier for the AI integration.
+     * @returns An instance of AiChatbotClient associated with the given AI integration ID.
+     */
+    chatbot(aiIntegrationId: IntegrationId): AiChatbotClient;
+    /**
+     * Retrieves the AI assistant client.
+     * @returns An instance of AiAssistantClient.
+     */
+    assistant(): AiAssistantClient;
+    /**
+     * 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.
+     * @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 ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
+     * console.log(response);
+     * ```
+     *
+     * 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): Promise<ExecuteAiQueryResponse>;
+}