@squidcloud/client 1.0.391 → 1.0.393

package/dist/internal-common/src/types/ai-agent.types.d.ts

@@ -1,4 +1,4 @@
-import { AgentContextRequest, AiAgent, AiAgentContext, AiAudioCreateSpeechOptions, AiChatOptions, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions, ApplicationAiSettings } from '../public-types/ai-agent.public-types';
+import { AgentContextRequest, AiAgent, AiAgentContext, AiAnnotation, AiAudioCreateSpeechOptions, AiChatOptions, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions, ApplicationAiSettings } from '../public-types/ai-agent.public-types';
 import { AiChatModelName, AiEmbeddingsModelName, AiProviderType } from '../public-types/ai-common.public-types';
 import { AiContextMetadata, AiContextMetadataFilter } from '../public-types/ai-knowledge-base.public-types';
 import { AiAgentId, AiKnowledgeBaseId, AppId, ClientRequestId } from '../public-types/communication.public-types';
@@ -49,15 +49,18 @@ export interface AiContextSizeResponse {
 }
 export interface AiAskResponse {
     responseString: string;
+    annotations?: Record<string, AiAnnotation>;
 }
 export interface AiAskWithVoiceResponse {
     responseString: string;
     voiceResponse: AiAudioCreateSpeechResponse;
+    annotations?: Record<string, AiAnnotation>;
 }
 export interface AiTranscribeAndAskWithVoiceResponse {
     transcribedPrompt: string;
     responseString: string;
     voiceResponse: AiAudioCreateSpeechResponse;
+    annotations?: Record<string, AiAnnotation>;
 }
 export interface AiTranscribeAndChatResponse {
     transcribedPrompt: string;

package/dist/internal-common/src/types/ai-knowledge-base.types.d.ts

@@ -1,4 +1,5 @@
-import { AiKnowledgeBase, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchOptions, AiKnowledgeBaseSearchResultChunk } from '../public-types/ai-knowledge-base.public-types';
+import { AiKnowledgeBase, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, AllAiKnowledgeBaseChatOptions } from '../public-types/ai-knowledge-base.public-types';
+import { AiKnowledgeBaseId, AppId } from '../public-types/communication.public-types';
 /**
  * Request structure for getting an AiKnowledgeBase
  * @category AI
@@ -29,7 +30,7 @@ export interface DeleteAiKnowledgeBaseRequest {
  */
 export interface UpsertAiKnowledgeBaseRequest {
     /** The AiKnowledgeBase to upsert */
-    knowledgeBase: AiKnowledgeBase;
+    knowledgeBase: AiKnowledgeBaseWithOptionalChatModel;
 }
 /**
  * Response structure for listing AiKnowledgeBases
@@ -95,16 +96,6 @@ export interface UpsertAiKnowledgeBaseContextsRequest {
     /** The job ID to use for the async upsert job */
     jobId: string;
 }
-/**
- * Request structure for searching an AiKnowledgeBase
- * @category AI
- */
-export interface AiKnowledgeBaseSearchRequest {
-    /** The id of the AiKnowledgeBase */
-    knowledgeBaseId: string;
-    /** The search options for this search */
-    options: AiKnowledgeBaseSearchOptions;
-}
 /**
  * Response structure for searching an AiKnowledgeBase
  * @category AI
@@ -113,3 +104,27 @@ export interface AiKnowledgeBaseSearchResponse {
     /** Array of result chunks from the search */
     chunks: Array<AiKnowledgeBaseSearchResultChunk>;
 }
+/**
+ * Request structure for getting the size of context
+ * for an AiKnowledgeBase
+ * @category AI
+ */
+export interface AiKnowledgeBaseContextSizeRequest {
+    /** The ID of the App */
+    appId: AppId;
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+}
+/**
+ * Response structure for getting size of context
+ * @category AI
+ */
+export interface AiKnowledgeBaseContextSizeResponse {
+    /** Size of context bytes, as a number */
+    sizeBytes: number;
+}
+export interface AiKnowledgeBaseChatRequest {
+    knowledgeBaseId: AiKnowledgeBaseId;
+    prompt?: string;
+    options?: AllAiKnowledgeBaseChatOptions;
+}

