hume 0.8.1-beta5 → 0.8.1-beta7

package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Specifies the duration of user inactivity (in seconds) after which the EVI WebSocket connection will be automatically disconnected. Default is 600 seconds (10 minutes).
+ *
+ * Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
+ */
+export interface PostedTimeoutSpecsInactivity {
+    /**
+     * Boolean indicating if this timeout is enabled.
+     *
+     * If set to `false`, EVI will not timeout due to a specified duration of user inactivity being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
+     */
+    enabled: boolean;
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
+    durationSecs?: number;
+}

package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Specifies the maximum allowed duration (in seconds) for an EVI WebSocket connection before it is automatically disconnected. Default is 1,800 seconds (30 minutes).
+ *
+ * Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
+ */
+export interface PostedTimeoutSpecsMaxDuration {
+    /**
+     * Boolean indicating if this timeout is enabled.
+     *
+     * If set to `false`, EVI will not timeout due to a specified maximum duration being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
+     */
+    enabled: boolean;
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
+    durationSecs?: number;
+}

package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/empathicVoice/types/ProsodyInference.d.ts

@@ -3,5 +3,10 @@
  */
 import * as Hume from "../../../index";
 export interface ProsodyInference {
+    /**
+     * The confidence levels of 48 expressions in a given audio sample.
+     *
+     * Scores typically range from 0 to 1, with higher values indicating a stronger confidence level in the measured attribute.
+     */
     scores: Hume.empathicVoice.EmotionScores;
 }

package/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts

@@ -5,7 +5,11 @@
  * Resume responses from EVI. Chat history sent while paused will now be sent.
  */
 export interface ResumeAssistantMessage {
-    /** The type of message sent through the socket; for a Resume Assistant message, this must be `resume_assistant_message`. */
+    /**
+     * The type of message sent through the socket; must be `resume_assistant_message` for our server to correctly identify and process it as a Resume Assistant message.
+     *
+     * Upon resuming, if any audio input was sent during the pause, EVI will retain context from all messages sent but only respond to the last user message. (e.g., If you ask EVI two questions while paused and then send a `resume_assistant_message`, EVI will respond to the second question and have added the first question to its conversation context.)
+     */
     type: "resume_assistant_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;

package/api/resources/empathicVoice/types/ReturnConfig.d.ts

@@ -27,4 +27,5 @@ export interface ReturnConfig {
     /** List of built-in tools associated with this config */
     builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
+    timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
 }

package/api/resources/empathicVoice/types/SessionSettings.d.ts

@@ -6,21 +6,65 @@ import * as Hume from "../../../index";
  * Settings for this chat session.
  */
 export interface SessionSettings {
-    /** The type of message sent through the socket; for a Session Settings message, this must be `session_settings`. */
+    /**
+     * The type of message sent through the socket; must be `session_settings` for our server to correctly identify and process it as a Session Settings message.
+     *
+     * Session settings are temporary and apply only to the current Chat session. These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience.
+     *
+     * For more information, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
+     */
     type: "session_settings";
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    /**
+     * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
+     *
+     * If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
+     *
+     * It is recommended to pass a `custom_session_id` if you are using a Custom Language Model. Please see our guide to [using a custom language model](/docs/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
+     */
     customSessionId?: string;
-    /** Instructions for how the system should respond to the user. Set to null to use the default system prompt. */
+    /**
+     * Instructions used to shape EVI’s behavior, responses, and style for the session.
+     *
+     * When included in a Session Settings message, the provided Prompt overrides the existing one specified in the EVI configuration. If no Prompt was defined in the configuration, this Prompt will be the one used for the session.
+     *
+     * You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles.
+     *
+     * For help writing a system prompt, see our [Prompting Guide](/docs/empathic-voice-interface-evi/prompting).
+     */
     systemPrompt?: string;
-    /** User context to inject. Set to null to disable context injection. */
+    /**
+     * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+     *
+     * When included in a Session Settings message, the provided context can be used to remind the LLM of its role in every user message, prevent it from forgetting important details, or add new relevant information to the conversation.
+     *
+     * Set to `null` to disable context injection.
+     */
     context?: Hume.empathicVoice.Context;
-    /** Audio configuration. */
+    /**
+     * Configuration details for the audio input used during the session. Ensures the audio is being correctly set up for processing.
+     *
+     * This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
+     */
     audio?: Hume.empathicVoice.AudioConfiguration;
-    /** Third party API key for the language model used for non-Hume models. */
+    /**
+     * Third party API key for the supplemental language model.
+     *
+     * When provided, EVI will use this key instead of Hume’s API key for the supplemental LLM. This allows you to bypass rate limits and utilize your own API key as needed.
+     */
     languageModelApiKey?: string;
-    /** List of tools to enable. */
+    /**
+     * List of user-defined tools to enable for the session.
+     *
+     * Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our [Tool Use Guide](/docs/empathic-voice-interface-evi/tool-use).
+     */
     tools?: Hume.empathicVoice.Tool[];
-    /** List of builtin tools to enable. */
+    /**
+     * List of built-in tools to enable for the session.
+     *
+     * Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our [Tool Use Guide](/docs/empathic-voice-interface-evi/tool-use).
+     *
+     * Currently, the only built-in tool Hume provides is **Web Search**. When enabled, Web Search equips EVI with the ability to search the web for up-to-date information.
+     */
     builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
     metadata?: Record<string, unknown>;
     /** Dynamic values that can be used to populate EVI prompts. */

package/api/resources/empathicVoice/types/Tool.d.ts

@@ -3,14 +3,18 @@
  */
 import * as Hume from "../../../index";
 export interface Tool {
-    /** Type of tool. */
+    /** Type of tool. Set to `function` for user-defined tools. */
     type: Hume.empathicVoice.ToolType;
-    /** Name of the tool. */
+    /** Name of the user-defined tool to be enabled. */
     name: string;
-    /** Parameters of the tool. Is a stringified JSON schema. */
+    /**
+     * Parameters of the tool. Is a stringified JSON schema.
+     *
+     * These parameters define the inputs needed for the tool’s execution, including the expected data type and description for each input field. Structured as a JSON schema, this format ensures the tool receives data in the expected format.
+     */
     parameters: string;
-    /** Description of the function. */
+    /** An optional description of what the tool does, used by the supplemental LLM to choose when and how to call the function. */
     description?: string;
-    /** Fallback content of the tool, passed to the LLM if the function call response fails. */
+    /** Optional text passed to the supplemental LLM if the tool call fails. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation. */
     fallbackContent?: string;
 }

package/api/resources/empathicVoice/types/ToolCallMessage.d.ts

@@ -8,16 +8,28 @@ import * as Hume from "../../../index";
 export interface ToolCallMessage {
     /** Name of the tool called. */
     name: string;
-    /** Parameters of the tool call. Is a stringified JSON schema. */
+    /**
+     * Parameters of the tool.
+     *
+     * These parameters define the inputs needed for the tool’s execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the tool receives data in the expected format.
+     */
     parameters: string;
-    /** ID of the tool call. */
+    /**
+     * The unique identifier for a specific tool call instance.
+     *
+     * This ID is used to track the request and response of a particular tool invocation, ensuring that the correct response is linked to the appropriate request.
+     */
     toolCallId: string;
-    /** The type of message sent through the socket; for a Tool Call message, this must be `tool_call`. */
+    /**
+     * The type of message sent through the socket; for a Tool Call message, this must be `tool_call`.
+     *
+     * This message indicates that the supplemental LLM has detected a need to invoke the specified tool.
+     */
     type: "tool_call";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Type of tool called, either 'builtin' or 'function'. */
+    /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
     toolType?: Hume.empathicVoice.ToolType;
-    /** Whether a response is required from the developer. */
+    /** Indicates whether a response to the tool call is required from the developer, either in the form of a [Tool Response message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Response%20Message.type) or a [Tool Error message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Error%20Message.type). */
     responseRequired: boolean;
 }

package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts

@@ -6,20 +6,28 @@ import * as Hume from "../../../index";
  * When provided, the output is a function call error.
  */
 export interface ToolErrorMessage {
-    /** The type of message sent through the socket; for a Tool Error message, this must be `tool_error`. */
+    /**
+     * The type of message sent through the socket; for a Tool Error message, this must be `tool_error`.
+     *
+     * Upon receiving a [Tool Call message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+     */
     type: "tool_error";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Type of tool called, either 'builtin' or 'function'. */
+    /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
     toolType?: Hume.empathicVoice.ToolType;
-    /** ID of the tool call. */
+    /**
+     * The unique identifier for a specific tool call instance.
+     *
+     * This ID is used to track the request and response of a particular tool invocation, ensuring that the Tool Error message is linked to the appropriate tool call request. The specified `tool_call_id` must match the one received in the [Tool Call message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type).
+     */
     toolCallId: string;
-    /** The content passed to the LLM in place of the tool response. */
+    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the tool errors. */
     content?: string;
     /** Error message from the tool call, not exposed to the LLM or user. */
     error: string;
-    /** Error code. */
+    /** Error code. Identifies the type of error encountered. */
     code?: string;
-    /** Error level. */
+    /** Indicates the severity of an error; for a Tool Error message, this must be `warn` to signal an unexpected event. */
     level?: Hume.empathicVoice.ErrorLevel;
 }

package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts

@@ -6,14 +6,28 @@ import * as Hume from "../../../index";
  * When provided, the output is a function call response.
  */
 export interface ToolResponseMessage {
-    /** The type of message sent through the socket; for a Tool Response message, this must be `tool_response`. */
+    /**
+     * The type of message sent through the socket; for a Tool Response message, this must be `tool_response`.
+     *
+     * Upon receiving a [Tool Call message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type) and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+     */
     type: "tool_response";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** ID of the tool call. */
+    /**
+     * The unique identifier for a specific tool call instance.
+     *
+     * This ID is used to track the request and response of a particular tool invocation, ensuring that the correct response is linked to the appropriate request. The specified `tool_call_id` must match the one received in the [Tool Call message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.tool_call_id).
+     */
     toolCallId: string;
-    /** Return value of the tool call. */
+    /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */
     content: string;
+    /**
+     * Name of the tool.
+     *
+     * Include this optional field to help the supplemental LLM identify which tool generated the response. The specified `tool_name` must match the one received in the [Tool Call message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type).
+     */
     toolName?: string;
+    /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
     toolType?: Hume.empathicVoice.ToolType;
 }

package/api/resources/empathicVoice/types/UserInput.d.ts

@@ -5,10 +5,14 @@
  * User text to insert into the conversation.
  */
 export interface UserInput {
-    /** The type of message sent through the socket; for a User Input message, this must be `user_input`. */
+    /** The type of message sent through the socket; must be `user_input` for our server to correctly identify and process it as a User Input message. */
     type: "user_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** User text to insert into the conversation. */
+    /**
+     * User text to insert into the conversation. Text sent through a User Input message is treated as the user’s speech to EVI. EVI processes this input and provides a corresponding response.
+     *
+     * Expression measurement results are not available for User Input messages, as the prosody model relies on audio input and cannot process text alone.
+     */
     text: string;
 }

package/api/resources/empathicVoice/types/UserInterruption.d.ts

@@ -5,7 +5,11 @@
  * When provided, the output is an interruption.
  */
 export interface UserInterruption {
-    /** The type of message sent through the socket; for a User Interruption message, this must be `user_interruption`. */
+    /**
+     * The type of message sent through the socket; for a User Interruption message, this must be `user_interruption`.
+     *
+     * This message indicates the user has interrupted the assistant’s response. EVI detects the interruption in real-time and sends this message to signal the interruption event. This message allows the system to stop the current audio playback, clear the audio queue, and prepare to handle new user input.
+     */
     type: "user_interruption";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;

package/api/resources/empathicVoice/types/UserMessage.d.ts

@@ -6,7 +6,11 @@ import * as Hume from "../../../index";
  * When provided, the output is a user message.
  */
 export interface UserMessage {
-    /** The type of message sent through the socket; for a User message, this must be `user_message`. */
+    /**
+     * The type of message sent through the socket; for a User Message, this must be `user_message`.
+     *
+     * This message contains both a transcript of the user’s input and the expression measurement predictions if the input was sent as an [Audio Input message](/reference/empathic-voice-interface-evi/chat/chat#send.Audio%20Input.type). Expression measurement predictions are not provided for a [User Input message](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.type), as the prosody model relies on audio input and cannot process text alone.
+     */
     type: "user_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
@@ -16,6 +20,6 @@ export interface UserMessage {
     models: Hume.empathicVoice.Inference;
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
-    /** Indicates if this message was constructed from a text input message. */
+    /** Indicates if this message was inserted into the conversation as text from a [User Input](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.text) message. */
     fromText: boolean;
 }

package/api/resources/empathicVoice/types/WebSocketError.d.ts

@@ -5,14 +5,18 @@
  * When provided, the output is an error message.
  */
 export interface WebSocketError {
-    /** The type of message sent through the socket; for a Web Socket Error message, this must be `error`. */
+    /**
+     * The type of message sent through the socket; for a Web Socket Error message, this must be `error`.
+     *
+     * This message indicates a disruption in the WebSocket connection, such as an unexpected disconnection, protocol error, or data transmission issue.
+     */
     type: "error";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Error code. */
+    /** Error code. Identifies the type of error encountered. */
     code: string;
-    /** Error slug. */
+    /** Short, human-readable identifier and description for the error. See a complete list of error slugs on the [Errors page](/docs/resources/errors). */
     slug: string;
-    /** Error message. */
+    /** Detailed description of the error. */
     message: string;
 }

package/api/resources/empathicVoice/types/index.d.ts

@@ -10,6 +10,8 @@ export * from "./PostedLanguageModelModelProvider";
 export * from "./PostedLanguageModel";
 export * from "./PostedPromptSpec";
 export * from "./PostedTimeoutSpec";
+export * from "./PostedTimeoutSpecsInactivity";
+export * from "./PostedTimeoutSpecsMaxDuration";
 export * from "./PostedTimeoutSpecs";
 export * from "./PostedUserDefinedToolSpec";
 export * from "./PostedVoiceName";
@@ -73,6 +75,7 @@ export * from "./Role";
 export * from "./ToolCallMessage";
 export * from "./UserInterruption";
 export * from "./UserMessage";
+export * from "./JsonMessage";
 export * from "./TtsInput";
 export * from "./TextInput";
 export * from "./FunctionCallResponseInput";

package/api/resources/empathicVoice/types/index.js

@@ -26,6 +26,8 @@ __exportStar(require("./PostedLanguageModelModelProvider"), exports);
 __exportStar(require("./PostedLanguageModel"), exports);
 __exportStar(require("./PostedPromptSpec"), exports);
 __exportStar(require("./PostedTimeoutSpec"), exports);
+__exportStar(require("./PostedTimeoutSpecsInactivity"), exports);
+__exportStar(require("./PostedTimeoutSpecsMaxDuration"), exports);
 __exportStar(require("./PostedTimeoutSpecs"), exports);
 __exportStar(require("./PostedUserDefinedToolSpec"), exports);
 __exportStar(require("./PostedVoiceName"), exports);
@@ -89,6 +91,7 @@ __exportStar(require("./Role"), exports);
 __exportStar(require("./ToolCallMessage"), exports);
 __exportStar(require("./UserInterruption"), exports);
 __exportStar(require("./UserMessage"), exports);
+__exportStar(require("./JsonMessage"), exports);
 __exportStar(require("./TtsInput"), exports);
 __exportStar(require("./TextInput"), exports);
 __exportStar(require("./FunctionCallResponseInput"), exports);

package/dist/api/resources/empathicVoice/resources/chat/client/Client.d.ts

@@ -6,12 +6,18 @@ export declare namespace Chat {
         accessToken?: core.Supplier<string | undefined>;
     }
     interface ConnectArgs {
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
         /** The ID of the configuration. */
         configId?: string;
         /** The version of the configuration. */
         configVersion?: string;
         /** The ID of a chat group, used to resume a previous chat. */
         resumedChatGroupId?: string;
+        /** Extra query parameters sent at WebSocket connection */
+        queryParams?: Record<string, string | string[] | object | object[]>;
     }
 }
 export declare class Chat {

package/dist/api/resources/empathicVoice/resources/chat/client/Client.js

@@ -35,6 +35,7 @@ class Chat {
         this._options = _options;
     }
     connect(args = {}) {
+        var _a;
         const queryParams = {};
         if (this._options.accessToken != null) {
             queryParams["accessToken"] = core.Supplier.get(this._options.accessToken);
@@ -51,7 +52,16 @@ class Chat {
         if (args.resumedChatGroupId != null) {
             queryParams["resumed_chat_group_id"] = args.resumedChatGroupId;
         }
-        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`);
+        if (args.queryParams != null) {
+            for (const [name, value] of Object.entries(args.queryParams)) {
+                queryParams[name] = value;
+            }
+        }
+        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`, [], {
+            startClosed: true,
+            debug: (_a = args.debug) !== null && _a !== void 0 ? _a : false,
+            maxRetries: args.reconnectAttempts,
+        });
         return new Socket_1.ChatSocket({
             socket,
         });

package/dist/api/resources/empathicVoice/resources/chat/client/Socket.d.ts

@@ -64,10 +64,17 @@ export declare class ChatSocket {
      * Send text input
      */
     sendUserInput(text: string): void;
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect(): ChatSocket;
     /**
      * Closes the underlying socket.
      */
     close(): void;
+    private assertSocketIsOpen;
     private sendJson;
     private handleOpen;
     private handleMessage;

package/dist/api/resources/empathicVoice/resources/chat/client/Socket.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatSocket = void 0;
+const errors = __importStar(require("../../../../../../errors"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 class ChatSocket {
     constructor({ socket }) {
@@ -83,63 +84,93 @@ class ChatSocket {
      * Send audio input
      */
     sendAudioInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "audio_input" }, message));
     }
     /**
      * Send session settings
      */
     sendSessionSettings(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "session_settings" }, message));
     }
     /**
      * Send assistant input
      */
     sendAssistantInput(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "assistant_input" }, message));
     }
     /**
      * Send pause assistant message
      */
     pauseAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "pause_assistant_message" }, message));
     }
     /**
      * Send resume assistant message
      */
     resumeAssistant(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "resume_assistant_message" }, message));
     }
     /**
      * Send tool response message
      */
     sendToolResponseMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_response" }, message));
     }
     /**
      * Send tool error message
      */
     sendToolErrorMessage(message) {
+        this.assertSocketIsOpen();
         this.sendJson(Object.assign({ type: "tool_error" }, message));
     }
     /**
      * Send text input
      */
     sendUserInput(text) {
+        this.assertSocketIsOpen();
         this.sendJson({
             type: "user_input",
             text,
         });
     }
