@squidcloud/client 1.0.324 → 1.0.326

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

@@ -1,12 +1,14 @@
-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-1.5-flash"];
+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"];
 /** The supported AI model names. */
-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-1.5-flash"];
+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"];
 export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
 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. */
@@ -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,7 +180,27 @@ export interface AiAgentChatOptions {
     quotas?: AiChatPromptQuotas;
     /** Include metadata in the context */
     includeMetadata?: boolean;
+    /** 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;
@@ -268,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;
@@ -316,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/public-types/communication.public-types.d.ts

@@ -11,4 +11,5 @@ 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;

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

@@ -1,6 +1,6 @@
 import { IntegrationId } from './communication.public-types';
 /** List of all integration types supported by Squid. */
-export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elastic_enterprise_search", "elastic_observability", "elastic_search", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "slack", "snowflake", "spanner", "xata", "zendesk", "mail"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elastic_enterprise_search", "elastic_observability", "elastic_search", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
 export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "mysql", "oracledb", "postgres", "sap_hana", "snowflake"];
 export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "descope", "firebase_auth"];
 export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];

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.*/
@@ -26,4 +28,7 @@ export interface AiChatOptions {
     connectedIntegrations?: Array<AiConnectedIntegrationMetadata>;
     /** Current budget for nested or recursive AI chat calls per single prompt. */
     quotas?: AiChatPromptQuotas;
+    /** Enables grounding with real-time web search to enhance AI responses with up-to-date information.
+     * Currently supported only for gemini-2.0-flash. */
+    groundingWithWebSearch?: boolean;
 }

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/ai-agent-client.d.ts

@@ -1,4 +1,4 @@
-import { AiAgentChatOptions, AiContext, AiAgentId, AiAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_AGENT_METADATA_FIELDS } from './public-types';
+import { AiAgentChatOptions, AiAgentId, AiAgentMetadata, AiContext, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_AGENT_METADATA_FIELDS } from './public-types';
 import { Observable } from 'rxjs';
 import { BlobAndFilename } from './types';
 export interface TranscribeAndChatResponse {
@@ -126,7 +126,7 @@ export declare class AiAgentReference {
      *
      * @param data An object containing options for creating the agent.
      * @param data.modelName - The name of the AI model (`gpt-3.5, `gpt-4`, `claude-3-5-sonnet-latest` or
-     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro` `gemini-1.5-flash`).
+     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro`, `gemini-2.0-flash`).
      * @param data.isPublic - Whether the chat functionality of the agent can be accessed without security rules.
      * @returns A promise that resolves when the agent is successfully created.
      */
@@ -137,7 +137,7 @@ export declare class AiAgentReference {
      *
      * @param data - An object containing options for updating the agent.
      * @param data.modelName - The name of the OpenAI model (`gpt-3.5`, `gpt-4`, `claude-3-5-sonnet-latest`,
-     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro`, or `gemini-1.5-flash`).
+     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro`, `gemini-2.0-flash`).
      * @param data.isPublic - Whether the chat functionality of the agent can be accessed without security rules.
      * @param file - The file to upload (optional).
      * @returns A promise that resolves when the agent is successfully updated.

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

@@ -15,7 +15,7 @@ export declare class AiClient {
     private readonly rpcManager;
     private readonly aiAssistantClient;
     private aiAgentClient?;
-    agent(agentId: AiAgentId): AiAgentReference;
+    agent(agentId?: AiAgentId): AiAgentReference;
     /**
      * Retrieves the AI assistant client.
      * @returns An instance of AiAssistantClient.

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.324",
+  "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",