@squidcloud/client 1.0.351 → 1.0.353

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

@@ -0,0 +1,14 @@
+/**
+ * Configuration options for AI agent database integration.
+ */
+export interface AiAgentDatabaseIntegrationOptions {
+    /**
+     * A list of collection (or table) name filters that the AI agent can query data from.
+     *
+     * Currently, the following filters are supported:
+     *  - Exact match: Only collection names that exactly match the filter can be used for AI queries. This is case-sensitive.
+     *
+     * When this list is not provided (i.e., it is `undefined`) or is empty, the AI agent has access to all collections.
+     */
+    collectionsToUse?: string[];
+}

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

@@ -13,7 +13,7 @@ export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini
 /**
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3", "o3-mini", "o4-mini"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini"];
 /**
  * @category AI
  */
@@ -26,7 +26,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-lat
  * The supported AI model names.
  * @category AI
  */
-export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "claude-3-7-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
+export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "claude-3-7-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
 /**
  * @category AI
  */
@@ -164,6 +164,22 @@ export type AiAudioTranscribeOptions = OpenAiAudioTranscribeOptions;
  * @category AI
  */
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
+/**
+ * @category AI
+ */
+export declare const RAG_TYPES: readonly ["contextual", "basic"];
+/**
+ * @category AI
+ */
+export type AiRagType = (typeof RAG_TYPES)[number];
+/**
+ * @category AI
+ */
+export declare const RERANK_PROVIDERS: readonly ["cohere", "none"];
+/**
+ * @category AI
+ */
+export type AiRerankProvider = (typeof RERANK_PROVIDERS)[number];
 /**
  * Base options for generating images with an AI model.
  * @category AI
@@ -309,7 +325,7 @@ export interface AiFileUrl {
  * Metadata for an AI agent connected to an integration.
  * @category AI
  */
