@squidcloud/client 1.0.325 → 1.0.327

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

@@ -1,7 +1,9 @@
-import { FunctionName, FunctionNameWithContext } from './bundle-data.public-types';
-import { AiAgentId, IntegrationId } from './communication.public-types';
+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 */
+export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini"];
+export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini", "o3-mini"];
 export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3-mini"];
 export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-2.0-flash"];
 export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-latest", "claude-3-5-sonnet-latest"];
@@ -23,6 +25,7 @@ export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aa
 export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
 export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
 export type OpenAiChatModelName = (typeof OPENAI_CHAT_MODEL_NAMES)[number];
+export type OpenAiReasoningChatModelName = (typeof OPENAI_REASONING_CHAT_MODEL_NAMES)[number];
 export type GeminiChatModelName = (typeof GEMINI_CHAT_MODEL_NAMES)[number];
 export type AnthropicChatModelName = (typeof ANTHROPIC_CHAT_MODEL_NAMES)[number];
 export type AiImageModelName = (typeof AI_IMAGE_MODEL_NAMES)[number];
@@ -38,7 +41,7 @@ export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
 export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
 export type AiAudioTranscribeOptions = WhisperOptions;
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
-export declare const VECTOR_DB_TYPES: readonly ["pinecone", "postgres"];
+export declare const VECTOR_DB_TYPES: readonly ["postgres"];
 export type VectorDbType = (typeof VECTOR_DB_TYPES)[number];
 export interface AiAudioCreateSpeechResponse {
     mimeType: string;
@@ -135,8 +138,7 @@ export interface AiChatPromptQuotas {
      */
     maxAiCallStackSize: number;
 }
-/** The options for the AI chat method. */
-export interface AiAgentChatOptions {
+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. */
@@ -155,16 +157,6 @@ export interface AiAgentChatOptions {
     responseFormat?: OpenAiResponseFormat;
     /** 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. */
-    temperature?: number;
-    /** 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. */
-    overrideModel?: AiChatModelName;
-    /** File URLs (only images supported at the moment). */
-    fileUrls?: Array<AiFileUrl>;
-    /** Constrains effort on reasoning for reasoning models. o1 models only. */
-    reasoningEffort?: 'low' | 'medium' | 'high';
     /** Global context passed to the agent and all AI functions of the agent. */
     agentContext?: Record<string, unknown>;
     /**
@@ -174,8 +166,8 @@ export interface AiAgentChatOptions {
      * Overrides the stored value.
      */
     functions?: Array<FunctionName | FunctionNameWithContext>;
-    /** A list of instructions to include with the prompt. */
-    instructions?: Array<string>;
+    /** Instructions to include with the prompt. */
+    instructions?: string;
     /** A set of filters that will limit the context the AI can access. */
     contextMetadataFilter?: AiContextMetadataFilter;
     /** The options to use for the response in voice. */
@@ -188,10 +180,45 @@ export interface AiAgentChatOptions {
     quotas?: AiChatPromptQuotas;
     /** Include metadata in the context */
     includeMetadata?: boolean;
-    /** Enables grounding with real-time web search to enhance AI responses with up-to-date information.
-     * Currently supported only for gemini-2.0-flash. */
+    /** The temperature to use when sampling from the model. Default to 0.5. */
+    temperature?: number;
+    model?: AiChatModelName;
+}
+export interface GeminiChatOptions extends BaseAiAgentChatOptions {
+    model?: GeminiChatModelName;
     groundingWithWebSearch?: boolean;
 }
+export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
+    model?: OpenAiChatModelName;
+    fileUrls?: Array<AiFileUrl>;
+}
+export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
+    model?: OpenAiReasoningChatModelName;
+    reasoningEffort?: 'low' | 'medium' | 'high';
+}
+export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
+    model?: AnthropicChatModelName;
+}
+export type AiSessionOptions = Partial<{
+    traceId: string;
+    clientId: string;
+    agentId: string;
+}>;
+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;
+/** A definition of an AI agent. */
+export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
+    id: AiAgentId;
+    createdAt: Date;
+    updatedAt: Date;
+    description?: string;
+    isPublic?: boolean;
+    auditLog?: boolean;
+    /** The default options of the agent - can be overridden by the user when using the agent. */
+    options: AiAgentChatOptions<T>;
+}
+export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
+    options?: AiAgentChatOptions;
+};
 export interface AiObserveStatusOptions {
     /** A unique chat ID for the conversation. */
     chatId?: string;
@@ -232,18 +259,10 @@ export interface AiSearchOptions {
 }
 export interface AiSearchRequest {
     options: AiSearchOptions;
-    profileId: string;
-    integrationId: IntegrationId;
+    agentId: AiAgentId;
 }
 export type AiMutationType = 'insert' | 'update' | 'delete' | 'append' | 'feedback';
 export type AiResourceType = 'instruction' | 'profile' | 'context' | 'contexts';
-export type AiContextType = 'text' | 'url' | 'file';
-export interface AiContextBase {
-    type: AiContextType;
-    data: string;
-    metadata?: AiContextMetadata;
-    password?: string;
-}
 export interface AiSearchResponse {
     chunks: Array<AiSearchResultChunk>;
 }
@@ -252,32 +271,47 @@ export interface AiSearchResultChunk {
     metadata?: AiContextMetadata;
     score: number;
 }
-export interface AiTextContext extends AiContextBase {
-    type: 'text';
+/**
+ * Provides context to the security rules of an AI Agent for each new user prompt.
+ * Refer to the `@secureAiAgent` annotation for more details.
+ */
+export declare class SecureAiAgentContext {
+    readonly prompt?: string;
+    readonly agentId: AiAgentId;
 }
-export interface AiUrlContext extends AiContextBase {
-    type: 'url';
-    extractImages?: boolean;
-    minImageWidth?: number;
-    minImageHeight?: number;
+export interface AiAgentContext {
+    id: AiContextId;
+    createdAt: Date;
+    updatedAt: Date;
+    agentId: AiAgentId;
+    type: AiContextType;
+    title: string;
+    text: string;
+    preview: boolean;
+    sizeBytes: number;
+    metadata: AiContextMetadata;
+}
+export type AgentContextRequest = TextContextRequest | FileContextRequest;
+export interface BaseContextRequest {
+    contextId: string;
+    type: AiContextType;
+    metadata?: AiContextMetadata;
+}
+export type AiContextType = 'text' | 'file';
+export interface TextContextRequest extends BaseContextRequest {
+    type: 'text';
+    title: string;
+    text: string;
 }
-export interface AiFileContext extends AiContextBase {
+export interface FileContextRequest extends BaseContextRequest {
     type: 'file';
     extractImages?: boolean;
     minImageWidth?: number;
     minImageHeight?: number;
     fullPageAsImage?: boolean;
     extractionModel?: AiChatModelName;
+    password?: string;
 }
-/**
- * Provides context to the security rules of an AI Agent for each new user prompt.
- * Refer to the `@secureAiChatbotChat` annotation for more details.
- */
-export declare class AiChatContext {
-    readonly prompt?: string;
-    readonly profileId: AiAgentId;
-}
-export type AiContext = AiTextContext | AiUrlContext | AiFileContext;
 export type AiContextMetadataValue = number | string | boolean | undefined;
 export type AiContextMetadataValueArray = AiContextMetadataValue[];
 export interface AiContextMetadataEqFilter {
@@ -319,3 +353,4 @@ export interface AiContextMetadataOrFilter {
 }
 export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
 export type AiContextMetadata = Record<string, AiContextMetadataValue>;
+export {};

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

@@ -7,8 +7,6 @@ export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete
 export type TopicActionType = 'read' | 'write' | 'all';
 /** The different type of actions for metrics. */
 export type MetricActionType = 'write' | 'all';
-/** Types of actions that can be performed on an AI chatbot. */
-export type AiActionType = 'chat' | 'mutate' | 'all';
 export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';
 export interface AiFunctionParam {
     name: string;

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

@@ -10,6 +10,5 @@ export type SquidDocId = string;
 export type ClientRequestId = string;
 /** ID of AI agent. Also known as AI profile id. */
 export type AiAgentId = string;
-export type AiProfileId = AiAgentId;
 export declare const BUILT_IN_AGENT_ID = "built_in_agent";
 export type AiContextId = string;