+    /**
+     * @name connect
+     * @description
+     * Connect to the websocket.
+     */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener('open', this.handleOpen);
+        this.socket.addEventListener('message', this.handleMessage);
+        this.socket.addEventListener('close', this.handleClose);
+        this.socket.addEventListener('error', this.handleError);
+        return this;
+    }
     /**
      * Closes the underlying socket.
      */
     close() {
         this.socket.close();
+        this.handleClose({ code: 1000 });
         this.socket.removeEventListener('open', this.handleOpen);
         this.socket.removeEventListener('message', this.handleMessage);
         this.socket.removeEventListener('close', this.handleClose);
         this.socket.removeEventListener('error', this.handleError);
     }
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new errors.HumeError({ message: 'Socket is not connected.' });
+        }
+        if (this.socket.readyState !== WebSocket.OPEN) {
+            throw new errors.HumeError({ message: 'Socket is not open.' });
+        }
+    }
     sendJson(payload) {
         const jsonPayload = serializers.empathicVoice.PublishEvent.jsonOrThrow(payload, {
             unrecognizedObjectKeys: "strip",

package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts

@@ -22,4 +22,5 @@ export interface PostedConfig {
     /** Built-in tool specification for a Config. */
     builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
+    timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
 }

package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts

@@ -18,4 +18,5 @@ export interface PostedConfigVersion {
     /** Built-in tool specification for a Config. */
     builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
+    timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
 }

package/dist/api/resources/empathicVoice/types/AssistantEnd.d.ts

@@ -5,7 +5,11 @@
  * When provided, the output is an assistant end message.
  */
 export interface AssistantEnd {
-    /** The type of message sent through the socket; for an Assistant End message, this must be `assistant_end`. */
+    /**
+     * The type of message sent through the socket; for an Assistant End message, this must be `assistant_end`.
+     *
+     * This message indicates the conclusion of the assistant’s response, signaling that the assistant has finished speaking for the current conversational turn.
+     */
     type: "assistant_end";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;

package/dist/api/resources/empathicVoice/types/AssistantInput.d.ts

@@ -5,10 +5,14 @@
  * When provided, the input is spoken by EVI.
  */
 export interface AssistantInput {
-    /** The type of message sent through the socket; for an Assistant Input message, this must be `assistant_input`. */
+    /** The type of message sent through the socket; must be `assistant_input` for our server to correctly identify and process it as an Assistant Input message. */
     type: "assistant_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Text to be synthesized. */
+    /**
+     * Assistant text to synthesize into spoken audio and insert into the conversation.
+     *
+     * EVI uses this text to generate spoken audio using our proprietary expressive text-to-speech model. Our model adds appropriate emotional inflections and tones to the text based on the user’s expressions and the context of the conversation. The synthesized audio is streamed back to the user as an [Assistant Message](/reference/empathic-voice-interface-evi/chat/chat#receive.Assistant%20Message.type).
+     */
     text: string;
 }