package/dist/internal-common/src/utils/global.utils.d.ts

@@ -1 +1 @@
-export declare function isTimestampEnabled(): boolean;
+export {};

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

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
-import { AgentContextRequest, AiAgent, AiAgentContext, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentContextsResponse, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AgentContextRequest, AiAgent, AiAgentContext, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentContextResponse, UpsertAgentContextsResponse, 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 { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.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.
@@ -64,7 +64,7 @@ export declare class AiAgentReference {
     /**
      * Adds or updates a single agent context.
      */
-    upsertContext(contextRequest: AgentContextRequest, file?: File): Promise<void>;
+    upsertContext(contextRequest: AgentContextRequest, file?: File): Promise<UpsertAgentContextResponse>;
     /**
      * Adds or updates multiple agent contexts.
      */
@@ -112,7 +112,7 @@ export declare class AiAgentReference {
      */
     search(options: AiSearchOptions): Promise<Array<AiSearchResultChunk>>;
     /**
-     * Sends a prompt and receives a full string response.
+     * 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
@@ -120,9 +120,19 @@ export declare class AiAgentReference {
      *   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)`

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

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
+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.
@@ -25,6 +25,16 @@ export interface TranscribeAndAskWithVoiceResponse {
     /** 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.

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

@@ -1,11 +1,11 @@
-import { ExecuteAiApiResponse, ExecuteAiQueryMultiResponse, ExecuteAiQueryOptions, ExecuteAiQueryResponse } from '../../internal-common/src/public-types/ai-query.public-types';
+import { ExecuteAiApiResponse, ExecuteAiQueryOptions, ExecuteAiQueryResponse } from '../../internal-common/src/public-types/ai-query.public-types';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAssistantClient } from './ai-assistant-client';
 import { AiAudioClient } from './ai-audio-client';
 import { AiImageClient } from './ai-image-client';
-import { AiKnowledgeBaseReference } from './ai-knowledge-base.reference';
+import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
-import { AiAgent, AiAgentId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+import { AiAgent, AiAgentId, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, 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
@@ -18,6 +18,7 @@ export declare class AiClient {
     private readonly jobClient;
     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.
@@ -26,11 +27,15 @@ export declare class AiClient {
     /**
      * Returns a reference to the specified AI knowledge base.
      */
-    knowledgeBase(knowledgeBaseId: string): AiKnowledgeBaseReference;
+    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.
@@ -74,17 +79,6 @@ export declare class AiClient {
      * {@link https://docs.squid.cloud/docs/ai}.
      */
     executeAiQuery(integrationId: IntegrationId, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
-    /**
-     * Executes an AI query across multiple database integrations and returns their responses.
-     * Useful when querying multiple sources with the same prompt.
-     *
-     * @param integrationIds The list of integration IDs to query.
-     * @param prompt The prompt to send to the AI.
-     * @param options Optional query execution parameters.
-     * @returns A promise resolving to the responses from all queried integrations.
-     * @deprecated Use `executeAiQuery`.
-     */
-    executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
     /**
      * Request to execute an AI-powered API call.
      * Allows specifying allowed endpoints and whether to provide an explanation.
@@ -105,4 +99,5 @@ export declare class AiClient {
      */
     setAiProviderApiKeySecret(providerType: AiProviderType, secretKey: SecretKey | undefined): Promise<ApplicationAiSettings>;
     private getAiAgentClient;
+    private getAiKnowledgeBaseClient;
 }

package/dist/typescript-client/src/{ai-knowledge-base.reference.d.ts → ai-knowledge-base/ai-knowledge-base-client-reference.d.ts}

@@ -1,4 +1,10 @@
-import { AiKnowledgeBase, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchOptions, AiKnowledgeBaseSearchResultChunk, UpsertKnowledgeBaseContextsResponse } from '../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiKnowledgeBase, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, AllAiKnowledgeBaseChatOptions, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-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 UpsertKnowledgeBaseRequestParams = Omit<AiKnowledgeBase, 'id'>;
 /**
  * A reference to an AI knowledge base.
  */
@@ -20,7 +26,7 @@ export declare class AiKnowledgeBaseReference {
      * Upserts the AI knowledge base.
      * @param knowledgeBase
      */
-    upsertKnowledgeBase(knowledgeBase: AiKnowledgeBase): Promise<void>;
+    upsertKnowledgeBase(knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'id'>): Promise<void>;
     /**
      * Deletes the AI knowledge base.
      * @returns A promise that resolves when the deletion is complete.
@@ -45,7 +51,7 @@ export declare class AiKnowledgeBaseReference {
     /**
      * Adds or updates a single context.
      */
-    upsertContext(contextRequest: AiKnowledgeBaseContextRequest, file?: File): Promise<void>;
+    upsertContext(contextRequest: AiKnowledgeBaseContextRequest, file?: File): Promise<UpsertKnowledgeBaseContextResponse>;
     /**
      * Adds or updates multiple contexts.
      */
@@ -53,5 +59,7 @@ export declare class AiKnowledgeBaseReference {
     /**
      * Performs a semantic search in the knowledge base.
      */
-    search(options: AiKnowledgeBaseSearchOptions): Promise<Array<AiKnowledgeBaseSearchResultChunk>>;
+    search(options: AllAiKnowledgeBaseChatOptions & {
+        prompt: string;
+    }): Promise<Array<AiKnowledgeBaseSearchResultChunk>>;
 }

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

@@ -0,0 +1,28 @@
+import { AiKnowledgeBase } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiKnowledgeBaseId } from '../../../internal-common/src/public-types/communication.public-types';
+import { AiKnowledgeBaseReference } from './ai-knowledge-base-client-reference';
+/**
+ * AiKnowledgeBaseClient manages AI knowledgebase interactions, including
+ * listing knowledgebases.
+ *
+ * @category AI
+ */
+export declare class AiKnowledgeBaseClient {
+    private readonly rpcManager;
+    private readonly jobClient;
+    /**
+     * Retrieves an instance of AiKnowledeBaseReference for a specific kb ID.
+     * This reference provides methods for interacting with the knowledgebase.
+     */
+    knowledgeBase(id: AiKnowledgeBaseId): AiKnowledgeBaseReference;
+    /**
+     * Lists all knowledgebases available in the system.
+     * @returns A promise that resolves to an array of AiKnowledgeBase instances.
+     */
+    listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
+    /**
+     * Deletes the AI knowledge base.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    delete(id: AiKnowledgeBaseId): Promise<void>;
+}

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

@@ -6,7 +6,8 @@ export * from './ai-assistant-client';
 export * from './ai-audio-client';
 export * from './ai-client';
 export * from './ai-image-client';
-export * from './ai-knowledge-base.reference';
+export * from './ai-knowledge-base/ai-knowledge-base-client';
+export * from './ai-knowledge-base/ai-knowledge-base-client-reference';
 export * from './ai-matchmaking-client';
 export * from './api-client';
 export * from './auth.manager';

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.391";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.393";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.391",
+  "version": "1.0.393",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -41,7 +41,7 @@
   "license": "ISC",
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "ws": "^8.17.1"
+    "ws": "^8.18.3"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.8",
@@ -51,8 +51,8 @@
     "rxjs": ">=7.5.7 <8.0.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.0",
-    "typedoc-plugin-markdown": "^4.5.2",
+    "typedoc": "^0.28.10",
+    "typedoc-plugin-markdown": "^4.8.1",
     "@supercharge/promise-pool": "^3.2.0",
     "@webpack-cli/generators": "^3.0.7",
     "copy-webpack-plugin": "^12.0.2",
@@ -61,7 +61,7 @@
     "otrie": "^1.2.1",
     "tsconfig-paths-webpack-plugin": "^4.1.0",
     "tscpaths": "^0.0.9",
-    "webpack": "^5.96.0",
+    "webpack": "^5.101.3",
     "webpack-cli": "^5.1.4"
   },
   "browser": {