-export interface AiConnectedIntegrationMetadata {
+export interface AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsType = unknown> {
     /** The ID of the connected integration. */
     integrationId: IntegrationId;
     /** The type of the connected integration (e.g., API, database). */
@@ -318,6 +334,11 @@ export interface AiConnectedIntegrationMetadata {
     description?: string;
     /** Optional instructions for the connected integration agent, overriding the default if provided. */
     instructions?: string;
+    /**
+     * Additional options for the connected integration.
+     * Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.
+     */
+    options?: AiConnectedIntegrationOptionsType;
 }
 /**
  * Metadata for a connected AI agent callable by the current agent.
@@ -348,7 +369,7 @@ export interface AiChatPromptQuotas {
  * @category AI
  */
 export interface BaseAiAgentChatOptions {
-    /** 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. Defaults 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. */
     chatId?: string;
@@ -395,6 +416,8 @@ export interface BaseAiAgentChatOptions {
     guardrails?: GuardrailsOptions;
     /** The LLM model to use. */
     model?: AiChatModelName;
+    /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
+    rerankProvider?: AiRerankProvider;
 }
 /**
  * Chat options specific to Gemini models, extending base options.
@@ -526,6 +549,8 @@ export interface AiSearchOptions {
     contextMetadataFilter?: AiContextMetadataFilter;
     /** The maximum number of results to return */
     limit?: number;
+    /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
+    rerankProvider?: AiRerankProvider;
 }
 /**
  * A single chunk of data returned from an AI search operation.
@@ -574,6 +599,18 @@ interface BaseContextRequest {
     type: AiContextType;
     metadata?: AiContextMetadata;
 }
+/**
+ * Base options for upserting text content into the AI agent's context.
+ * @category AI
+ */
+export interface AiContextTextOptions extends BaseAiContextOptions {
+}
+/**
+ * Base options for upserting file content into the AI agent's context.
+ * @category AI
+ */
+export interface AiContextFileOptions extends BaseAiContextOptions {
+}
 /**
  * @category AI
  */
@@ -589,6 +626,8 @@ export interface TextContextRequest extends BaseContextRequest {
     title: string;
     /** The text content to add to the context. */
     text: string;
+    /** General options for how to process the text. */
+    options?: AiContextTextOptions;
 }
 /**
  * Request structure for adding file-based context to an AI agent.
@@ -603,6 +642,8 @@ export interface FileContextRequest extends BaseContextRequest {
     imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
     extractionModel?: AiChatModelName;
+    /** General options for how to process the file. */
+    options?: AiContextFileOptions;
 }
 /**
  * @category AI
@@ -671,6 +712,16 @@ export interface AiContextMetadataOrFilter {
  * @category AI
  */
 export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
+/**
+ * Base options for how to deal with the content being upserted.
+ * @category AI
+ */
+export type BaseAiContextOptions = {
+    /** The type of RAG to use for the content. */
+    ragType?: AiRagType;
+    /** Amount of chunk overlap, in characters. */
+    chunkOverlap?: number;
+};
 /**
  * A record of metadata key-value pairs for AI context, where values are primitive types or undefined.
  * @category AI

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

@@ -1,5 +1,5 @@
-import { OpenAiChatModelName, OpenAiReasoningEffort, AiAgentResponseFormat } from './ai-agent.public-types';
-import { FunctionName } from './backend.public-types';
+import { AiAgentResponseFormat, OpenAiChatModelName, OpenAiReasoningEffort } from './ai-agent.public-types';
+import { AiFunctionId } from './backend.public-types';
 /**
  * The type of assistant tool.
  * @category AI
@@ -12,8 +12,8 @@ export type AssistantToolType = 'code_interpreter' | 'file_search';
 export interface QueryAssistantOptions {
     /** Additional context provided to all AI functions for processing. */
     agentContext?: Record<string, unknown>;
-    /** Specific context provided per AI function, keyed by function name. */
-    functionContexts?: Record<FunctionName, Record<string, unknown>>;
+    /** Specific context provided per AI function, keyed by function ID. */
+    functionContexts?: Record<AiFunctionId, Record<string, unknown>>;
     /** The desired format of the AI model's response; defaults to 'text'. */
     responseFormat?: AiAgentResponseFormat;
     /** The OpenAI chat model to use for the assistant, if specified. */

package/dist/internal-common/src/public-types/{integrations/api.public-types.d.ts → api.public-types.d.ts}

@@ -1,4 +1,4 @@
-import { FieldName } from '../document.public-types';
+import { FieldName } from './document.public-types';
 /** Represents the HTTP methods supported by an API endpoint. */
 export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
 /** An identifier string used to uniquely represent an API endpoint. */

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

@@ -14,10 +14,15 @@ export type FunctionName = string;
  * Function name with contextual data, where the data must be serializable as JSON.
  */
 export interface AiFunctionIdWithContext {
-    /** The ID of the AI function as described in @aiFunction decorator. */
+    /**
+     * The ID of the AI function as described in @aiFunction decorator.
+     * Historically named as 'name' because AI function name is the default value for 'ID'.
+     */
     name: AiFunctionId;
     /** A record of contextual data associated with the function call. */
     context: Record<string, unknown>;
+    /** A list of predefined parameter values for the AI function. These parameters are hidden from the AI. */
+    predefinedParameters?: Record<string, unknown>;
 }
 /**
  * A combined service and function name in the format 'ServiceName:FunctionName'.

package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts

@@ -1,4 +1,4 @@
-import { ApiEndpointId, HttpMethod } from '../public-types/integrations/api.public-types';
+import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
 import { IntegrationId } from '../public-types/communication.public-types';
 import { ApiOptions } from '../public-types/api-client.public-types';
 /** The headers of an API call. */

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

@@ -2,7 +2,6 @@ import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiAud
 import { AiAgentId, AppId, ClientRequestId } from '../public-types/communication.public-types';
 type ModelDataType = {
     maxTokens: number;
-    defaultTokens: number;
 };
 export declare const AiModelData: Record<AiChatModelName, ModelDataType>;
 export interface AiChatRequest {

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

@@ -1,4 +1,4 @@
-import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.types';
+import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.public-types';
 export interface MmCreateMatchMakerRequest {
     matchMaker: MmMatchMaker;
 }

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

@@ -1,4 +1,4 @@
-import { HttpStatusCode } from '../public-types/http-status.enum';
+import { HttpStatusCode } from '../public-types/http-status.public-types';
 export declare class ValidationError extends Error {
     readonly statusCode: HttpStatusCode;
     readonly details?: any;

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

@@ -1,4 +1,4 @@
-import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.types';
+import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.public-types';
 /**
  * Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them.
  * The service will then find matches for the entities.

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

@@ -1,5 +1,5 @@
 import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
-import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/integrations/api.public-types';
+import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/api.public-types';
 import { HttpResponse } from './squid-http-client';
 import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
 /**

package/dist/typescript-client/src/execute-function-options.d.ts

@@ -0,0 +1,73 @@
+/** Advanced options for a Squid `executeFunction` call. */
+export interface ExecuteFunctionOptions<ResultType> {
+    /** The name of the `@executable` function to invoke. */
+    functionName: string;
+    /** Optional caching configuration. Reuses results based on argument values. */
+    caching?: ExecuteFunctionCachingOptions<ResultType>;
+    /**
+     * Deduplication config for sharing results of concurrent calls with the same args.
+     * When set to true a default mode with 'compareArgsByReference' is used.
+     */
+    deduplication?: ConcurrentCallDeduplicationOptions | boolean;
+}
+/** Defines caching behavior for `executeFunction`. */
+export interface ExecuteFunctionCachingOptions<T> {
+    /** The caching implementation to use. */
+    cache: ExecuteFunctionCache<T>;
+}
+/** Interface for a function result cache. */
+export interface ExecuteFunctionCache<ValueType> {
+    /** Retrieves a cached value for the given arguments. */
+    get(args: Array<unknown>): ExecuteFunctionCacheLookupResult<ValueType>;
+    /** Caches a result for the given arguments. */
+    set(args: Array<unknown>, value: ValueType): void;
+}
+/** Result object returned from a cache lookup. */
+export type ExecuteFunctionCacheLookupResult<ValueType> = {
+    /** The cached value. */
+    value: ValueType;
+    /** Indicates that the value was found in the cache. */
+    found: true;
+} | {
+    /** Indicates that the value was not found in the cache. */
+    found: false;
+};
+/** Comparator function type for evaluating argument equality. */
+export type ExecuteFunctionArgsComparator = (args1: Array<unknown>, args2: Array<unknown>) => boolean;
+/** Comparator that checks reference equality of arguments. */
+export declare const compareArgsByReference: ExecuteFunctionArgsComparator;
+/** Comparator that checks argument equality using serialization. */
+export declare const compareArgsBySerializedValue: ExecuteFunctionArgsComparator;
+/** A single cached result of a function call. */
+export interface ExecuteFunctionCachedResult<T> {
+    /** Arguments used for the function call. */
+    args: Array<unknown>;
+    /** The result value returned by the function. */
+    result: T;
+    /** Time (in ms) when the result was cached. */
+    cacheTimeMillis: number;
+}
+/** Options for `LastUsedValueExecuteFunctionCache`. */
+interface LastUsedValueExecuteFunctionCacheOptions {
+    /** Argument equality comparator. */
+    argsComparator: ExecuteFunctionArgsComparator;
+    /** Validity duration in milliseconds. */
+    valueExpirationMillis: number;
+}
+/** Lightweight cache storing only the last computed result. */
+export declare class LastUsedValueExecuteFunctionCache<T> implements ExecuteFunctionCache<T> {
+    private readonly options;
+    protected cachedEntry?: ExecuteFunctionCachedResult<T>;
+    /** Creates a new instance of `LastUsedValueExecuteFunctionCache`. */
+    constructor(options: Partial<LastUsedValueExecuteFunctionCacheOptions>);
+    /** @inheritdoc */
+    get(args: Array<unknown>): ExecuteFunctionCacheLookupResult<T>;
+    /** @inheritdoc */
+    set(args: Array<unknown>, value: T): void;
+}
+/** Configuration for deduplicating concurrent function calls. */
+export interface ConcurrentCallDeduplicationOptions {
+    /** Comparator to determine if concurrent calls are equivalent. */
+    argsComparator: ExecuteFunctionArgsComparator;
+}
+export {};

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

@@ -17,6 +17,7 @@ export * from './document-identity.service';
 export * from './document-reference.factory';
 export * from './document-reference';
 export * from './document-store';
+export * from './execute-function-options';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './public-types';

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

@@ -21,6 +21,13 @@ export declare class IntegrationClient {
      * @returns A promise that resolves with the integration info, or `undefined` if not found.
      */
     get<ConfigurationType = Record<string, any>>(integrationId: IntegrationId): Promise<IntegrationInfo<ConfigurationType> | undefined>;
+    /**
+     * Retrieves the integration's schema by its ID.
+     *
+     * @param integrationId - The ID of the integration to retrieve.
+     * @returns A promise that resolves with the integration schema, or `undefined` if not found.
+     */
+    getIntegrationSchema<ConfigurationType = Record<string, any>>(integrationId: IntegrationId): Promise<IntegrationInfo<ConfigurationType> | undefined>;
     /**
      * Deletes the integration with the given ID.
      *

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

@@ -1,3 +1,4 @@
+export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
 export * from '../../internal-common/src/public-types/ai-assistant.public-types';
 export * from '../../internal-common/src/public-types/ai-agent.public-types';
 export * from '../../internal-common/src/public-types/api-client.public-types';
@@ -5,9 +6,9 @@ export * from '../../internal-common/src/public-types/code-executor.public-types
 export * from '../../internal-common/src/public-types/communication.public-types';
 export * from '../../internal-common/src/public-types/context.public-types';
 export * from '../../internal-common/src/public-types/document.public-types';
-export * from '../../internal-common/src/public-types/http-status.enum';
+export * from '../../internal-common/src/public-types/http-status.public-types';
 export * from '../../internal-common/src/public-types/integration.public-types';
-export * from '../../internal-common/src/public-types/integrations/api.public-types';
+export * from '../../internal-common/src/public-types/api.public-types';
 export * from '../../internal-common/src/public-types/metric.public-types';
 export * from '../../internal-common/src/public-types/openapi.public-types';
 export * from '../../internal-common/src/public-types/query.public-types';
@@ -19,6 +20,6 @@ export * from '../../internal-common/src/public-types/scheduler.public-types';
 export * from '../../internal-common/src/public-types/socket.public-types';
 export * from '../../internal-common/src/public-types/typescript.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
-export * from '../../internal-common/src/public-types/ai-matchmaking.types';
+export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
 export * from '../../internal-common/src/public-types/backend.public-types';
 export * from '../../internal-common/src/public-types/web.public-types';

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

@@ -13,6 +13,7 @@ import { SchedulerClient } from './scheduler-client';
 import { AdminClient } from './admin-client';
 import { AiClient } from './ai-client';
 import { WebClient } from './web-client';
+import { ExecuteFunctionOptions } from './execute-function-options';
 /**
  * The different options that can be used to initialize a Squid instance.
  * @category Platform
@@ -185,12 +186,13 @@ export declare class Squid {
      * on the backend.
      * - Arrays of files can also be passed directly as parameters.
      *
-     * @param functionName - The name of the backend function to execute.
+     * @param functionNameOrOptions - The name of the backend function to execute or detailed options which include
+     *   additional advanced options along with the function name.
      * @param params - A list of parameters to pass to the backend function.
      * @returns A promise that resolves to the result of the backend function.
      * @typeParam T - The expected type of the result returned by the backend function.
      */
-    executeFunction<T = any>(functionName: string, ...params: Array<any | File>): Promise<T>;
+    executeFunction<T = any>(functionNameOrOptions: string | ExecuteFunctionOptions<T>, ...params: Array<any | File>): Promise<T>;
     /**
      * Executes a native relational query with the given parameters and returns a promise with the result.
      * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries.

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.351";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.353";

package/package.json

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