perso-interactive-sdk-web 1.5.1 → 1.6.0

package/dist/client/index.d.ts

@@ -122,11 +122,292 @@ declare enum SessionCapabilityName {
     STF_ONPREMISE = "STF_ONPREMISE",
     STF_WEBRTC = "STF_WEBRTC"
 }
+declare enum SessionEvent {
+    SESSION_START = "SESSION_START",
+    SESSION_DURING = "SESSION_DURING",
+    SESSION_LOG = "SESSION_LOG",
+    SESSION_END = "SESSION_END",
+    SESSION_ERROR = "SESSION_ERROR",
+    SESSION_TTS = "SESSION_TTS",
+    SESSION_STT = "SESSION_STT",
+    SESSION_LLM = "SESSION_LLM"
+}
 interface TextNormalizationDownload {
     config_id: string;
     config_name: string;
     file_url: string;
 }
+declare class PersoUtil {
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "name": string
+     *   }
+     * ]
+     */
+    static getLLMs(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "name": string,
+     *     "model": string,
+     *     "style": string
+     *   }
+     * ]
+     */
+    static getModelStyles(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "backgroundimage_id": string,
+     *     "title": string,
+     *     "image": string
+     *     "created_at": string // ex) "2024-05-02T09:05:55.395Z"
+     *   }
+     * ]
+     */
+    static getBackgroundImages(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "name": string,
+     *     "service": string,
+     *     "speaker": string
+     *   }
+     * ]
+     */
+    static getTTSs(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "name": string,
+     *     "service": string
+     *   }
+     * ]
+     */
+    static getSTTs(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * Sends text to the TTS API and returns Base64-encoded audio.
+     * @param apiServer Perso Interactive API Server
+     * @param params Session ID and text to synthesize.
+     * @returns JSON with Base64 audio string.
+     * {
+     *   "audio": string
+     * }
+     */
+    static makeTTS(apiServer: string, { sessionId, text, locale, output_format }: {
+        sessionId: string;
+        text: string;
+        locale?: string;
+        output_format?: string;
+    }): Promise<{
+        audio: string;
+    }>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "name": string,
+     *     "description": string,
+     *     "prompt_id": string,
+     *     "system_prompt": string,
+     *     "require_document": boolean,
+     *     "intro_message": string
+     *   }
+     * ]
+     */
+    static getPrompts(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "document_id": string,
+     *     "title": string,
+     *     "description": string,
+     *     "search_count": number,
+     *     "processed": boolean,
+     *     "created_at": string, // ex) "2024-05-02T09:05:55.395Z",
+     *     "updated_at": string // ex) "2024-05-02T09:05:55.395Z"
+     *   }
+     * ]
+     */
+    static getDocuments(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "mcpserver_id": string,
+     *     "name": string,
+     *     "url": string,
+     *     "description": string
+     *   }
+     * ]
+     */
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * [
+     *   {
+     *     "textnormalizationconfig_id": string,
+     *     "name": string,
+     *     "created_at": string
+     *   }
+     * ]
+     */
+    static getTextNormalizations(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * Downloads the ruleset data file for a Text Normalization Config.
+     * Returns a pre-signed Blob Storage URL for the CSV file.
+     * The client can download the file directly from this URL and leverage Azure Blob Storage ETag for caching.
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @param configId Text Normalization Config ID
+     * @returns JSON
+     * {
+     *   "config_id": string,
+     *   "config_name": string,
+     *   "file_url": string
+     * }
+     */
+    static downloadTextNormalization(apiServer: string, apiKey: string, configId: string): Promise<TextNormalizationDownload>;
+    /**
+     * Retrieves the list of session templates.
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns Array of SessionTemplate objects
+     */
+    static getSessionTemplates(apiServer: string, apiKey: string): Promise<SessionTemplate[]>;
+    /**
+     * Retrieves a single session template by ID.
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @param sessionTemplateId Session Template ID
+     * @returns SessionTemplate object
+     */
+    static getSessionTemplate(apiServer: string, apiKey: string, sessionTemplateId: string): Promise<SessionTemplate>;
+    static getMcpServers(apiServer: string, apiKey: string): Promise<any>;
+    /**
+     * @param apiServer Perso Interactive API Server
+     * @param apiKey Perso Interactive API Key
+     * @returns JSON
+     * {
+     *   "session_id": string,
+     *   "client_sdp": string,
+     *   "server_sdp": string,
+     *   "prompt": {
+     *     "name": string,
+     *     "description": string,
+     *     "prompt_id": string,
+     *     "system_prompt": string,
+     *     "require_document": boolean,
+     *     "intro_message": string
+     *   },
+     *   "document": string,
+     *   "llm_type": {
+     *     "name": string
+     *   },
+     *   "model_style": {
+     *     "name": string,
+     *     "model": string,
+     *     "model_file": string,
+     *     "style": string,
+     *     "file": string
+     *   },
+     *   "tts_type": {
+     *     "name": string,
+     *     "service": string,
+     *     "model": string,
+     *     "voice": string,
+     *     "style": string,
+     *     "voice_extra_data": string
+     *   },
+     *   "ice_servers": Array<RTCIceServer>,
+     *   "status": string, // "CREATED", "EXCHANGED", "IN_PROGRESS", "TERMINATED"
+     *   "termination_reason": string, // "GRACEFUL_TERMINATION", "SESSION_EXPIRED_BEFORE_CONNECTION", "SESSION_LOST_AFTER_CONNECTION", "SESSION_MISC_ERROR", "MAX_ACTIVE_SESSION_QUOTA_EXCEEDED", "MAX_MIN_PER_SESSION_QUOTA_EXCEEDED", "TOTAL_MIN_PER_MONTH_QUOTA_EXCEEDED"
+     *   "duration_sec": number,
+     *   "created_at": string, // ex) "2024-05-02T09:05:55.395Z"
+     *   "padding_left": number,
+     *   "padding_top": number,
+     *   "padding_height": number,
+     *   "background_image": {
+     *     "backgroundimage_id": string,
+     *     "title": string,
+     *     "image": string,
+     *     "created_at": string // ex) "2024-05-02T09:05:55.395Z"
+     *  },
+     *  "extra_data": string,
+     *  "capability": Array<{
+     *    "name": string, // "LLM" | "TTS" | "STT" | "STF_ONPREMISE" | "STF_WEBRTC"
+     *    "description": string
+     *  }>
+     * }
+     */
+    static getSessionInfo(apiServer: string, sessionId: string): Promise<any>;
+    static sessionEvent(apiServer: string, sessionId: string, sessionEvent: SessionEvent, detail?: string): Promise<void>;
+    /**
+     * Sends audio data to the STT API endpoint for speech-to-text conversion.
+     * @param apiServer Perso Interactive API Server
+     * @param sessionId Session ID for the current session
+     * @param audioFile Audio file (WAV format)
+     * @param language Optional language code (e.g., 'ko', 'en')
+     * @returns STTResponse with only the transcribed text.
+     *
+     * The server returns additional fields (e.g., `locale`, `normalized_text`)
+     * which are intentionally not exposed by the SDK.
+     */
+    static makeSTT(apiServer: string, sessionId: string, audioFile: File, language?: string): Promise<STTResponse>;
+    /**
+     * Initiates an LLM streaming request and returns the response body reader.
+     * @param apiServer Perso Interactive API Server
+     * @param sessionId Session ID for the current session
+     * @param body Request body containing messages and tools
+     * @param signal Optional AbortSignal to cancel the request
+     * @returns ReadableStreamDefaultReader for SSE streaming response
+     * @throws ApiError when response is not ok
+     */
+    static makeLLM(apiServer: string, sessionId: string, body: {
+        messages: Array<object>;
+        tools: Array<object>;
+    }, signal?: AbortSignal): Promise<ReadableStreamDefaultReader<Uint8Array>>;
+    /**
+     * Fetches ICE server configuration for WebRTC peer connection setup.
+     * @param apiServer Perso Interactive API Server
+     * @param sessionId Session ID
+     * @returns Array of RTCIceServer configurations.
+     */
+    static getIceServers(apiServer: string, sessionId: string): Promise<Array<RTCIceServer>>;
+    /**
+     * Exchanges the client SDP offer with the server and returns the server SDP answer.
+     * @param apiServer Perso Interactive API Server
+     * @param sessionId Session ID
+     * @param offer Client SDP offer from RTCPeerConnection.createOffer().
+     * @returns Server SDP answer to set as remote description.
+     */
+    static exchangeSDP(apiServer: string, sessionId: string, offer: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit>;
+    static parseJson(response: Response): Promise<any>;
+}
 
 interface Chat {
     text: string;
@@ -607,6 +888,8 @@ declare class Session {
     private stopHeartbeat;
 }
 
+declare const DEFAULT_API_SERVER = "https://platform.perso.ai";
+
 /**
  * Callbacks that LlmProcessor uses to notify the host of side effects.
  */
@@ -710,114 +993,233 @@ declare class WavRecorder {
  */
 declare function createWavRecorder(options?: WavRecorderOptions): WavRecorder;
 
+type ApiKeyOptions = {
+    apiKey: string;
+    apiServer?: string;
+};
 /**
  * Retrieves the list of available LLM providers from the API.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getLLMs(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getLLMs>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
- * @returns Promise resolving with LLM metadata.
  */
-declare function getLLMs(apiServer: string, apiKey: string): Promise<any>;
+declare function getLLMs(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getLLMs>;
 /**
  * Retrieves available TTS providers.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getTTSs(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getTTSs>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getTTSs(apiServer: string, apiKey: string): Promise<any>;
+declare function getTTSs(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getTTSs>;
 /**
  * Retrieves available STT providers.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getSTTs(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getSTTs>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getSTTs(apiServer: string, apiKey: string): Promise<any>;
+declare function getSTTs(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getSTTs>;
 /**
  * Fetches avatar model styles.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getModelStyles(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getModelStyles>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getModelStyles(apiServer: string, apiKey: string): Promise<any>;
+declare function getModelStyles(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getModelStyles>;
 /**
  * Fetches preset background images.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getBackgroundImages(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getBackgroundImages>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getBackgroundImages(apiServer: string, apiKey: string): Promise<any>;
+declare function getBackgroundImages(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getBackgroundImages>;
 /**
  * Returns predefined prompt templates.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getPrompts(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getPrompts>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getPrompts(apiServer: string, apiKey: string): Promise<any>;
+declare function getPrompts(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getPrompts>;
 /**
  * Returns supporting document metadata usable by the session.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getDocuments(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getDocuments>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getDocuments(apiServer: string, apiKey: string): Promise<any>;
+declare function getDocuments(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getDocuments>;
 /**
  * Lists MCP server identifiers configured for the tenant.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getMcpServers(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getMcpServers>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getMcpServers(apiServer: string, apiKey: string): Promise<any>;
+declare function getMcpServers(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getMcpServers>;
 /**
  * Retrieves available text normalization options.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getTextNormalizations(options: ApiKeyOptions): ReturnType<typeof PersoUtil.getTextNormalizations>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
-declare function getTextNormalizations(apiServer: string, apiKey: string): Promise<any>;
+declare function getTextNormalizations(apiServer: string, apiKey: string): ReturnType<typeof PersoUtil.getTextNormalizations>;
+type GetTextNormalizationOptions = {
+    apiKey: string;
+    configId: string;
+    apiServer?: string;
+};
 /**
  * Downloads the ruleset data file for a Text Normalization Config.
  * Returns a pre-signed Blob Storage URL for the CSV file.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.configId Identifier of the Text Normalization Config to download.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getTextNormalization(options: GetTextNormalizationOptions): Promise<TextNormalizationDownload>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
- * @param configId Text Normalization Config ID.
+ * @param configId Identifier of the Text Normalization Config to download.
  */
 declare function getTextNormalization(apiServer: string, apiKey: string, configId: string): Promise<TextNormalizationDownload>;
 /**
  * Retrieves the list of session templates.
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getSessionTemplates(options: ApiKeyOptions): Promise<SessionTemplate[]>;
+/**
  * @param apiServer Perso API server URL.
  * @param apiKey API key used for authentication.
  */
 declare function getSessionTemplates(apiServer: string, apiKey: string): Promise<SessionTemplate[]>;
+type GetSessionTemplateOptions = {
+    apiKey: string;
+    sessionTemplateId: string;
+    apiServer?: string;
+};
+type AllSettings = {
+    llms: Awaited<ReturnType<typeof PersoUtil.getLLMs>>;
+    ttsTypes: Awaited<ReturnType<typeof PersoUtil.getTTSs>>;
+    sttTypes: Awaited<ReturnType<typeof PersoUtil.getSTTs>>;
+    modelStyles: Awaited<ReturnType<typeof PersoUtil.getModelStyles>>;
+    backgroundImages: Awaited<ReturnType<typeof PersoUtil.getBackgroundImages>>;
+    prompts: Awaited<ReturnType<typeof PersoUtil.getPrompts>>;
+    documents: Awaited<ReturnType<typeof PersoUtil.getDocuments>>;
+    mcpServers: Awaited<ReturnType<typeof PersoUtil.getMcpServers>>;
+    textNormalizations: Awaited<ReturnType<typeof PersoUtil.getTextNormalizations>> | [];
+};
 /**
  * Convenience helper that fetches every dropdown-friendly resource needed to
  * build a Perso session configuration screen in one call chain.
- * @param apiServer Perso API server URL.
- * @param apiKey API key used for authentication.
- * @returns Object containing arrays for LLMs, TTS/STT types, model styles, etc.
- */
-declare function getAllSettings(apiServer: string, apiKey: string): Promise<{
-    llms: any;
-    ttsTypes: any;
-    sttTypes: any;
-    modelStyles: any;
-    backgroundImages: any;
-    prompts: any;
-    documents: any;
-    mcpServers: any;
-    textNormalizations: any;
-}>;
+ *
+ * @param options.apiKey API key used for authentication.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getAllSettings(options: ApiKeyOptions): Promise<AllSettings>;
 /**
- * Sends text to the TTS API and returns Base64-encoded audio.
  * @param apiServer Perso API server URL.
- * @param params Session ID and text to synthesize.
- * @returns Object with Base64 audio string.
+ * @param apiKey API key used for authentication.
  */
-declare function makeTTS(apiServer: string, params: {
+declare function getAllSettings(apiServer: string, apiKey: string): Promise<AllSettings>;
+type MakeTTSParams = {
     sessionId: string;
     text: string;
     locale?: string;
     output_format?: string;
-}): Promise<{
+};
+type MakeTTSOptions = MakeTTSParams & {
+    apiServer?: string;
+};
+/**
+ * Sends text to the TTS API and returns Base64-encoded audio.
+ *
+ * @param options.sessionId Identifier of the active session.
+ * @param options.text Text to synthesize.
+ * @param options.locale Optional locale override for the TTS voice.
+ * @param options.output_format Optional output audio format.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function makeTTS(options: MakeTTSOptions): Promise<{
     audio: string;
 }>;
+/**
+ * @param apiServer Perso API server URL.
+ * @param params TTS request parameters (`sessionId`, `text`, optional `locale`, `output_format`).
+ */
+declare function makeTTS(apiServer: string, params: MakeTTSParams): Promise<{
+    audio: string;
+}>;
+type GetSessionInfoOptions = {
+    sessionId: string;
+    apiServer?: string;
+};
 /**
  * Retrieves metadata for an existing session.
+ *
+ * @param options.sessionId Identifier of the session to look up.
+ * @param options.apiServer Perso API server URL. Defaults to `https://platform.perso.ai`.
+ */
+declare function getSessionInfo(options: GetSessionInfoOptions): ReturnType<typeof PersoUtil.getSessionInfo>;
+/**
  * @param apiServer Perso API server URL.
- * @param sessionId Session id to inspect.
+ * @param sessionId Identifier of the session to look up.
  */
-declare function getSessionInfo(apiServer: string, sessionId: string): Promise<any>;
+declare function getSessionInfo(apiServer: string, sessionId: string): ReturnType<typeof PersoUtil.getSessionInfo>;
 
+type CreateSessionObjectOptions = {
+    sessionId: string;
+    width: number;
+    height: number;
+    clientTools: Array<ChatTool>;
+    apiServer?: string;
+};
+/** @overload Object-form. Uses DEFAULT_API_SERVER when apiServer is omitted. */
+declare function createSession(options: CreateSessionObjectOptions): Promise<Session>;
 /**
  * Creates a Session with REST-based STT/TTS (current mode).
  */
@@ -847,33 +1249,20 @@ type CreateSessionIdBody = {
     stt_text_normalization_config?: string;
     stt_text_normalization_locale?: string | null;
 };
-/**
- * Requests a new session creation ID by POSTing the desired runtime options to
- * the Perso backend (`/api/v1/session/`).
- *
- * WARNING: This function requires an API key. When using this function in
- * client-side code, the API key will be exposed to the browser. For production
- * use, prefer creating session IDs server-side using `perso-interactive-sdk-web/server`.
- *
- * @overload Creates a session from a SessionTemplate ID. Internally calls
- * `getSessionTemplate` to resolve the template and maps it to the request body.
- * @param apiServer Perso API server URL.
- * @param apiKey API key used for authentication.
- * @param sessionTemplateId SessionTemplate ID to resolve configuration from.
- * @returns Session ID returned by the server.
- * @throws {Error} If the template's `model_style.platform_type` is not `"webrtc"`.
- * @throws {SessionCreationError} When the API returns an error during session creation.
- * @throws {DoesNotExistError} When the server response `code` is `'does_not_exist'` (subclass of `SessionCreationError`).
- * @throws {NotInOrganizationError} When the server response `code` is `'not_in_organization'` (subclass of `SessionCreationError`).
- */
+type CreateSessionIdObjectOptions = {
+    apiKey: string;
+    params: CreateSessionIdBody;
+    apiServer?: string;
+} | {
+    apiKey: string;
+    sessionTemplateId: string;
+    apiServer?: string;
+};
+/** @overload Object-form. Uses DEFAULT_API_SERVER when apiServer is omitted. */
+declare function createSessionId(options: CreateSessionIdObjectOptions): Promise<string>;
+/** @overload Positional form — SessionTemplate ID. */
 declare function createSessionId(apiServer: string, apiKey: string, sessionTemplateId: string): Promise<string>;
-/**
- * @overload Creates a session from explicit runtime options.
- * @param apiServer Perso API server URL.
- * @param apiKey API key used for authentication.
- * @param params Runtime options for the session.
- * @returns Session ID returned by the server.
- */
+/** @overload Positional form — explicit params. */
 declare function createSessionId(apiServer: string, apiKey: string, params: CreateSessionIdBody): Promise<string>;
 
 declare class ApiError extends Error {
@@ -943,5 +1332,5 @@ declare function getWavSampleRate(arrayBuffer: ArrayBuffer): number;
 
 declare const TTS_TARGET_SAMPLE_RATE = 16000;
 
-export { ApiError, ChatState, ChatTool, DoesNotExistError, LLMError, LLMStreamingResponseError, LlmProcessor, NotInOrganizationError, STTError, Session, SessionCreationError, TTSDecodeError, TTSError, TTS_TARGET_SAMPLE_RATE, WavRecorder, createSession, createSessionId, createWavRecorder, getAllSettings, getBackgroundImages, getDocuments, getLLMs, getMcpServers, getModelStyles, getPrompts, getSTTs, getSessionInfo, getSessionTemplates, getTTSs, getTextNormalization, getTextNormalizations, getWavSampleRate, makeTTS };
-export type { AIHumanModelFile, BackgroundImage, Chat, Document, LLMStreamChunk, LLMType, LlmProcessorCallbacks, LlmProcessorConfig, MCPServer, ModelStyle, ModelStyleConfig, ProcessLLMOptions, Prompt, STTResponse, STTType, SessionCapability, SessionTemplate, TTSType, TextNormalizationConfig, TextNormalizationDownload, WavRecorderOptions };
+export { ApiError, ChatState, ChatTool, DEFAULT_API_SERVER, DoesNotExistError, LLMError, LLMStreamingResponseError, LlmProcessor, NotInOrganizationError, STTError, Session, SessionCreationError, TTSDecodeError, TTSError, TTS_TARGET_SAMPLE_RATE, WavRecorder, createSession, createSessionId, createWavRecorder, getAllSettings, getBackgroundImages, getDocuments, getLLMs, getMcpServers, getModelStyles, getPrompts, getSTTs, getSessionInfo, getSessionTemplates, getTTSs, getTextNormalization, getTextNormalizations, getWavSampleRate, makeTTS };
+export type { AIHumanModelFile, ApiKeyOptions, BackgroundImage, Chat, CreateSessionObjectOptions, Document, GetSessionInfoOptions, GetSessionTemplateOptions, GetTextNormalizationOptions, LLMStreamChunk, LLMType, LlmProcessorCallbacks, LlmProcessorConfig, MCPServer, MakeTTSOptions, ModelStyle, ModelStyleConfig, ProcessLLMOptions, Prompt, STTResponse, STTType, SessionCapability, SessionTemplate, TTSType, TextNormalizationConfig, TextNormalizationDownload, WavRecorderOptions };