@squidcloud/client 1.0.492 → 1.0.494

package/dist/internal-common/src/utils/squid.constants.d.ts

@@ -0,0 +1,6 @@
+export declare const SQUID_SUPPORT_EMAIL = "support@getsquid.ai";
+/**
+ * Error code when application is not found.
+ * Must be in sync with Kotlin.
+ */
+export declare const APPLICATION_NOT_FOUND_ERROR = "APPLICATION_NOT_FOUND";

package/dist/internal-common/src/utils/trace-id-generator.d.ts

@@ -0,0 +1 @@
+export declare function generateTraceId(prefix?: string): string;

package/dist/internal-common/src/utils/validation.d.ts

@@ -0,0 +1,21 @@
+import { HttpStatusCode } from '../public-types/http-status.public-types';
+export declare class ValidationError extends Error {
+    readonly statusCode: HttpStatusCode;
+    readonly details?: any;
+    constructor(error: string, statusCode: HttpStatusCode, details?: Record<string, unknown>);
+}
+export declare function isValidId(id: unknown, maxLength?: number): boolean;
+export declare function validateFieldSort(fieldSort: unknown): void;
+/** The largest limit one query may carry. */
+export declare const MAX_QUERY_LIMIT = 20000;
+export declare function validateQueryLimit(limit: unknown): void;
+/**
+ * All type names returned by 'typeof' supported by JavaScript:
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof}.
+ * and a few other supported types.
+ */
+export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
+/** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
+export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
+/** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
+export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;

package/dist/internal-common/src/websocket.impl.d.ts

@@ -0,0 +1,26 @@
+interface Options {
+    maxAttempts?: number;
+    protocols?: string[];
+    onmessage?: (event: any) => void;
+    onopen?: (event: any) => void;
+    onclose?: (event: any) => void;
+    onerror?: (event: any) => void;
+    onreconnect?: (event: any) => void;
+    onmaximum?: (event: any) => void;
+    timeoutMillis?: number;
+}
+export interface WebSocketWrapper {
+    open: () => void;
+    reconnect: (e: any) => void;
+    json: (x: any) => void;
+    send: (x: string) => void;
+    close: (x?: number, y?: string) => void;
+    connected: boolean;
+    /**
+     * Websocket is explicitly closed by calling socket.close().
+     * Used to ignore errors after socket.closed() is called.
+     */
+    closeCalled: boolean;
+}
+export declare function createWebSocketWrapper(url: string, opts?: Options): WebSocketWrapper;
+export {};

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

@@ -262,7 +262,7 @@ export declare class AiAgentReference {
      */
     private withMetricAnnotations;
     /**
-     * Calls rpcManager post but with the agent api key if one was given during construction
+     * Calls rpcManager post with [headers], adding the agent api key if one was given during construction
      */
     private post;
 }

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

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiAnnotation, AiChatModelSelection, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiAnnotation, AiChatModelSelection, AiChatOptions, AiChatRequestCredentials } from '../../../internal-common/src/public-types/ai-agent.public-types';
 /**
  * Response format for transcribing audio and generating a chat response.
  * Contains the transcribed text and a stream of AI-generated responses.
@@ -51,18 +51,18 @@ export interface AskWithVoiceResponse {
  */
 export type AiChatOptionsWithoutVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
     model?: T;
-};
+} & AiChatRequestCredentials;
 /**
  * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
  * @category AI
  */
 export type AiAskOptions<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
     model?: T;
-};
+} & AiChatRequestCredentials;
 /**
  * Options for AI-generated responses that include voice-specific settings but excludes smooth typing.
  * @category AI
  */
 export type AiAskOptionsWithVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
     model?: T;
-};
+} & AiChatRequestCredentials;

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

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { AiFunctionMetadata } from '../../internal-common/src/public-types/ai-function.public-types';
-import { AiQueryOptions, AiQueryResponse, AiSpreadsheetQueryOptions, ExecuteAiApiResponse, ExecuteAiSpreadsheetQueryResponse } from '../../internal-common/src/public-types/ai-query.public-types';
+import { AiQueryRequestOptions, AiQueryResponse, AiSpreadsheetQueryOptions, ExecuteAiApiResponse, ExecuteAiSpreadsheetQueryResponse } from '../../internal-common/src/public-types/ai-query.public-types';
 import { AiAgentClientOptions } from './agent/ai-agent-client';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAudioClient } from './ai-audio-client';
