@squidcloud/client 1.0.338 → 1.0.340

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

@@ -1,84 +1,205 @@
 import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
 import { IntegrationType } from './integration.public-types';
-import { FunctionName, FunctionNameWithContext } from './bundle-data.public-types';
-/** The supported OpenAI models */
+import { FunctionName, FunctionNameWithContext } from './backend.public-types';
+/**
+ * The supported OpenAI models.
+ * @category AI
+ */
 export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini", "o3-mini"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3-mini"];
+/**
+ * @category AI
+ */
 export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-2.0-flash"];
+/**
+ * @category AI
+ */
 export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-latest", "claude-3-5-sonnet-latest"];
-/** The supported AI model names. */
+/**
+ * The supported AI model names.
+ * @category AI
+ */
 export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
+/**
+ * @category AI
+ */
 export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
-/** The supported AI image generation model names. */
+/**
+ * The supported AI image generation model names.
+ * @category AI
+ */
 export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["dall-e-3"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+/**
+ * @category AI
+ */
 export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "tts-1", "tts-1-hd"];
+/**
+ * @category AI
+ */
 export declare const STABLE_DIFFUSION_MODEL_NAMES: readonly ["stable-diffusion-core"];
+/**
+ * @category AI
+ */
 export declare const FLUX_MODEL_NAMES: readonly ["flux-pro-1.1"];
+/**
+ * @category AI
+ */
 export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core", "flux-pro-1.1"];
+/**
+ * @category AI
+ */
 export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+/**
+ * @category AI
+ */
 export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+/**
+ * @category AI
+ */
 export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
