hume 0.15.5 → 0.15.7

package/dist/cjs/Client.js

@@ -45,8 +45,8 @@ class HumeClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "hume",
-                "X-Fern-SDK-Version": "0.15.5",
-                "User-Agent": "hume/0.15.5",
+                "X-Fern-SDK-Version": "0.15.7",
+                "User-Agent": "hume/0.15.7",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.js

@@ -183,8 +183,11 @@ class ChatGroups {
     __getChatGroup(id_1) {
         return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { pageSize, pageNumber, ascendingOrder } = request;
+            const { status, pageSize, pageNumber, ascendingOrder } = request;
             const _queryParams = {};
+            if (status != null) {
+                _queryParams.status = status;
+            }
             if (pageSize != null) {
                 _queryParams.page_size = pageSize.toString();
             }

package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.ts

@@ -7,6 +7,8 @@
  *     }
  */
 export interface ChatGroupsGetChatGroupRequest {
+    /** Chat status to apply to the chat. String from the ChatStatus enum. */
+    status?: string;
     /**
      * Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
      *

package/dist/cjs/api/resources/empathicVoice/resources/chats/client/Client.js

@@ -73,7 +73,7 @@ class Chats {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { pageNumber, pageSize, ascendingOrder, configId } = request;
+                const { pageNumber, pageSize, ascendingOrder, configId, status } = request;
                 const _queryParams = {};
                 if (pageNumber != null) {
                     _queryParams.page_number = pageNumber.toString();
@@ -87,6 +87,9 @@ class Chats {
                 if (configId != null) {
                     _queryParams.config_id = configId;
                 }
+                if (status != null) {
+                    _queryParams.status = status;
+                }
                 const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
                 const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                     url: core.url.join((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.HumeEnvironment.Prod)

package/dist/cjs/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.ts

@@ -23,4 +23,6 @@ export interface ChatsListChatsRequest {
     ascendingOrder?: boolean;
     /** Filter to only include chats that used this config. */
     configId?: string;
+    /** Chat status to apply to the chat. String from the ChatStatus enum. */
+    status?: string;
 }

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

@@ -1,5 +1,5 @@
 /**
- * When provided, the output is an assistant end message.
+ * **Indicates the conclusion of the assistant's response**, signaling that the assistant has finished speaking for the current conversational turn.
  */
 export interface AssistantEnd {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the input is spoken by EVI.
+ * **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.
  */
 export interface AssistantInput {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

package/dist/cjs/api/resources/empathicVoice/types/AssistantMessage.d.ts

@@ -1,6 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is an assistant message.
+ * **Transcript of the assistant's message.** Contains the message role, content, and optionally tool call information including the tool name, parameters, response requirement status, tool call ID, and tool type.
  */
 export interface AssistantMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
@@ -9,6 +9,8 @@ export interface AssistantMessage {
     fromText: boolean;
     /** ID of the assistant message. Allows the Assistant Message to be tracked and referenced. */
     id?: string;
+    /** Indicates if this message is a quick response or not. */
+    isQuickResponse: boolean;
     /** Detected language of the message text. */
     language?: string;
     /** Transcript of the message. */

package/dist/cjs/api/resources/empathicVoice/types/AssistantProsody.d.ts

@@ -1,6 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is an Assistant Prosody message.
+ * **Expression measurement predictions of the assistant's audio output.** Contains inference model results including prosody scores for 48 emotions within the detected expression of the assistant's audio sample.
  */
 export interface AssistantProsody {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

package/dist/cjs/api/resources/empathicVoice/types/AudioInput.d.ts

@@ -1,5 +1,7 @@
 /**
- * When provided, the input is audio.
+ * **Base64 encoded audio input to insert into the conversation.** The content is treated as the user's speech to EVI and must be streamed continuously. Pre-recorded audio files are not supported.
+ *
+ * For optimal transcription quality, the audio data should be transmitted in small chunks. Hume recommends streaming audio with a buffer window of `20` milliseconds (ms), or `100` milliseconds (ms) for web applications. See our [Audio Guide](/docs/speech-to-speech-evi/guides/audio) for more details on preparing and processing audio.
  */
 export interface AudioInput {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
@@ -14,10 +16,6 @@ export interface AudioInput {
      * Hume recommends streaming audio with a buffer window of 20 milliseconds (ms), or 100 milliseconds (ms) for web applications.
      */
     data: string;
-    /**
-     * The type of message sent through the socket; must be `audio_input` for our server to correctly identify and process it as an Audio Input message.
-     *
-     * This message is used for sending audio input data to EVI for processing and expression measurement. Audio data should be sent as a continuous stream, encoded in Base64.
-     */
+    /** The type of message sent through the socket; must be `audio_input` for our server to correctly identify and process it as an Audio Input message. */
     type: "audio_input";
 }

package/dist/cjs/api/resources/empathicVoice/types/AudioOutput.d.ts

@@ -1,5 +1,7 @@
 /**
- * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`.
+ * **Base64 encoded audio output.** This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction. The returned audio format is WAV and the sample rate is 48kHz.
+ *
+ * Contains the audio data, an ID to track and reference the audio output, and an index indicating the chunk position relative to the whole audio segment. See our [Audio Guide](/docs/speech-to-speech-evi/guides/audio) for more details on preparing and processing audio.
  */
 export interface AudioOutput {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

package/dist/cjs/api/resources/empathicVoice/types/ChatMetadata.d.ts

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is a chat metadata message.
+ * **The first message received after establishing a connection with EVI**, containing important identifiers for the current Chat session.
+ *
+ * Includes the Chat ID (which allows the Chat session to be tracked and referenced) and the Chat Group ID (used to resume a Chat when passed in the `resumed_chat_group_id` query parameter of a subsequent connection request, allowing EVI to continue the conversation from where it left off within the Chat Group).
  */
 export interface ChatMetadata {
     /**

package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettings.d.ts

@@ -34,14 +34,16 @@ export interface ConnectSessionSettings {
      * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     systemPrompt?: string;
+    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this EVI session. This will override the speaker set in the selected configuration. */
+    voiceId?: string;
     /**
      * This field allows you to assign values to dynamic variables referenced in your system prompt.
      *
      * Each key represents the variable name, and the corresponding value is the specific content you wish to assign to that variable within the session. While the values for variables can be strings, numbers, or booleans, the value will ultimately be converted to a string when injected into your system prompt.
      *
+     * When used in query parameters, specify each variable using bracket notation: `session_settings[variables][key]=value`. For example: `session_settings[variables][name]=John&session_settings[variables][age]=30`.
+     *
      * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/speech-to-speech-evi/features/dynamic-variables).
      */
     variables?: Record<string, Hume.empathicVoice.ConnectSessionSettingsVariablesValue>;
-    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this EVI session. This will override the speaker set in the selected configuration. */
-    voiceId?: string;
 }

package/dist/cjs/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.ts

@@ -1,25 +1,37 @@
 import type * as Hume from "../../../index.js";
 export type ControlPlanePublishEvent = 
 /**
- * Settings for this chat session. */
+ * **Settings for this chat session.** 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. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings. */
 Hume.empathicVoice.SessionSettings
 /**
- * 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.
+ * **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. */
  | Hume.empathicVoice.UserInput
 /**
- * When provided, the input is spoken by EVI. */
+ * **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. */
  | Hume.empathicVoice.AssistantInput
 /**
- * When provided, the output is a function call response. */
+ * **Return value of the tool call.** Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage`. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolResponseMessage
 /**
- * When provided, the output is a function call error. */
+ * **Error message from the tool call**, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage` if the tool fails. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolErrorMessage
 /**
- * Pause responses from EVI. Chat history is still saved and sent after resuming.  */
+ * **Pause responses from EVI.** Chat history is still saved and sent after resuming. Once this message is sent, EVI will not respond until a Resume Assistant message is sent.
+ *
+ * When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details. */
  | Hume.empathicVoice.PauseAssistantMessage
 /**
- * Resume responses from EVI. Chat history sent while paused will now be sent.  */
+ * **Resume responses from EVI.** Chat history sent while paused will now be sent.
+ *
+ * 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. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details. */
  | Hume.empathicVoice.ResumeAssistantMessage;

package/dist/cjs/api/resources/empathicVoice/types/JsonMessage.d.ts

@@ -1,32 +1,51 @@
 import type * as Hume from "../../../index.js";
 export type JsonMessage = 
 /**
- * When provided, the output is an assistant end message. */
+ * **Indicates the conclusion of the assistant's response**, signaling that the assistant has finished speaking for the current conversational turn. */
 Hume.empathicVoice.AssistantEnd
 /**
- * When provided, the output is an assistant message. */
+ * **Transcript of the assistant's message.** Contains the message role, content, and optionally tool call information including the tool name, parameters, response requirement status, tool call ID, and tool type. */
  | Hume.empathicVoice.AssistantMessage
 /**
- * When provided, the output is an Assistant Prosody message. */
+ * **Expression measurement predictions of the assistant's audio output.** Contains inference model results including prosody scores for 48 emotions within the detected expression of the assistant's audio sample. */
  | Hume.empathicVoice.AssistantProsody
 /**
- * When provided, the output is a chat metadata message. */
+ * **The first message received after establishing a connection with EVI**, containing important identifiers for the current Chat session.
+ *
+ * Includes the Chat ID (which allows the Chat session to be tracked and referenced) and the Chat Group ID (used to resume a Chat when passed in the `resumed_chat_group_id` query parameter of a subsequent connection request, allowing EVI to continue the conversation from where it left off within the Chat Group). */
  | Hume.empathicVoice.ChatMetadata
 /**
- * When provided, the output is an error message. */
+ * **Indicates a disruption in the WebSocket connection**, such as an unexpected disconnection, protocol error, or data transmission issue.
+ *
+ * Contains an error code identifying the type of error encountered, a detailed description of the error, and a short, human-readable identifier and description (slug) for the error. */
  | Hume.empathicVoice.WebSocketError
 /**
- * When provided, the output is an interruption. */
+ * **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. Contains a Unix timestamp of when the user interruption was detected. For more details, see our [Interruptibility Guide](/docs/speech-to-speech-evi/features/interruptibility) */
  | Hume.empathicVoice.UserInterruption
 /**
- * When provided, the output is a user message. */
+ * **Transcript of the user's message.** Contains the message role and content, along with a `from_text` field indicating if this message was inserted into the conversation as text from a `UserInput` message.
+ *
+ * Includes an `interim` field indicating whether the transcript is provisional (words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed) or final and complete. Interim transcripts are only sent when the `verbose_transcription` query parameter is set to true in the initial handshake. */
  | Hume.empathicVoice.UserMessage
 /**
- * When provided, the output is a tool call. */
+ * **Indicates that the supplemental LLM has detected a need to invoke the specified tool.** This message is only received for user-defined function tools.
+ *
+ * Contains the tool name, parameters (as a stringified JSON schema), whether a response is required from the developer (either in the form of a `ToolResponseMessage` or a `ToolErrorMessage`), the unique tool call ID for tracking the request and response, and the tool type. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolCallMessage
 /**
- * When provided, the output is a function call response. */
+ * **Return value of the tool call.** Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage`. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolResponseMessage
 /**
- * When provided, the output is a function call error. */
- | Hume.empathicVoice.ToolErrorMessage;
+ * **Error message from the tool call**, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage` if the tool fails. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
+ | Hume.empathicVoice.ToolErrorMessage
+/**
+ * **Settings for this chat session.** 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. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings. */
+ | Hume.empathicVoice.SessionSettings;

package/dist/cjs/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts

@@ -1,5 +1,7 @@
 /**
- * Pause responses from EVI. Chat history is still saved and sent after resuming.
+ * **Pause responses from EVI.** Chat history is still saved and sent after resuming. Once this message is sent, EVI will not respond until a Resume Assistant message is sent.
+ *
+ * When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details.
  */
 export interface PauseAssistantMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * Resume responses from EVI. Chat history sent while paused will now be sent.
+ * **Resume responses from EVI.** Chat history sent while paused will now be sent.
+ *
+ * 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. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details.
  */
 export interface ResumeAssistantMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Settings for this chat session.
+ * **Settings for this chat session.** 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. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings.
  */
 export interface SessionSettings {
     /**

package/dist/cjs/api/resources/empathicVoice/types/SubscribeEvent.d.ts

@@ -1,35 +1,56 @@
 import type * as Hume from "../../../index.js";
 export type SubscribeEvent = 
 /**
- * When provided, the output is an assistant end message. */
+ * **Indicates the conclusion of the assistant's response**, signaling that the assistant has finished speaking for the current conversational turn. */
 Hume.empathicVoice.AssistantEnd
 /**
- * When provided, the output is an assistant message. */
+ * **Transcript of the assistant's message.** Contains the message role, content, and optionally tool call information including the tool name, parameters, response requirement status, tool call ID, and tool type. */
  | Hume.empathicVoice.AssistantMessage
 /**
- * When provided, the output is an Assistant Prosody message. */
+ * **Expression measurement predictions of the assistant's audio output.** Contains inference model results including prosody scores for 48 emotions within the detected expression of the assistant's audio sample. */
  | Hume.empathicVoice.AssistantProsody
 /**
- * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */
+ * **Base64 encoded audio output.** This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction. The returned audio format is WAV and the sample rate is 48kHz.
+ *
+ * Contains the audio data, an ID to track and reference the audio output, and an index indicating the chunk position relative to the whole audio segment. See our [Audio Guide](/docs/speech-to-speech-evi/guides/audio) for more details on preparing and processing audio. */
  | Hume.empathicVoice.AudioOutput
 /**
- * When provided, the output is a chat metadata message. */
+ * **The first message received after establishing a connection with EVI**, containing important identifiers for the current Chat session.
+ *
+ * Includes the Chat ID (which allows the Chat session to be tracked and referenced) and the Chat Group ID (used to resume a Chat when passed in the `resumed_chat_group_id` query parameter of a subsequent connection request, allowing EVI to continue the conversation from where it left off within the Chat Group). */
  | Hume.empathicVoice.ChatMetadata
 /**
- * When provided, the output is an error message. */
+ * **Indicates a disruption in the WebSocket connection**, such as an unexpected disconnection, protocol error, or data transmission issue.
+ *
+ * Contains an error code identifying the type of error encountered, a detailed description of the error, and a short, human-readable identifier and description (slug) for the error. */
  | Hume.empathicVoice.WebSocketError
 /**
- * When provided, the output is an interruption. */
+ * **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. Contains a Unix timestamp of when the user interruption was detected. For more details, see our [Interruptibility Guide](/docs/speech-to-speech-evi/features/interruptibility) */
  | Hume.empathicVoice.UserInterruption
 /**
- * When provided, the output is a user message. */
+ * **Transcript of the user's message.** Contains the message role and content, along with a `from_text` field indicating if this message was inserted into the conversation as text from a `UserInput` message.
+ *
+ * Includes an `interim` field indicating whether the transcript is provisional (words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed) or final and complete. Interim transcripts are only sent when the `verbose_transcription` query parameter is set to true in the initial handshake. */
  | Hume.empathicVoice.UserMessage
 /**
- * When provided, the output is a tool call. */
+ * **Indicates that the supplemental LLM has detected a need to invoke the specified tool.** This message is only received for user-defined function tools.
+ *
+ * Contains the tool name, parameters (as a stringified JSON schema), whether a response is required from the developer (either in the form of a `ToolResponseMessage` or a `ToolErrorMessage`), the unique tool call ID for tracking the request and response, and the tool type. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolCallMessage
 /**
- * When provided, the output is a function call response. */
+ * **Return value of the tool call.** Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage`. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
  | Hume.empathicVoice.ToolResponseMessage
 /**
- * When provided, the output is a function call error. */
- | Hume.empathicVoice.ToolErrorMessage;
+ * **Error message from the tool call**, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage` if the tool fails. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details. */
+ | Hume.empathicVoice.ToolErrorMessage
+/**
+ * **Settings for this chat session.** 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. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings. */
+ | Hume.empathicVoice.SessionSettings;

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a function call error.
+ * **Error message from the tool call**, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage` if the tool fails. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details.
  */
 export interface ToolErrorMessage {
     /** Error code. Identifies the type of error encountered. */

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a function call response.
+ * **Return value of the tool call.** Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage`. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details.
  */
 export interface ToolResponseMessage {
     /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */

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

@@ -1,16 +1,12 @@
 /**
- * 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.
+ * **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.
  */
 export interface UserInput {
     /** 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. 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.
-     */
+    /** 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. */
     text: string;
     /** 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";

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is an interruption.
+ * **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. Contains a Unix timestamp of when the user interruption was detected. For more details, see our [Interruptibility Guide](/docs/speech-to-speech-evi/features/interruptibility)
  */
 export interface UserInterruption {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a user message.
+ * **Transcript of the user's message.** Contains the message role and content, along with a `from_text` field indicating if this message was inserted into the conversation as text from a `UserInput` message.
+ *
+ * Includes an `interim` field indicating whether the transcript is provisional (words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed) or final and complete. Interim transcripts are only sent when the `verbose_transcription` query parameter is set to true in the initial handshake.
  */
 export interface UserMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is an error message.
+ * **Indicates a disruption in the WebSocket connection**, such as an unexpected disconnection, protocol error, or data transmission issue.
+ *
+ * Contains an error code identifying the type of error encountered, a detailed description of the error, and a short, human-readable identifier and description (slug) for the error.
  */
 export interface WebSocketError {
     /** Error code. Identifies the type of error encountered. */

package/dist/cjs/api/resources/tts/client/requests/ConvertVoiceFileRequest.d.ts

@@ -9,6 +9,6 @@ export interface ConvertVoiceFileRequest {
     voice?: Hume.tts.PostedUtteranceVoice;
     /** Specifies the output audio file format. */
     format?: Hume.tts.Format;
-    /** The set of timestamp types to include in the response. */
+    /** The set of timestamp types to include in the response. When used in multipart/form-data, specify each value using bracket notation: `include_timestamp_types[0]=word&include_timestamp_types[1]=phoneme`. Only supported for Octave 2 requests. */
     includeTimestampTypes?: Hume.tts.TimestampType[];
 }

package/dist/cjs/api/resources/tts/client/requests/ConvertVoiceJsonRequest.d.ts

@@ -13,6 +13,6 @@ export interface ConvertVoiceJsonRequest {
     voice?: Hume.tts.PostedUtteranceVoice;
     /** Specifies the output audio file format. */
     format?: Hume.tts.Format;
-    /** The set of timestamp types to include in the response. */
+    /** The set of timestamp types to include in the response. When used in multipart/form-data, specify each value using bracket notation: `include_timestamp_types[0]=word&include_timestamp_types[1]=phoneme`. Only supported for Octave 2 requests. */
     includeTimestampTypes?: Hume.tts.TimestampType[];
 }

package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts

@@ -57,5 +57,5 @@ export declare class Voices {
      */
     delete(request: Hume.tts.VoicesDeleteRequest, requestOptions?: Voices.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | null | undefined>>;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }

package/dist/cjs/api/resources/tts/resources/voices/client/Client.js

@@ -71,7 +71,7 @@ class Voices {
         return __awaiter(this, void 0, void 0, function* () {
             const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-                const { provider, pageNumber, pageSize, ascendingOrder } = request;
+                const { provider, pageNumber, pageSize, ascendingOrder, filterTag } = request;
                 const _queryParams = {};
                 _queryParams.provider = serializers.tts.VoiceProvider.jsonOrThrow(provider, {
                     unrecognizedObjectKeys: "strip",
@@ -86,6 +86,14 @@ class Voices {
                 if (ascendingOrder != null) {
                     _queryParams.ascending_order = ascendingOrder.toString();
                 }
+                if (filterTag != null) {
+                    if (Array.isArray(filterTag)) {
+                        _queryParams.filter_tag = filterTag.map((item) => item);
+                    }
+                    else {
+                        _queryParams.filter_tag = filterTag;
+                    }
+                }
                 const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
                 const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                     url: core.url.join((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.HumeEnvironment.Prod)
@@ -320,13 +328,8 @@ class Voices {
     }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const apiKeyValue = core.Supplier.get(this._options.apiKey);
-            // This `authHeaderValue` is manually added as if you don't provide it it will
-            // be omitted from the headers which means it won't reach the logic in ws.ts that
-            // extracts values from the headers and adds them to query parameters.
-            const authHeaderValue = core.Supplier.get((_a = this._options.headers) === null || _a === void 0 ? void 0 : _a.authorization);
-            return { "X-Hume-Api-Key": apiKeyValue, Authorization: authHeaderValue };
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "X-Hume-Api-Key": apiKeyValue };
         });
     }
 }

package/dist/cjs/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts

@@ -26,4 +26,5 @@ export interface VoicesListRequest {
      */
     pageSize?: number;
     ascendingOrder?: boolean;
+    filterTag?: string | string[];
 }

package/dist/cjs/serialization/resources/empathicVoice/types/AssistantMessage.d.ts

@@ -9,6 +9,7 @@ export declare namespace AssistantMessage {
         custom_session_id?: string | null;
         from_text: boolean;
         id?: string | null;
+        is_quick_response: boolean;
         language?: string | null;
         message: ChatMessage.Raw;
         models: Inference.Raw;

package/dist/cjs/serialization/resources/empathicVoice/types/AssistantMessage.js

@@ -42,6 +42,7 @@ exports.AssistantMessage = core.serialization.object({
     customSessionId: core.serialization.property("custom_session_id", core.serialization.string().optional()),
     fromText: core.serialization.property("from_text", core.serialization.boolean()),
     id: core.serialization.string().optional(),
+    isQuickResponse: core.serialization.property("is_quick_response", core.serialization.boolean()),
     language: core.serialization.string().optional(),
     message: ChatMessage_js_1.ChatMessage,
     models: Inference_js_1.Inference,

package/dist/cjs/serialization/resources/empathicVoice/types/ConnectSessionSettings.d.ts

@@ -13,7 +13,7 @@ export declare namespace ConnectSessionSettings {
         event_limit?: number | null;
         language_model_api_key?: string | null;
         system_prompt?: string | null;
-        variables?: Record<string, ConnectSessionSettingsVariablesValue.Raw> | null;
         voice_id?: string | null;
+        variables?: Record<string, ConnectSessionSettingsVariablesValue.Raw> | null;
     }
 }

package/dist/cjs/serialization/resources/empathicVoice/types/ConnectSessionSettings.js

@@ -46,6 +46,6 @@ exports.ConnectSessionSettings = core.serialization.object({
     eventLimit: core.serialization.property("event_limit", core.serialization.number().optional()),
     languageModelApiKey: core.serialization.property("language_model_api_key", core.serialization.string().optional()),
     systemPrompt: core.serialization.property("system_prompt", core.serialization.string().optional()),
-    variables: core.serialization.record(core.serialization.string(), ConnectSessionSettingsVariablesValue_js_1.ConnectSessionSettingsVariablesValue).optional(),
     voiceId: core.serialization.property("voice_id", core.serialization.string().optional()),
+    variables: core.serialization.record(core.serialization.string(), ConnectSessionSettingsVariablesValue_js_1.ConnectSessionSettingsVariablesValue).optional(),
 });

package/dist/cjs/serialization/resources/empathicVoice/types/JsonMessage.d.ts

@@ -5,6 +5,7 @@ import { AssistantEnd } from "./AssistantEnd.js";
 import { AssistantMessage } from "./AssistantMessage.js";
 import { AssistantProsody } from "./AssistantProsody.js";
 import { ChatMetadata } from "./ChatMetadata.js";
+import { SessionSettings } from "./SessionSettings.js";
 import { ToolCallMessage } from "./ToolCallMessage.js";
 import { ToolErrorMessage } from "./ToolErrorMessage.js";
 import { ToolResponseMessage } from "./ToolResponseMessage.js";
@@ -13,5 +14,5 @@ import { UserMessage } from "./UserMessage.js";
 import { WebSocketError } from "./WebSocketError.js";
 export declare const JsonMessage: core.serialization.Schema<serializers.empathicVoice.JsonMessage.Raw, Hume.empathicVoice.JsonMessage>;
 export declare namespace JsonMessage {
-    type Raw = AssistantEnd.Raw | AssistantMessage.Raw | AssistantProsody.Raw | ChatMetadata.Raw | WebSocketError.Raw | UserInterruption.Raw | UserMessage.Raw | ToolCallMessage.Raw | ToolResponseMessage.Raw | ToolErrorMessage.Raw;
+    type Raw = AssistantEnd.Raw | AssistantMessage.Raw | AssistantProsody.Raw | ChatMetadata.Raw | WebSocketError.Raw | UserInterruption.Raw | UserMessage.Raw | ToolCallMessage.Raw | ToolResponseMessage.Raw | ToolErrorMessage.Raw | SessionSettings.Raw;
 }