@@ -8,7 +8,8 @@ import { AiFilesClient } from './ai-files-client';
 import { AiImageClient } from './ai-image-client';
 import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
-import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiFileUrl, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, ListChatModelsRequest, ModelIdSpec, SecretKey } from './public-types';
+import { AiVoiceClient } from './ai-voice-client';
+import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiFileUrl, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, EmbeddingModelIdSpec, IntegrationId, JobId, ListChatModelsRequest, ListEmbeddingModelsRequest, ModelIdSpec, SecretKey } from './public-types';
 /**
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -53,6 +54,13 @@ export declare class AiClient {
      * included only when `options.includeDeprecated` is true and are marked with `replacedBy`.
      */
     listChatModels(options?: ListChatModelsRequest): Promise<ModelIdSpec[]>;
+    /**
+     * Returns the embedding models a new knowledge base can be created on: Squid-provided vendor models
+     * and the application's custom integration models. Exactly one entry is `isDefault`. Deprecated
+     * vendor models are included only when `options.includeDeprecated` is true and are marked with
+     * `replacedBy`.
+     */
+    listEmbeddingModels(options?: ListEmbeddingModelsRequest): Promise<EmbeddingModelIdSpec[]>;
     /**
      * Retrieves an AI image client.
      */
@@ -61,6 +69,10 @@ export declare class AiClient {
      * Retrieves an AI audio client.
      */
     audio(): AiAudioClient;
+    /**
+     * Retrieves an AI voice client, which opens phone-call sessions relayed to an agent.
+     */
+    voice(): AiVoiceClient;
     /**
      * Retrieves an AI match-making client.
      * @deprecated - Use `knowledgebase('kbId').searchContextsWith*()` instead.
@@ -90,7 +102,8 @@ export declare class AiClient {
      * @param prompt        The text prompt to send to the AI. This should be formulated in a way that the AI can
      *                      understand and respond to, taking into account the nature of the task or the information
      *                      sought.
-     * @param options       Additional options to customize the query execution.
+     * @param options       Additional options to customize the query execution. An `accessToken` is sent as a request
+     *                      header rather than with the options.
      * @param abortSignal   Optional signal used to abort the underlying request. When the signal aborts, the in-flight
      *                      HTTP request is cancelled and its promise rejects, allowing callers to bound a single call
      *                      without leaking the request.
@@ -109,7 +122,7 @@ export declare class AiClient {
      * For more details on the usage and capabilities of the AI Assistant, refer to the documentation provided at
      * {@link https://docs.squid.cloud/docs/ai}.
      */
-    executeAiQuery(integrationId: IntegrationId, prompt: string, options?: AiQueryOptions, abortSignal?: AbortSignal): Promise<AiQueryResponse>;
+    executeAiQuery(integrationId: IntegrationId, prompt: string, options?: AiQueryRequestOptions, abortSignal?: AbortSignal): Promise<AiQueryResponse>;
     /**
      * Executes an AI-powered API call using a specific integration.
      * The AI will select appropriate endpoints, generate request bodies,

package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResponse, AiKnowledgeBaseSearchResultChunk, BulkIngestionContext, BulkIngestionCreateUploadUrlsResponse, BulkIngestionJobStatusResponse, BulkIngestionUpsertContextsResponse, ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, GetKnowledgeBaseGraphStatusResponse, GrepKnowledgeBaseOptions, GrepKnowledgeBaseResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResponse, AiKnowledgeBaseSearchResultChunk, BulkIngestionContext, BulkIngestionCreateUploadUrlsResponse, BulkIngestionJobStatusResponse, BulkIngestionUpsertContextsOptions, BulkIngestionUpsertContextsResponse, ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, GetKnowledgeBaseGraphStatusResponse, GrepKnowledgeBaseOptions, GrepKnowledgeBaseResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
 import { AiContextId } from '../../../internal-common/src/public-types/communication.public-types';
 /**
  * Parameters for creating or updating an AI agent.
@@ -130,10 +130,12 @@ export declare class AiKnowledgeBaseReference {
      * caps are enforced by the upload parser and exceeding either is rejected before staging runs. For larger
      * sets use {@link createBulkUploadUrls} and pass `stagedObjectKey` instead, which uploads straight to
      * storage and is subject to neither cap.
+     * @param options `speed` says how quickly the job must finish, and so which provider tier Squid buys
+     * for it; omitted, Squid decides from the job's size.
      * @returns The id of the staged bulk-ingestion job, plus the context id assigned to each staged context
      * (in the same order as `contextRequests`).
      */
-    bulkUpsertContexts(contextRequests: Array<BulkIngestionContext>, files?: Array<File>): Promise<BulkIngestionUpsertContextsResponse>;
+    bulkUpsertContexts(contextRequests: Array<BulkIngestionContext>, files?: Array<File>, options?: BulkIngestionUpsertContextsOptions): Promise<BulkIngestionUpsertContextsResponse>;
     /**
      * Mints presigned upload URLs for direct-to-storage bulk files, bypassing multipart upload through core.
      * PUT each file's bytes to its `uploadUrl` — sending every header in that entry's `requiredHeaders`,

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

@@ -0,0 +1,42 @@
+import { AiWebVoiceCall, AiWebVoiceCallOptions } from './ai-web-voice-call';
+import { AnswerOpenAiVoiceCallRequest, AnswerOpenAiVoiceCallResponse, CreateAiVoiceSessionRequest, CreateAiVoiceSessionResponse, StartOpenAiWebVoiceCallRequest, StartOpenAiWebVoiceCallResponse } from './public-types';
+/**
+ * AiVoiceClient puts agents on voice calls: phone calls a telephony provider relays to or OpenAI answers
+ * for a Squid agent (application API key), and browser calls a user starts from a web page.
+ * @category AI
+ */
+export declare class AiVoiceClient {
+    private readonly rpcManager;
+    /**
+     * Opens a voice session and returns the relay URL the telephony provider must connect to.
+     *
+     * @param request - The agent, provider and per-call chat options.
+     * @returns The session id, its one-time token and the absolute relay URL.
+     */
+    createSession(request: CreateAiVoiceSessionRequest): Promise<CreateAiVoiceSessionResponse>;
+    /**
+     * Answers a phone call that reached an OpenAI project's SIP endpoint: Squid accepts it and speaks for the
+     * agent until the call ends.
+     *
+     * @param request - The call, the agent, and how the realtime model should talk.
+     * @returns The id of the voice session that runs the call.
+     */
+    answerOpenAiCall(request: AnswerOpenAiVoiceCallRequest): Promise<AnswerOpenAiVoiceCallResponse>;
+    /**
+     * Starts a browser call with an agent from a WebRTC offer: Squid creates the call on the OpenAI Realtime
+     * API, runs the agent behind it, and returns the answer for the browser's remote description. Use
+     * {@link startWebCall} for the whole flow, this for a custom WebRTC setup.
+     *
+     * @param request - The agent, the offer and optional voice settings.
+     * @returns The session id, the call id and OpenAI's answer.
+     */
+    startOpenAiWebCall(request: StartOpenAiWebVoiceCallRequest): Promise<StartOpenAiWebVoiceCallResponse>;
+    /**
+     * Starts a voice conversation with an agent in the browser: opens the microphone, connects to the OpenAI
+     * realtime model over WebRTC and plays the agent's voice. Browser only.
+     *
+     * @param options - The agent and optional voice settings.
+     * @returns The running call, to listen to its turns, mute it or stop it.
+     */
+    startWebCall(options: AiWebVoiceCallOptions): Promise<AiWebVoiceCall>;
+}

package/dist/typescript-client/src/ai-web-voice-call.d.ts

@@ -0,0 +1,62 @@
+import { AiVoiceSessionTurn, StartOpenAiWebVoiceCallRequest } from './public-types';
+/**
+ * Where the agent's voice plays; an `<audio>` element does.
+ * @category AI
+ */
+export interface AiWebVoiceCallSink {
+    /** The media stream to play. */
+    srcObject: unknown;
+    /** Whether playback starts as soon as the stream arrives. */
+    autoplay: boolean;
+    /** Starts playback. */
+    play(): Promise<void>;
+}
+/**
+ * Options of a browser call: everything of {@link StartOpenAiWebVoiceCallRequest} except the offer, which the
+ * call produces itself.
+ * @category AI
+ */
+export interface AiWebVoiceCallOptions extends Omit<StartOpenAiWebVoiceCallRequest, 'sdp'> {
+    /** Plays the agent's voice; created on the page when omitted. */
+    sink?: AiWebVoiceCallSink;
+}
+/**
+ * An event of the call as the Realtime API reports it over the data channel, such as
+ * `conversation.item.input_audio_transcription.completed` or `response.done`.
+ * @category AI
+ */
+export interface AiWebVoiceCallEvent {
+    /** The event type, e.g. `response.done`. */
+    type: string;
+    /** The rest of the event, as the Realtime API sends it. */
+    [key: string]: unknown;
+}
+/**
+ * A voice conversation with an agent from the browser: the microphone goes to the OpenAI realtime model over
+ * WebRTC, its voice comes back the same way, and Squid runs the agent behind it. Start one with
+ * {@link AiVoiceClient.startWebCall}.
+ * @category AI
+ */
+export declare class AiWebVoiceCall {
+    /** Id of the voice session in Squid; its transcript events carry it. */
+    readonly sessionId: string;
+    /** Id of the call at OpenAI. */
+    readonly callId: string;
+    private readonly peer;
+    private readonly microphone;
+    private readonly eventListeners;
+    private readonly endListeners;
+    private ended;
+    /** Listens to every event of the call; returns the function that stops listening. */
+    onEvent(listener: (event: AiWebVoiceCallEvent) => void): () => void;
+    /** Listens to the spoken turns, the caller's as transcribed and the agent's as spoken. */
+    onTurn(listener: (turn: AiVoiceSessionTurn) => void): () => void;
+    /** Runs once the call is over, whether the agent hung up, the connection dropped or {@link stop} was called. */
+    onEnd(listener: () => void): () => void;
+    /** Silences or restores the microphone without ending the call. */
+    setMuted(muted: boolean): void;
+    /** Ends the call from the browser's side. */
+    stop(): void;
+    private dispatch;
+    private finish;
+}

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

@@ -10,6 +10,8 @@ export * from './ai-knowledge-base/ai-knowledge-base-client';
 export * from './ai-knowledge-base/ai-knowledge-base-client-reference';
 export * from './ai-matchmaking-client';
 export * from './ai-status-updates';
+export * from './ai-voice-client';
+export * from './ai-web-voice-call';
 export * from './api-client';
 export * from './auth.manager';
 export * from './backend-function.manager';

package/dist/typescript-client/src/public-types.d.ts

@@ -1,11 +1,13 @@
 export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
 export * from '../../internal-common/src/public-types/ai-agent.public-types';
 /** AI function metadata types for listing and describing available functions. */
+export * from '../../internal-common/src/public-types/ai-agent-connection.public-types';
 export * from '../../internal-common/src/public-types/ai-common.public-types';
 export * from '../../internal-common/src/public-types/ai-function.public-types';
 export * from '../../internal-common/src/public-types/ai-knowledge-base.public-types';
 export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
 export * from '../../internal-common/src/public-types/ai-query.public-types';
+export * from '../../internal-common/src/public-types/ai-voice.public-types';
 export * from '../../internal-common/src/public-types/api-client.public-types';
 export * from '../../internal-common/src/public-types/api.public-types';
 export * from '../../internal-common/src/public-types/backend.public-types';

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.492";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.494";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.492",
+  "version": "1.0.494",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",