hume 0.13.3 → 0.13.5

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

@@ -37,11 +37,7 @@ import * as Hume from "../../../../../../index";
  *     }
  */
 export interface PostedConfig {
-    /**
-     * Specifies the EVI version to use. See our [EVI Version  Guide](/docs/speech-to-speech-evi/configuration/evi-version) for differences between versions.
-     *
-     * **We're officially sunsetting EVI versions 1 and 2 on August 30, 2025**. To keep things running smoothly, be sure to [migrate to EVI 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3) before then.
-     */
+    /** EVI version to use. Only version `3` is supported. */
     eviVersion: string;
     /** Name applied to all versions of a particular Config. */
     name: string;

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

@@ -12,7 +12,7 @@ export interface AssistantInput {
     /**
      * 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.AssistantMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.AssistantMessage).
      */
     text: string;
 }

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

@@ -20,6 +20,6 @@ export interface AssistantMessage {
     message: Hume.empathicVoice.ChatMessage;
     /** Inference model results. */
     models: Hume.empathicVoice.Inference;
-    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/empathic-voice-interface-evi/chat/chat#send.AssistantInput.text). */
+    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/speech-to-speech-evi/chat#send.AssistantInput.text). */
     fromText: boolean;
 }

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

@@ -16,9 +16,9 @@ export interface ChatMetadata {
     /**
      * ID of the Chat Group.
      *
-     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/empathic-voice-interface-evi/chat/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
+     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/speech-to-speech-evi/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
      *
-     * Learn more about [supporting chat resumability](/docs/empathic-voice-interface-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
+     * Learn more about [supporting chat resumability](/docs/speech-to-speech-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
      */
     chatGroupId: string;
     /** ID of the Chat session. Allows the Chat session to be tracked and referenced. */

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

@@ -8,7 +8,7 @@ export interface PauseAssistantMessage {
     /**
      * The type of message sent through the socket; must be `pause_assistant_message` for our server to correctly identify and process it as a Pause Assistant message.
      *
-     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/empathic-voice-interface-evi/chat/chat#send.ResumeAssistantMessage.type) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
+     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/speech-to-speech-evi/chat#send.ResumeAssistantMessage) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
      */
     type: "pause_assistant_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -11,7 +11,7 @@ export interface SessionSettings {
      *
      * 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 guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+     * For more information, please refer to the [Session Settings guide](/docs/speech-to-speech-evi/configuration/session-settings).
      */
     type: "session_settings";
     /**
@@ -19,7 +19,7 @@ export interface SessionSettings {
      *
      * 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/guides/custom-language-model) with EVI to learn more.
+     * 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/speech-to-speech-evi/guides/custom-language-model) with EVI to learn more.
      */
     customSessionId?: string;
     /**
@@ -29,7 +29,7 @@ export interface SessionSettings {
      *
      * 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/guides/prompting).
+     * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     systemPrompt?: string;
     /**
@@ -43,7 +43,7 @@ export interface SessionSettings {
     /**
      * 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 guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+     * 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 guide](/docs/speech-to-speech-evi/configuration/session-settings).
      */
     audio?: Hume.empathicVoice.AudioConfiguration;
     /**
@@ -55,13 +55,13 @@ export interface SessionSettings {
     /**
      * 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/features/tool-use).
+     * 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/speech-to-speech-evi/features/tool-use).
      */
     tools?: Hume.empathicVoice.Tool[];
     /**
      * 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/features/tool-use).
+     * 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/speech-to-speech-evi/features/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.
      */
@@ -72,7 +72,9 @@ export interface SessionSettings {
      *
      * 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.
      *
-     * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/empathic-voice-interface-evi/features/dynamic-variables).
+     * 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.SessionSettingsVariablesValue>;
+    /** Allows you to change the voice during an active chat. Updating the voice does not affect chat context or conversation history. */
+    voiceId?: string;
 }

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

@@ -30,6 +30,6 @@ export interface ToolCallMessage {
     customSessionId?: string;
     /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
     toolType?: Hume.empathicVoice.ToolType;
-    /** 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.ToolResponseMessage.type) or a [Tool Error message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolErrorMessage.type). */
+    /** Indicates whether a response to the tool call is required from the developer, either in the form of a [Tool Response message](/reference/speech-to-speech-evi/chat#send.ToolResponseMessage) or a [Tool Error message](/reference/speech-to-speech-evi/chat#send.ToolErrorMessage). */
     responseRequired: boolean;
 }

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

@@ -9,7 +9,7 @@ export interface ToolErrorMessage {
     /**
      * 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.ToolCallMessage.type) and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+     * Upon receiving a [Tool Call message](/reference/speech-to-speech-evi/chat#receive.ToolCallMessage) 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. */
@@ -19,7 +19,7 @@ export interface ToolErrorMessage {
     /**
      * 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.ToolCallMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage).
      */
     toolCallId: string;
     /** 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. */

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

@@ -9,7 +9,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.type) and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+     * Upon receiving a [Tool Call message](/reference/speech-to-speech-evi/chat#receive.ToolCallMessage) 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. */
@@ -17,7 +17,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.tool_call_id).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage.tool_call_id).
      */
     toolCallId: string;
     /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */
@@ -25,7 +25,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage).
      */
     toolName?: string;
     /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */

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

@@ -9,7 +9,7 @@ export interface UserMessage {
     /**
      * 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.AudioInput.type). Expression measurement predictions are not provided for a [User Input message](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.type), as the prosody model relies on audio input and cannot process text alone.
+     * 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/speech-to-speech-evi/chat#send.AudioInput). Expression measurement predictions are not provided for a [User Input message](/reference/speech-to-speech-evi/chat#send.UserInput), 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. */
@@ -20,7 +20,7 @@ export interface UserMessage {
     models: Hume.empathicVoice.Inference;
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
-    /** Indicates if this message was inserted into the conversation as text from a [User Input](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.text) message. */
+    /** Indicates if this message was inserted into the conversation as text from a [User Input](/reference/speech-to-speech-evi/chat#send.UserInput.text) message. */
     fromText: boolean;
     /**
      * Indicates whether this `UserMessage` contains an interim (unfinalized) transcript.
@@ -28,7 +28,7 @@ export interface UserMessage {
      * - `true`: the transcript is provisional; words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed.
      * - `false`: the transcript is final and complete.
      *
-     * Interim transcripts are only sent when the [`verbose_transcription`](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription) query parameter is set to `true` in the initial handshake.
+     * Interim transcripts are only sent when the [`verbose_transcription`](/reference/speech-to-speech-evi/chat#request.query.verbose_transcription) query parameter is set to `true` in the initial handshake.
      */
     interim: boolean;
 }

package/api/resources/tts/types/PublishTts.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Input message type for the TTS stream.
+ */
+export interface PublishTts {
+    /** The input text to be converted to speech output. */
+    text?: string;
+    /** Natural language instructions describing how the text should be spoken by the model (e.g., `"a soft, gentle voice with a strong British accent"`). */
+    description?: string;
+    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this and all subsequent utterances, until the `"voice"` field is updated again. */
+    voice?: Hume.tts.PostedUtteranceVoice;
+    /** A relative measure of how fast this utterance should be spoken. */
+    speed?: number;
+    /** Duration of trailing silence (in seconds) to add to this utterance */
+    trailingSilence?: number;
+    /** Force the generation of audio regardless of how much text has been supplied. */
+    flush?: boolean;
+    /** Force the generation of audio and close the stream. */
+    close?: boolean;
+}

package/api/resources/tts/types/PublishTts.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/tts/types/SnippetAudioChunk.d.ts

@@ -2,7 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../../../index";
+/**
+ * Metadata for a chunk of generated audio.
+ */
 export interface SnippetAudioChunk {
+    /** ID of the initiating request. */
+    requestId: string;
     /** The generation ID of the parent snippet that this chunk corresponds to. */
     generationId: string;
     /** The ID of the parent snippet that this chunk corresponds to. */
@@ -21,5 +26,5 @@ export interface SnippetAudioChunk {
     isLastChunk: boolean;
     /** The index of the utterance in the request that the parent snippet of this chunk corresponds to. */
     utteranceIndex?: number;
-    snippet: Hume.tts.Snippet;
+    snippet?: Hume.tts.Snippet;
 }

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

@@ -1,7 +1,13 @@
+export * from "./PublishTts";
+export * from "./PostedUtteranceVoiceWithId";
+export * from "./PostedUtteranceVoiceWithName";
+export * from "./VoiceProvider";
+export * from "./PostedUtteranceVoice";
+export * from "./AudioFormatType";
+export * from "./SnippetAudioChunk";
 export * from "./PostedContextWithGenerationId";
 export * from "./PostedContextWithUtterances";
 export * from "./AudioEncoding";
-export * from "./AudioFormatType";
 export * from "./ReturnGeneration";
 export * from "./HttpValidationError";
 export * from "./FormatMp3";
@@ -12,14 +18,9 @@ export * from "./ReturnTts";
 export * from "./ReturnVoice";
 export * from "./FormatPcm";
 export * from "./Snippet";
-export * from "./SnippetAudioChunk";
 export * from "./PostedUtterance";
 export * from "./ValidationErrorLocItem";
 export * from "./ValidationError";
-export * from "./PostedUtteranceVoiceWithId";
-export * from "./PostedUtteranceVoiceWithName";
-export * from "./VoiceProvider";
-export * from "./PostedUtteranceVoice";
 export * from "./FormatWav";
 export * from "./ErrorResponse";
 export * from "./ReturnPagedVoices";

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

@@ -14,10 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PublishTts"), exports);
+__exportStar(require("./PostedUtteranceVoiceWithId"), exports);
+__exportStar(require("./PostedUtteranceVoiceWithName"), exports);
+__exportStar(require("./VoiceProvider"), exports);
+__exportStar(require("./PostedUtteranceVoice"), exports);
+__exportStar(require("./AudioFormatType"), exports);
+__exportStar(require("./SnippetAudioChunk"), exports);
 __exportStar(require("./PostedContextWithGenerationId"), exports);
 __exportStar(require("./PostedContextWithUtterances"), exports);
 __exportStar(require("./AudioEncoding"), exports);
-__exportStar(require("./AudioFormatType"), exports);
 __exportStar(require("./ReturnGeneration"), exports);
 __exportStar(require("./HttpValidationError"), exports);
 __exportStar(require("./FormatMp3"), exports);
@@ -28,14 +34,9 @@ __exportStar(require("./ReturnTts"), exports);
 __exportStar(require("./ReturnVoice"), exports);
 __exportStar(require("./FormatPcm"), exports);
 __exportStar(require("./Snippet"), exports);
-__exportStar(require("./SnippetAudioChunk"), exports);
 __exportStar(require("./PostedUtterance"), exports);
 __exportStar(require("./ValidationErrorLocItem"), exports);
 __exportStar(require("./ValidationError"), exports);
-__exportStar(require("./PostedUtteranceVoiceWithId"), exports);
-__exportStar(require("./PostedUtteranceVoiceWithName"), exports);
-__exportStar(require("./VoiceProvider"), exports);
-__exportStar(require("./PostedUtteranceVoice"), exports);
 __exportStar(require("./FormatWav"), exports);
 __exportStar(require("./ErrorResponse"), exports);
 __exportStar(require("./ReturnPagedVoices"), exports);

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

@@ -37,11 +37,7 @@ import * as Hume from "../../../../../../index";
  *     }
  */
 export interface PostedConfig {
-    /**
-     * Specifies the EVI version to use. See our [EVI Version  Guide](/docs/speech-to-speech-evi/configuration/evi-version) for differences between versions.
-     *
-     * **We're officially sunsetting EVI versions 1 and 2 on August 30, 2025**. To keep things running smoothly, be sure to [migrate to EVI 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3) before then.
-     */
+    /** EVI version to use. Only version `3` is supported. */
     eviVersion: string;
     /** Name applied to all versions of a particular Config. */
     name: string;

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

@@ -12,7 +12,7 @@ export interface AssistantInput {
     /**
      * 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.AssistantMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.AssistantMessage).
      */
     text: string;
 }

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

@@ -20,6 +20,6 @@ export interface AssistantMessage {
     message: Hume.empathicVoice.ChatMessage;
     /** Inference model results. */
     models: Hume.empathicVoice.Inference;
-    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/empathic-voice-interface-evi/chat/chat#send.AssistantInput.text). */
+    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/speech-to-speech-evi/chat#send.AssistantInput.text). */
     fromText: boolean;
 }

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

@@ -16,9 +16,9 @@ export interface ChatMetadata {
     /**
      * ID of the Chat Group.
      *
-     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/empathic-voice-interface-evi/chat/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
+     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/speech-to-speech-evi/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
      *
-     * Learn more about [supporting chat resumability](/docs/empathic-voice-interface-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
+     * Learn more about [supporting chat resumability](/docs/speech-to-speech-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
      */
     chatGroupId: string;
     /** ID of the Chat session. Allows the Chat session to be tracked and referenced. */

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

@@ -8,7 +8,7 @@ export interface PauseAssistantMessage {
     /**
      * The type of message sent through the socket; must be `pause_assistant_message` for our server to correctly identify and process it as a Pause Assistant message.
      *
-     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/empathic-voice-interface-evi/chat/chat#send.ResumeAssistantMessage.type) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
+     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/speech-to-speech-evi/chat#send.ResumeAssistantMessage) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
      */
     type: "pause_assistant_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -11,7 +11,7 @@ export interface SessionSettings {
      *
      * 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 guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+     * For more information, please refer to the [Session Settings guide](/docs/speech-to-speech-evi/configuration/session-settings).
      */
     type: "session_settings";
     /**
@@ -19,7 +19,7 @@ export interface SessionSettings {
      *
      * 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/guides/custom-language-model) with EVI to learn more.
+     * 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/speech-to-speech-evi/guides/custom-language-model) with EVI to learn more.
      */
     customSessionId?: string;
     /**
@@ -29,7 +29,7 @@ export interface SessionSettings {
      *
      * 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/guides/prompting).
+     * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     systemPrompt?: string;
     /**
@@ -43,7 +43,7 @@ export interface SessionSettings {
     /**
      * 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 guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+     * 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 guide](/docs/speech-to-speech-evi/configuration/session-settings).
      */
     audio?: Hume.empathicVoice.AudioConfiguration;
     /**
@@ -55,13 +55,13 @@ export interface SessionSettings {
     /**
      * 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/features/tool-use).
+     * 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/speech-to-speech-evi/features/tool-use).
      */
     tools?: Hume.empathicVoice.Tool[];
     /**
      * 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/features/tool-use).
+     * 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/speech-to-speech-evi/features/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.
      */
@@ -72,7 +72,9 @@ export interface SessionSettings {
      *
      * 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.
      *
-     * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/empathic-voice-interface-evi/features/dynamic-variables).
+     * 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.SessionSettingsVariablesValue>;
+    /** Allows you to change the voice during an active chat. Updating the voice does not affect chat context or conversation history. */
+    voiceId?: string;
 }

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

@@ -30,6 +30,6 @@ export interface ToolCallMessage {
     customSessionId?: string;
     /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
     toolType?: Hume.empathicVoice.ToolType;
-    /** 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.ToolResponseMessage.type) or a [Tool Error message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolErrorMessage.type). */
+    /** Indicates whether a response to the tool call is required from the developer, either in the form of a [Tool Response message](/reference/speech-to-speech-evi/chat#send.ToolResponseMessage) or a [Tool Error message](/reference/speech-to-speech-evi/chat#send.ToolErrorMessage). */
     responseRequired: boolean;
 }

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

@@ -9,7 +9,7 @@ export interface ToolErrorMessage {
     /**
      * 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.ToolCallMessage.type) and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+     * Upon receiving a [Tool Call message](/reference/speech-to-speech-evi/chat#receive.ToolCallMessage) 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. */
@@ -19,7 +19,7 @@ export interface ToolErrorMessage {
     /**
      * 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.ToolCallMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage).
      */
     toolCallId: string;
     /** 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. */

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

@@ -9,7 +9,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.type) and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+     * Upon receiving a [Tool Call message](/reference/speech-to-speech-evi/chat#receive.ToolCallMessage) 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. */
@@ -17,7 +17,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.tool_call_id).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage.tool_call_id).
      */
     toolCallId: string;
     /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */
@@ -25,7 +25,7 @@ export interface ToolResponseMessage {
     /**
      * 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.ToolCallMessage.type).
+     * 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/speech-to-speech-evi/chat#receive.ToolCallMessage).
      */
     toolName?: string;
     /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */

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

@@ -9,7 +9,7 @@ export interface UserMessage {
     /**
      * 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.AudioInput.type). Expression measurement predictions are not provided for a [User Input message](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.type), as the prosody model relies on audio input and cannot process text alone.
+     * 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/speech-to-speech-evi/chat#send.AudioInput). Expression measurement predictions are not provided for a [User Input message](/reference/speech-to-speech-evi/chat#send.UserInput), 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. */
@@ -20,7 +20,7 @@ export interface UserMessage {
     models: Hume.empathicVoice.Inference;
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
-    /** Indicates if this message was inserted into the conversation as text from a [User Input](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.text) message. */
+    /** Indicates if this message was inserted into the conversation as text from a [User Input](/reference/speech-to-speech-evi/chat#send.UserInput.text) message. */
     fromText: boolean;
     /**
      * Indicates whether this `UserMessage` contains an interim (unfinalized) transcript.
@@ -28,7 +28,7 @@ export interface UserMessage {
      * - `true`: the transcript is provisional; words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed.
      * - `false`: the transcript is final and complete.
      *
-     * Interim transcripts are only sent when the [`verbose_transcription`](/reference/empathic-voice-interface-evi/chat/chat#request.query.verbose_transcription) query parameter is set to `true` in the initial handshake.
+     * Interim transcripts are only sent when the [`verbose_transcription`](/reference/speech-to-speech-evi/chat#request.query.verbose_transcription) query parameter is set to `true` in the initial handshake.
      */
     interim: boolean;
 }

package/dist/api/resources/tts/types/PublishTts.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Input message type for the TTS stream.
+ */
+export interface PublishTts {
+    /** The input text to be converted to speech output. */
+    text?: string;
+    /** Natural language instructions describing how the text should be spoken by the model (e.g., `"a soft, gentle voice with a strong British accent"`). */
+    description?: string;
+    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this and all subsequent utterances, until the `"voice"` field is updated again. */
+    voice?: Hume.tts.PostedUtteranceVoice;
+    /** A relative measure of how fast this utterance should be spoken. */
+    speed?: number;
+    /** Duration of trailing silence (in seconds) to add to this utterance */
+    trailingSilence?: number;
+    /** Force the generation of audio regardless of how much text has been supplied. */
+    flush?: boolean;
+    /** Force the generation of audio and close the stream. */
+    close?: boolean;
+}

package/dist/api/resources/tts/types/PublishTts.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/dist/api/resources/tts/types/SnippetAudioChunk.d.ts

@@ -2,7 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../../../index";
+/**
+ * Metadata for a chunk of generated audio.
+ */
 export interface SnippetAudioChunk {
+    /** ID of the initiating request. */
+    requestId: string;
     /** The generation ID of the parent snippet that this chunk corresponds to. */
     generationId: string;
     /** The ID of the parent snippet that this chunk corresponds to. */
@@ -21,5 +26,5 @@ export interface SnippetAudioChunk {
     isLastChunk: boolean;
     /** The index of the utterance in the request that the parent snippet of this chunk corresponds to. */
     utteranceIndex?: number;
-    snippet: Hume.tts.Snippet;
+    snippet?: Hume.tts.Snippet;
 }