@squidcloud/client 1.0.325 → 1.0.326

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 { 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];
@@ -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>;
     /**
@@ -188,10 +180,27 @@ 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;
+    overrideModel?: AiChatModelName;
+}
+export interface GeminiChatOptions extends BaseAiAgentChatOptions {
+    overrideModel?: GeminiChatModelName;
     groundingWithWebSearch?: boolean;
 }
+export interface OpenAiReasoningChatOptions extends BaseAiAgentChatOptions {
+    overrideModel?: OpenAiReasoningChatModelName;
+    reasoningEffort?: 'low' | 'medium' | 'high';
+}
+export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
+    overrideModel?: OpenAiChatModelName;
+    topP?: number;
+    fileUrls?: Array<AiFileUrl>;
+}
+export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
+    overrideModel?: AnthropicChatModelName;
+}
+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;
 export interface AiObserveStatusOptions {
     /** A unique chat ID for the conversation. */
     chatId?: string;
@@ -271,7 +280,7 @@ export interface AiFileContext extends AiContextBase {
 }
 /**
  * Provides context to the security rules of an AI Agent for each new user prompt.
- * Refer to the `@secureAiChatbotChat` annotation for more details.
+ * Refer to the `@secureAiAgent` annotation for more details.
  */
 export declare class AiChatContext {
     readonly prompt?: string;
@@ -319,3 +328,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/types/ai-agent.types.d.ts

@@ -16,6 +16,8 @@ export interface AiChatOptions {
     agentId?: AiAgentId;
     /** A unique chat ID for the conversation. */
     chatId?: string;
+    /** A unique ID for the currentt trace. */
+    traceId?: string;
     /** Global per-agent context passed to all AI functions. Must be a serializable JSON. */
     agentContext?: Record<string, unknown>;
     /** List of AI functions available for the agent. Overrides the stored list.*/

package/dist/internal-common/src/types/observability.types.d.ts

@@ -38,7 +38,7 @@ export interface LogEvent {
     source?: string;
     service?: string;
 }
-export declare const AUDIT_LOG_EVENT_NAMES: readonly ["ai_agent_prompt"];
+export declare const AUDIT_LOG_EVENT_NAMES: readonly ["ai_agent"];
 export type AuditLogEventName = (typeof AUDIT_LOG_EVENT_NAMES)[number];
 export interface AuditLogEvent {
     appId: AppId;

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.325";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.326";

package/package.json

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