@squidcloud/client 1.0.287 → 1.0.288

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

@@ -1,7 +1,12 @@
 import { OpenAiResponseFormat } from './ai-chatbot.public-types';
+import { FunctionName } from './bundle-data.public-types';
 export type AssistantToolType = 'code_interpreter' | 'file_search';
 /** The options for the AI assistant. */
 export interface QueryAssistantOptions {
+    /** Extra context passed to all AI functions. */
+    agentContext?: Record<string, unknown>;
+    /** Extra context per AI function.*/
+    functionContexts?: Record<FunctionName, Record<string, unknown>>;
     /** The format of the response from the AI model. Defaults to 'text' */
     responseFormat?: OpenAiResponseFormat;
 }

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

@@ -1,4 +1,4 @@
-import { FunctionName } from './bundle-data.public-types';
+import { FunctionName, FunctionNameWithContext } from './bundle-data.public-types';
 import { IntegrationId } from './communication.public-types';
 /** The supported OpenAI models */
 export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "gpt-4-turbo-preview", "gpt-4o", "gpt-4o-mini", "gpt-4o-2024-08-06", "o1-preview", "o1-mini", "gpt-4-turbo"];
@@ -106,33 +106,39 @@ export interface AiFileUrl {
 }
 /** The options for the AI chatbot chat method. */
 export interface AiChatbotChatOptions {
-    /** The maximum number of tokens to use when making the request to the AI model. Default to the max tokens the model can accept */
+    /** The maximum number of tokens to use when making the request to the AI model. Default to the max tokens the model can accept. */
     maxTokens?: number;
-    /** A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation */
+    /** A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation. */
     chatId?: string;
-    /** Whether to disable history for the chat. Default to false */
+    /** Whether to disable history for the chat. Default to false. */
     disableHistory?: boolean;
-    /** Whether to include references from the source context in the response. Default to false */
+    /** Whether to include references from the source context in the response. Default to false. */
     includeReference?: boolean;
-    /** The format of the response from the AI model. Note that not all models support JSON format. Default to  'text' */
+    /** The format of the response from the AI model. Note that not all models support JSON format. Default to  'text'. */
     responseFormat?: OpenAiResponseFormat;
-    /** Whether to response in a "smooth typing" way, beneficial when the chat result is displayed in a UI. Default to true */
+    /** Whether to response in a "smooth typing" way, beneficial when the chat result is displayed in a UI. Default to true. */
     smoothTyping?: boolean;
-    /** The temperature to use when sampling from the model. Default to 0.5 */
+    /** The temperature to use when sampling from the model. Default to 0.5. */
     temperature?: number;
-    /** The top P value to use when sampling from the model. Default to 1 */
+    /** The top P value to use when sampling from the model. Default to 1. */
     topP?: number;
-    /** The model to use for this chat. If not provided, the profile model will be used */
+    /** The model to use for this chat. If not provided, the profile model will be used. */
     overrideModel?: AiChatModelName;
-    /** File URLs (only images supported at the moment) */
+    /** File URLs (only images supported at the moment). */
     fileUrls?: Array<AiFileUrl>;
-    /** Functions to expose to the AI */
-    functions?: Array<FunctionName>;
-    /** A list of instructions to include with the prompt */
+    /** Global context passed to the agent and all AI functions of the agent. */
+    agentContext?: Record<string, unknown>;
+    /**
+     * Functions to expose to the AI.
+     * Either a function name or a name with an extra function context passed only to this function.
+     * The parameter values must be valid serializable JSON values.
+     */
+    functions?: Array<FunctionName | FunctionNameWithContext>;
+    /** A list of instructions to include with the prompt. */
     instructions?: Array<string>;
-    /** A set of filters that will limit the context the AI can access */
+    /** A set of filters that will limit the context the AI can access. */
     contextMetadataFilter?: AiContextMetadataFilter;
-    /** The options to use for the response in voice */
+    /** The options to use for the response in voice. */
     voiceOptions?: AiAudioCreateSpeechOptions;
 }
 export interface AiAskResponse {

package/dist/internal-common/src/public-types/bundle-data.public-types.d.ts

@@ -17,5 +17,10 @@ export interface AiFunctionParam {
 }
 export type TopicName = string;
 export type FunctionName = string;
+/** Function name with the contextual data. The data must be a serializable JSON. */
+export interface FunctionNameWithContext {
+    name: FunctionName;
+    context: Record<string, unknown>;
+}
 export type ServiceName = string;
 export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -71,3 +71,9 @@ export declare enum IntegrationSchemaType {
     'graphql' = "graphql"
 }
 export declare const AI_AGENTS_INTEGRATION_ID: IntegrationId;
+export interface IntegrationInfo {
+    id: IntegrationId;
+    type: IntegrationType;
+    creationDate?: Date;
+    updateDate?: Date;
+}

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

@@ -1,5 +1,6 @@
 import { AiProfileId, AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
 import { Observable } from 'rxjs';
+import { BlobAndFilename } from './types';
 export interface TranscribeAndChatResponse {
     transcribedPrompt: string;
     responseStream: Observable<string>;
@@ -161,7 +162,7 @@ export declare class AiAgentContextReference {
      * @param file - The file to insert.
      * @returns A promise that resolves when the context is successfully created.
      */
-    insert(data: AiChatBotContextData, file?: File): Promise<void>;
+    insert(data: AiChatBotContextData, file?: File | BlobAndFilename): Promise<void>;
     /**
      * Appends data to an existing context entry on the chatbot profile. This will result in an error if an entry has not
      * @param data An object containing options for appending the entry.

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

@@ -37,6 +37,7 @@ export * from './rpc.manager';
 export * from './observability-client';
 export * from './secret.client';
 export * from './scheduler-client';
+export * from './integration-client';
 export * from './socket.manager';
 export * from './squid-http-client';
 export * from './squid';

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

@@ -0,0 +1,6 @@
+import { IntegrationId, IntegrationInfo, IntegrationType } from './public-types';
+export declare class IntegrationClient {
+    private readonly rpcManager;
+    list(type?: IntegrationType): Promise<IntegrationInfo[]>;
+    get(id: IntegrationId): Promise<IntegrationInfo | undefined>;
+}

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

@@ -12,6 +12,7 @@ import { ObservabilityClient } from './observability-client';
 import { ExtractionClient } from './extraction-client';
 import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
+import { IntegrationClient } from './integration-client';
 /** The different options that can be used to initialize a Squid instance. */
 export interface SquidOptions {
     /**
@@ -105,6 +106,8 @@ export declare class Squid {
     private readonly observabilityClient;
     private readonly queueManagerFactory;
     private readonly schedulerClient;
+    private readonly integrationClient;
+    private readonly _appId;
     /**
      * Creates a new instance of Squid with the given options.
      *
@@ -210,6 +213,8 @@ export declare class Squid {
     get secrets(): SecretClient;
     get observability(): ObservabilityClient;
     get schedulers(): SchedulerClient;
+    get integrations(): IntegrationClient;
+    get appId(): AppId;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.
      * The lock will be released when the release method on the returned object is invoked or whenever the connection

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.287";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.288";

package/package.json

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