@squidcloud/client 1.0.388 → 1.0.390

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

@@ -1,179 +1,10 @@
+import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiEmbeddingsModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat, OpenAiReasoningChatModelName } from './ai-common.public-types';
+import { AiContextMetadata, AiContextMetadataFilter, AiKnowledgeBaseContextType, AiRagType } from './ai-knowledge-base.public-types';
 import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
-import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
+import { AiAgentId, AiContextId, AiKnowledgeBaseId, IntegrationId } from './communication.public-types';
 import { IntegrationType } from './integration.public-types';
 import { JobId } from './job.public-types';
 import { SecretKey } from './secret.public-types';
-/** List of available AI provider types. See AiProviderType. */
-export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini", "openai", "grok", "stability", "voyage", "external"];
-/**
- * Type of the AI provider.
- * References a single AI service, regardless of the model or other AI function it provides (like
- * chat/search/transcribe etc...).
- */
-export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
-/**
- * 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", "o3-mini", "o4-mini"];
-/**
- * @category AI
- */
-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
- */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash"];
-/**
- * @category AI
- */
-export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
-/**
- * @category AI
- */
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514"];
-/**
- * The supported AI model names.
- * @category AI
- */
-export declare const VENDOR_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-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-2.5-pro", "gemini-2.5-flash", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
-/**
- * Check if the given model name is a global AI chat model name.
- */
-export declare function isVendorAiChatModelName(modelName: string): modelName is (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
-/**
- * @category AI
- */
-export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small"];
-/**
- * @category AI
- */
-export declare const VOYAGE_EMBEDDING_MODEL_NAMES: readonly ["voyage-3-large"];
-/**
- * @category AI
- */
-export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "voyage-3-large"];
-/**
- * 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", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
-/**
- * @category AI
- */
-export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
-/**
- * @category AI
- */
-export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe", "tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
-/**
- * @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", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
-/**
- * @category AI
- */
-export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
-/**
- * @category AI
- */
-export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
-/**
- * @category AI
- */
-export type VendorAiChatModelName = (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
-/**
- * @category AI
- */
-export type AiChatModelName = VendorAiChatModelName | UserAiChatModelName;
-/**
- * @category AI
- */
-export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
-/**
- * @category AI
- */
-export type AiVoyageEmbeddingsModelName = (typeof VOYAGE_EMBEDDING_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 GrokChatModelName = (typeof GROK_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
  */
@@ -190,22 +21,6 @@ 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
@@ -376,6 +191,16 @@ export interface AiConnectedAgentMetadata {
     /** A description of the connected agent for the parent agent context, used as AI function description. */
     description: string;
 }
+/**
+ * Metadata for a connected AI Knowledge Base callable by the current agent.
+ * @category AI
+ */
+export interface AiConnectedKnowledgeBaseMetadata {
+    /** The ID of the connected AI KnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /** A description of when to use this AiKnowledgeBase */
+    description: string;
+}
 /**
  * Quotas for a single AI chat prompt (`ask()` method call).
  * @category AI
@@ -467,6 +292,8 @@ export interface BaseAiChatOptions {
     connectedAgents?: Array<AiConnectedAgentMetadata>;
     /** List of connected AI agents can be called by the current agent. Overrides the stored value. */
     connectedIntegrations?: Array<AiConnectedIntegrationMetadata>;
+    /** List of connected AiKnowlegeBases that can be called by the current agent */
+    connectedKnowledgeBases?: Array<AiConnectedKnowledgeBaseMetadata>;
     /** Current budget for nested or recursive AI chat calls per single prompt. */
     quotas?: AiChatPromptQuotas;
     /** Include metadata in the context */
@@ -644,7 +471,7 @@ export interface AiAgentContext {
     /** The ID of the agent owning this context. */
     agentId: AiAgentId;
     /** The type of context (e.g., 'text' or 'file'). */
-    type: AiContextType;
+    type: AiKnowledgeBaseContextType;
     /** A title describing the context content. */
     title: string;
     /** The text content of the context. */
@@ -662,7 +489,7 @@ export interface AiAgentContext {
 export type AgentContextRequest = TextContextRequest | FileContextRequest;
 interface BaseContextRequest {
     contextId: string;
-    type: AiContextType;
+    type: AiKnowledgeBaseContextType;
     metadata?: AiContextMetadata;
 }
 /**
@@ -718,10 +545,6 @@ export interface AiContextTextOptions extends BaseAiContextOptions {
  */
 export interface AiContextFileOptions extends BaseAiContextOptions {
 }
-/**
- * @category AI
- */
-export type AiContextType = 'text' | 'file';
 /**
  * Request structure for adding text-based context to an AI agent.
  * @category AI
@@ -752,73 +575,6 @@ export interface FileContextRequest extends BaseContextRequest {
     /** General options for how to process the file. */
     options?: AiContextFileOptions;
 }
-/**
- * @category AI
- */
-export type AiContextMetadataValue = number | string | boolean | undefined;
-/**
- * @category AI
- */
-export type AiContextMetadataValueArray = AiContextMetadataValue[];
-interface AiContextMetadataEqFilter {
-    $eq: AiContextMetadataValue;
-}
-interface AiContextMetadataNeFilter {
-    $ne: AiContextMetadataValue;
-}
-interface AiContextMetadataGtFilter {
-    $gt: number;
-}
-interface AiContextMetadataGteFilter {
-    $gte: number;
-}
-interface AiContextMetadataLtFilter {
-    $lt: number;
-}
-interface AiContextMetadataLteFilter {
-    $lte: number;
-}
-interface AiContextMetadataInFilter {
-    $in: AiContextMetadataValueArray;
-}
-interface AiContextMetadataNinFilter {
-    $nin: AiContextMetadataValueArray;
-}
-interface AiContextMetadataExistsFilter {
-    $exists: boolean;
-}
-/**
- * @category AI
- */
-export type AiContextMetadataSimpleFilter = AiContextMetadataEqFilter | AiContextMetadataNeFilter | AiContextMetadataGtFilter | AiContextMetadataGteFilter | AiContextMetadataLtFilter | AiContextMetadataLteFilter | AiContextMetadataInFilter | AiContextMetadataNinFilter | AiContextMetadataExistsFilter;
-/**
- * A filter for AI context metadata based on field-specific conditions or values.
- * @category AI
- */
-export interface AiContextMetadataFieldFilter {
-    /** A record where keys are field names and values are either simple filters or direct metadata values. */
-    [field: string]: AiContextMetadataSimpleFilter | AiContextMetadataValue;
-}
-/**
- * A filter combining multiple AI context metadata filters with a logical AND operation.
- * @category AI
- */
-export interface AiContextMetadataAndFilter {
-    /** An array of filters that must all be true for the condition to pass. */
-    $and: AiContextMetadataFilter[];
-}
-/**
- * A filter combining multiple AI context metadata filters with a logical OR operation.
- * @category AI
- */
-export interface AiContextMetadataOrFilter {
-    /** An array of filters where at least one must be true for the condition to pass. */
-    $or: AiContextMetadataFilter[];
-}
-/**
- * @category AI
- */
-export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
 /**
  * Base options for how to deal with the content being upserted.
  * @category AI
@@ -829,11 +585,6 @@ export type BaseAiContextOptions = {
     /** 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
- */
-export type AiContextMetadata = Record<string, AiContextMetadataValue>;
 /**
  * @category AI
  */

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

@@ -1,4 +1,5 @@
-import { AiAgentResponseFormat, AiReasoningEffort, OpenAiChatModelName } from './ai-agent.public-types';
+import { AiAgentResponseFormat, AiReasoningEffort } from './ai-agent.public-types';
+import { OpenAiChatModelName } from './ai-common.public-types';
 import { AiFunctionId } from './backend.public-types';
 /**
  * The type of assistant tool.

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

@@ -0,0 +1,185 @@
+import { UserAiChatModelName } from './backend.public-types';
+/**
+ * @category AI
+ */
+export declare const RERANK_PROVIDERS: readonly ["cohere", "none"];
+/**
+ * @category AI
+ */
+export type AiRerankProvider = (typeof RERANK_PROVIDERS)[number];
+/** List of available AI provider types. See AiProviderType. */
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini", "openai", "grok", "stability", "voyage", "external"];
+/**
+ * Type of the AI provider.
+ * References a single AI service, regardless of the model or other AI function it provides (like
+ * chat/search/transcribe etc...).
+ */
+export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
+/**
+ * The supported OpenAI models.
+ * @category AI
+ */
+export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1"];
+/**
+ * @category AI
+ */
+export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini"];
+/**
+ * @category AI
+ */
+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", "o3", "o3-mini", "o4-mini"];
+/**
+ * @category AI
+ */
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite"];
+/**
+ * Notes:
+ * - 'grok-3-mini' model os ~10x less expensive than 'grok-3'.
+ * - '*-fast' models are ~2x more expensive than non-fast variants and only marginally faster.
+ * - 'grok-4' cost is comparable to 'grok-3-fast'.
+ *
+ * @category AI
+ */
+export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
+/**
+ * @category AI
+ */
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514"];
+/**
+ * The supported AI model names.
+ * @category AI
+ */
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o3", "o3-mini", "o4-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
+/**
+ * Check if the given model name is a global AI chat model name.
+ */
+export declare function isVendorAiChatModelName(modelName: string): modelName is (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small"];
+/**
+ * @category AI
+ */
+export declare const VOYAGE_EMBEDDING_MODEL_NAMES: readonly ["voyage-3-large"];
+/**
+ * @category AI
+ */
+export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "voyage-3-large"];
+/**
+ * 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", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
+/**
+ * @category AI
+ */
+export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
+/**
+ * @category AI
+ */
+export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe", "tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
+/**
+ * @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", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
+/**
+ * @category AI
+ */
+export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
+/**
+ * @category AI
+ */
+export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
+/**
+ * @category AI
+ */
+export type VendorAiChatModelName = (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export type AiChatModelName = VendorAiChatModelName | UserAiChatModelName;
+/**
+ * @category AI
+ */
+export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export type AiVoyageEmbeddingsModelName = (typeof VOYAGE_EMBEDDING_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 GrokChatModelName = (typeof GROK_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];