+/**
+ * @category AI
+ */
 export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiChatModelName = (typeof OPENAI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiReasoningChatModelName = (typeof OPENAI_REASONING_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type GeminiChatModelName = (typeof GEMINI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AnthropicChatModelName = (typeof ANTHROPIC_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiImageModelName = (typeof AI_IMAGE_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiAudioTranscriptionModelName = (typeof AI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiAudioModelName = (typeof OPENAI_AUDIO_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiImageModelName = (typeof OPENAI_IMAGE_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiAudioTranscriptionModelName = (typeof OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type OpenAiCreateSpeechFormat = (typeof OPEN_AI_CREATE_SPEECH_FORMATS)[number];
+/**
+ * @category AI
+ */
 export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
 export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
+/**
+ * @category AI
+ */
 export type AiAudioTranscribeOptions = WhisperOptions;
+/**
+ * @category AI
+ */
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
-export declare const VECTOR_DB_TYPES: readonly ["postgres"];
-export type VectorDbType = (typeof VECTOR_DB_TYPES)[number];
-export interface AiAudioCreateSpeechResponse {
-    mimeType: string;
-    extension: string;
-    base64File: string;
-}
-export interface AiAudioCreateSpeechRequest {
-    input: string;
-    options: AiAudioCreateSpeechOptions;
-}
+/**
+ * @category AI
+ */
 export interface BaseAiGenerateImageOptions {
     modelName: AiImageModelName;
 }
+/**
+ * @category AI
+ */
 export interface BaseAiAudioTranscribeOptions {
     modelName: AiAudioTranscriptionModelName;
 }
+/**
+ * @category AI
+ */
 export interface BaseAiAudioCreateSpeechOptions {
     modelName: AiAudioCreateSpeechModelName;
 }
+/**
+ * @category AI
+ */
 export interface DallEOptions extends BaseAiGenerateImageOptions {
     modelName: 'dall-e-3';
     quality?: 'hd' | 'standard';
     size?: '1024x1024' | '1792x1024' | '1024x1792';
     numberOfImagesToGenerate?: 1;
 }
+/**
+ * @category AI
+ */
 export interface WhisperOptions extends BaseAiAudioTranscribeOptions {
     modelName: 'whisper-1';
     responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
     temperature?: number;
     prompt?: string;
 }
+/**
+ * @category AI
+ */
 export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOptions {
     modelName: OpenAiAudioCreateSpeechModelName;
     voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
     responseFormat?: OpenAiCreateSpeechFormat;
     speed?: number;
 }
+/**
+ * @category AI
+ */
 export interface FluxOptions extends BaseAiGenerateImageOptions {
     modelName: 'flux-pro-1.1';
     /**  Must be a multiple of 32. Min 256, max 1440 - default to 1024 */
@@ -92,6 +213,9 @@ export interface FluxOptions extends BaseAiGenerateImageOptions {
     /** 1 is most strict and 5 is most permissive */
     safety_tolerance?: number;
 }
+/**
+ * @category AI
+ */
 export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
     modelName: 'stable-diffusion-core';
     aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '4:5' | '5:4' | '9:16' | '9:21';
@@ -100,14 +224,29 @@ export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
     stylePreset?: 'analog-film' | 'anime' | 'cinematic' | 'comic-book' | 'digital-art' | 'enhance' | 'fantasy-art' | 'isometric' | 'line-art' | 'low-poly' | 'modeling-compound' | 'neon-punk' | 'origami' | 'photographic' | 'pixel-art' | 'tile-texture';
     outputFormat?: 'jpeg' | 'png' | 'webp';
 }
-/** The possible sources for the LLM provider API key. */
+/**
+ * The possible sources for the LLM provider API key.
+ * @category AI
+ */
 export type ApiKeySource = 'user' | 'system';
+/**
+ * @category AI
+ */
 export type AiAgentResponseFormat = 'text' | 'json_object';
+/**
+ * @category AI
+ */
 export type AiFileUrlType = 'image';
+/**
+ * @category AI
+ */
 export interface AiFileUrl {
     type: AiFileUrlType;
     url: string;
 }
+/**
+ * @category AI
+ */
 export interface AiConnectedIntegrationMetadata {
     integrationId: IntegrationId;
     /** Type of the connected integration. */
@@ -118,7 +257,15 @@ export interface AiConnectedIntegrationMetadata {
      * If not provided the default one is used.
      */
     description?: string;
+    /**
+     * Instructions for the connected integration agent.
+     * If not provided the default one is used.
+     */
+    instructions?: string;
 }
+/**
+ * @category AI
+ */
 export interface AiConnectedAgentMetadata {
     agentId: AiAgentId;
     /**
@@ -127,7 +274,10 @@ export interface AiConnectedAgentMetadata {
      */
     description: string;
 }
-/** Quotas for a single AI chat prompt (`ask()` method call). */
+/**
+ * Quotas for a single AI chat prompt (`ask()` method call).
+ * @category AI
+ */
 export interface AiChatPromptQuotas {
     /**
      * Maximum depth of AI call recursion allowed.
@@ -138,7 +288,11 @@ export interface AiChatPromptQuotas {
      */
     maxAiCallStackSize: number;
 }
-interface BaseAiAgentChatOptions {
+/**
+ * The base AI agent chat options, should not be used directly.
+ * @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. */
     maxTokens?: number;
     /** A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation. */
@@ -182,34 +336,66 @@ interface BaseAiAgentChatOptions {
     includeMetadata?: boolean;
     /** The temperature to use when sampling from the model. Default to 0.5. */
     temperature?: number;
+    /** Preset instruction options that can be toggled on */
+    guardrails?: GuardrailsOptions;
     model?: AiChatModelName;
 }
+/**
+ * Each model-specific options interface now “anchors” the overrideModel property.
+ * @category AI
+ */
 export interface GeminiChatOptions extends BaseAiAgentChatOptions {
     model?: GeminiChatModelName;
     groundingWithWebSearch?: boolean;
 }
+/**
+ * @category AI
+ */
 export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
     model?: OpenAiChatModelName;
     fileUrls?: Array<AiFileUrl>;
 }
+/**
+ * @category AI
+ */
 export type OpenAiReasoningEffort = 'low' | 'medium' | 'high';
+/**
+ * @category AI
+ */
 export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
     model?: OpenAiReasoningChatModelName;
     reasoningEffort?: OpenAiReasoningEffort;
 }
+/**
+ * @category AI
+ */
 export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
     model?: AnthropicChatModelName;
 }
+/**
+ * @category AI
+ */
 export type AiSessionOptions = Partial<{
     traceId: string;
     clientId: string;
     agentId: string;
 }>;
+/**
+ * The generic options type. When no generic is provided,
+ * the type is inferred from the provided overrideModel (or falls back to BaseAiAgentChatOptions).
+ * @category AI
+ */
 export type AiAgentChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiAgentChatOptions | GeminiChatOptions | OpenAiReasoningChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiReasoningChatModelName ? OpenAiReasoningChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : never;
+/**
+ * @category AI
+ */
 export type AllAiAgentChatOptions = {
     [K in keyof BaseAiAgentChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiAgentChatOptions ? BaseAiAgentChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
 };
-/** A definition of an AI agent. */
+/**
+ * A definition of an AI agent.
+ * @category AI
+ */
 export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     id: AiAgentId;
     createdAt: Date;
@@ -220,39 +406,32 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     /** The default options of the agent - can be overridden by the user when using the agent. */
     options: AiAgentChatOptions<T>;
 }
+/**
+ * @category AI
+ */
 export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
     options?: AiAgentChatOptions;
 };
+/**
+ * @category AI
+ */
 export interface AiObserveStatusOptions {
     /** A unique chat ID for the conversation. */
     chatId?: string;
 }
+/**
+ * @category AI
+ */
 export interface AiStatusMessage {
     agentId: string;
     chatId?: string;
     title: string;
     tags?: Record<string, any>;
 }
-export interface AiAskResponse {
-    responseString: string;
-}
-export interface AiTranscribeAndAskResponse {
-    responseString: string;
-    transcribedPrompt: string;
-}
-export interface AiAskWithVoiceResponse {
-    responseString: string;
-    voiceResponse: AiAudioCreateSpeechResponse;
-}
-export interface AiTranscribeAndAskWithVoiceResponse {
-    transcribedPrompt: string;
-    responseString: string;
-    voiceResponse: AiAudioCreateSpeechResponse;
-}
-export interface AiTranscribeAndChatResponse {
-    transcribedPrompt: string;
-}
-/** The options for the AI agent search method. */
+/**
+ * The options for the AI agent search method.
+ * @category AI
+ */
 export interface AiSearchOptions {
     /** The prompt to search for */
     prompt: string;
@@ -261,26 +440,17 @@ export interface AiSearchOptions {
     /** The maximum number of results to return */
     limit?: number;
 }
-export interface AiSearchRequest {
-    options: AiSearchOptions;
-    agentId: AiAgentId;
-}
-export interface AiSearchResponse {
-    chunks: Array<AiSearchResultChunk>;
-}
+/**
+ * @category AI
+ */
 export interface AiSearchResultChunk {
     data: string;
     metadata?: AiContextMetadata;
     score: number;
 }
 /**
- * Provides context to the security rules of an AI Agent for each new user prompt.
- * Refer to the `@secureAiAgent` annotation for more details.
+ * @category AI
  */
-export declare class SecureAiAgentContext {
-    readonly prompt?: string;
-    readonly agentId: AiAgentId;
-}
 export interface AiAgentContext {
     id: AiContextId;
     createdAt: Date;
@@ -293,18 +463,30 @@ export interface AiAgentContext {
     sizeBytes: number;
     metadata: AiContextMetadata;
 }
+/**
+ * @category AI
+ */
 export type AgentContextRequest = TextContextRequest | FileContextRequest;
-export interface BaseContextRequest {
+interface BaseContextRequest {
     contextId: string;
     type: AiContextType;
     metadata?: AiContextMetadata;
 }
+/**
+ * @category AI
+ */
 export type AiContextType = 'text' | 'file';
+/**
+ * @category AI
+ */
 export interface TextContextRequest extends BaseContextRequest {
     type: 'text';
     title: string;
     text: string;
 }
+/**
+ * @category AI
+ */
 export interface FileContextRequest extends BaseContextRequest {
     type: 'file';
     extractImages?: boolean;
@@ -314,45 +496,88 @@ export interface FileContextRequest extends BaseContextRequest {
     extractionModel?: AiChatModelName;
     password?: string;
 }
+/**
+ * @category AI
+ */
 export type AiContextMetadataValue = number | string | boolean | undefined;
+/**
+ * @category AI
+ */
 export type AiContextMetadataValueArray = AiContextMetadataValue[];
-export interface AiContextMetadataEqFilter {
+interface AiContextMetadataEqFilter {
     $eq: AiContextMetadataValue;
 }
-export interface AiContextMetadataNeFilter {
+interface AiContextMetadataNeFilter {
     $ne: AiContextMetadataValue;
 }
-export interface AiContextMetadataGtFilter {
+interface AiContextMetadataGtFilter {
     $gt: number;
 }
-export interface AiContextMetadataGteFilter {
+interface AiContextMetadataGteFilter {
     $gte: number;
 }
-export interface AiContextMetadataLtFilter {
+interface AiContextMetadataLtFilter {
     $lt: number;
 }
-export interface AiContextMetadataLteFilter {
+interface AiContextMetadataLteFilter {
     $lte: number;
 }
-export interface AiContextMetadataInFilter {
+interface AiContextMetadataInFilter {
     $in: AiContextMetadataValueArray;
 }
-export interface AiContextMetadataNinFilter {
+interface AiContextMetadataNinFilter {
     $nin: AiContextMetadataValueArray;
 }
-export interface AiContextMetadataExistsFilter {
+interface AiContextMetadataExistsFilter {
     $exists: boolean;
 }
+/**
+ * @category AI
+ */
 export type AiContextMetadataSimpleFilter = AiContextMetadataEqFilter | AiContextMetadataNeFilter | AiContextMetadataGtFilter | AiContextMetadataGteFilter | AiContextMetadataLtFilter | AiContextMetadataLteFilter | AiContextMetadataInFilter | AiContextMetadataNinFilter | AiContextMetadataExistsFilter;
+/**
+ * @category AI
+ */
 export interface AiContextMetadataFieldFilter {
     [field: string]: AiContextMetadataSimpleFilter | AiContextMetadataValue;
 }
+/**
+ * @category AI
+ */
 export interface AiContextMetadataAndFilter {
     $and: AiContextMetadataFilter[];
 }
+/**
+ * @category AI
+ */
 export interface AiContextMetadataOrFilter {
     $or: AiContextMetadataFilter[];
 }
+/**
+ * @category AI
+ */
 export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
+/**
+ * @category AI
+ */
 export type AiContextMetadata = Record<string, AiContextMetadataValue>;
+/**
+ * @category AI
+ */
+export type GuardrailKeysType = 'disableProfanity' | 'offTopicAnswers' | 'professionalTone' | 'disablePii';
+/**
+ * @category AI
+ */
+export type GuardrailsOptions = {
+    [k in GuardrailKeysType]?: boolean;
+} & {
+    custom?: string;
+};
+/**
+ * @category AI
+ */
+export interface AiTranscribeAndAskResponse {
+    responseString: string;
+    transcribedPrompt: string;
+}
 export {};

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

@@ -1,7 +1,14 @@
 import { OpenAiChatModelName, OpenAiReasoningEffort, AiAgentResponseFormat } from './ai-agent.public-types';
-import { FunctionName } from './bundle-data.public-types';
+import { FunctionName } from './backend.public-types';
+/**
+ * The type of assistant tool.
+ * @category AI
+ */
 export type AssistantToolType = 'code_interpreter' | 'file_search';
-/** The options for the AI assistant. */
+/**
+ * The options for the AI assistant.
+ * @category AI
+ */
 export interface QueryAssistantOptions {
     /** Extra context passed to all AI functions. */
     agentContext?: Record<string, unknown>;

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

@@ -2,6 +2,7 @@ import { AiContextMetadata, AiContextMetadataFilter } from './ai-agent.public-ty
 /**
  * Represents a category in the matchmaker.
  * The description is used by the AI to extract features from the content.
+ * @category AI
  */
 export interface MmCategory {
     id: string;
@@ -10,6 +11,7 @@ export interface MmCategory {
 /**
  * Represents a matchmaker entity for a given category.
  * The metadata is used to filter the entities when finding matches.
+ * @category AI
  */
 export interface MmEntity {
     id: string;
@@ -22,6 +24,7 @@ export interface MmEntity {
  * The description is used to describe the matchmaker and by the AI to better understand the domain.
  * The categories represent the types of entities that can be matched (it is possible to match items in the same
  * category).
+ * @category AI
  */
 export interface MmMatchMaker {
     id: string;
@@ -34,6 +37,7 @@ export interface MmMatchMaker {
 }
 /**
  * Represents a matchmaker entity match. A high score indicates a good match.
+ * @category AI
  */
 export interface MmEntityMatch extends MmEntity {
     /** The score of the match between 0 and 100 - 100 represents best match. */
@@ -42,6 +46,7 @@ export interface MmEntityMatch extends MmEntity {
 }
 /**
  * Represents options for finding matches.
+ * @category AI
  */
 export interface MmFindMatchesOptions {
     /** Metadata filter conditions - defaults to none */
@@ -56,6 +61,7 @@ export interface MmFindMatchesOptions {
 }
 /**
  * Represents options for listing entities.
+ * @category AI
  */
 export interface MmListEntitiesOptions {
     /** Metadata filter conditions - defaults to none */

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

@@ -0,0 +1,13 @@
+/** Backend related public types that should be available on the client SDK */
+/**
+ * @category Queue
+ */
+export type TopicName = string;
+export type ServiceName = 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 ServiceFunctionName = `${ServiceName}:${FunctionName}`;

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

@@ -10,5 +10,12 @@ export type SquidDocId = string;
 export type ClientRequestId = string;
 /** ID of AI agent. Also known as AI profile id. */
 export type AiAgentId = string;
+/**
+ * The built-in agent id. Cannot be customized.
+ * @category AI
+ */
 export declare const BUILT_IN_AGENT_ID = "built_in_agent";
+/**
+ * @category AI
+ */
 export type AiContextId = string;