@squidcloud/client 1.0.307 → 1.0.309

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

@@ -0,0 +1,69 @@
+import { AiAgentReference, AiChatbotClient } from './ai-agent-client';
+import { AiAssistantClient } from './ai-assistant-client';
+import { IntegrationId } from './public-types';
+import { AiImageClient } from './ai-image-client';
+import { AiAudioClient } from './ai-audio-client';
+import { AiMatchMakingClient } from './ai-matchmaking-client';
+import { ExecuteAiApiResponse, ExecuteAiQueryMultiResponse, ExecuteAiQueryOptions, ExecuteAiQueryResponse } from './ai.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.
+ */
+export declare class AiClient {
+    private readonly aiChatbotClientFactory;
+    private readonly rpcManager;
+    private readonly aiAssistantClient;
+    /**
+     * 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;
+    agent(agentId: string): AiAgentReference;
+    /**
+     * 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.
+     */
+    matchMaking(): AiMatchMakingClient;
+    /**
+     * 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 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, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
+    executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
+    executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
+}

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

@@ -1,9 +1,4 @@
-import { AiAgentReference, AiChatbotClient } from './ai-agent-client';
-import { AiAssistantClient } from './ai-assistant-client';
-import { ApiOptions, IntegrationId } from './public-types';
-import { AiImageClient } from './ai-image-client';
-import { AiAudioClient } from './ai-audio-client';
-import { AiMatchMakingClient } from './ai-matchmaking-client';
+import { AiChatModelName, ApiOptions, IntegrationId } from './public-types';
 export interface ExecuteAiQueryRequest {
     integrationId: IntegrationId;
     prompt: string;
@@ -23,17 +18,22 @@ export interface ExecuteAiApiRequest {
 export interface ExecuteAiQueryOptions {
     instructions?: string;
     collectionsToUse?: Array<string>;
+    enableRawResults?: boolean;
+    enableCodeInterpreter?: boolean;
+    overrideModel?: AiChatModelName;
 }
 export interface ExecuteAiQueryResponse {
     answer: string;
     explanation?: string;
     executedQuery?: string;
     queryMarkdownType?: string;
+    rawResultsUrl?: string;
     success: boolean;
 }
 interface ExecutedQuery {
     query: string;
     markdownType: string;
+    rawResultsUrl?: string;
 }
 export interface ExecuteAiQueryMultiResponse {
     answer: string;
@@ -55,66 +55,4 @@ export interface ExecuteAiApiResponse {
     queryMarkdownType?: string;
     success: boolean;
 }
-/**
- * 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;
-    /**
-     * 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;
-    agent(agentId: string): AiAgentReference;
-    /**
-     * 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.
-     */
-    matchMaking(): AiMatchMakingClient;
-    /**
-     * 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 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, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
-    executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
-    executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
-}
 export {};

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

@@ -50,3 +50,4 @@ export * from './file-utils';
 export * from './ai-matchmaking-client';
 export * from './admin-client';
 export * from './console-utils';
+export * from './ai-client';

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

@@ -1,4 +1,3 @@
-import { AiClient } from './ai.types';
 import { ApiClient } from './api-client';
 import { CollectionReference } from './collection-reference';
 import { ConnectionDetails } from './connection-details';
@@ -12,6 +11,7 @@ import { ExtractionClient } from './extraction-client';
 import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
 import { AdminClient } from './admin-client';
+import { AiClient } from './ai-client';
 /** The different options that can be used to initialize a Squid instance. */
 export interface SquidOptions {
     /**

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.307";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.309";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.307",
+  "version": "1.0.309",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",