hume 0.15.8 → 0.15.10

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

@@ -3,13 +3,9 @@ import type * as Hume from "../../../index.js";
  * A paginated list of chats returned from the server
  */
 export interface ReturnPagedChats {
-    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
+    /** List of chats and their metadata returned for the specified page number and page size. */
     chatsPage: Hume.empathicVoice.ReturnChat[];
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -17,11 +13,6 @@ export interface ReturnPagedChats {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnPagedChatsPaginationDirection;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * Indicates the order in which the paginated results are presented, based on their creation date.
- *
- * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
- */
 export declare const ReturnPagedChatsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnPagedChatsPaginationDirection = void 0;
-/**
- * Indicates the order in which the paginated results are presented, based on their creation date.
- *
- * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
- */
 exports.ReturnPagedChatsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",

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

@@ -3,13 +3,9 @@ import type * as Hume from "../../../index.js";
  * A paginated list of config versions returned from the server
  */
 export interface ReturnPagedConfigs {
-    /** List of configs returned for the specified `page_number` and `page_size`. */
+    /** List of prompts returned for the specified page number and page size. */
     configsPage?: Hume.empathicVoice.ReturnConfig[];
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber?: number;
     /**
      * The maximum number of items returned per page.

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

@@ -3,11 +3,7 @@ import type * as Hume from "../../../index.js";
  * A paginated list of prompt versions returned from the server
  */
 export interface ReturnPagedPrompts {
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -15,7 +11,7 @@ export interface ReturnPagedPrompts {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** List of prompts returned for the specified `page_number` and `page_size`. */
+    /** List of prompts returned for the specified page number and page size. */
     promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -3,11 +3,7 @@ import type * as Hume from "../../../index.js";
  * A paginated list of user defined tool versions returned from the server
  */
 export interface ReturnPagedUserDefinedTools {
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -15,7 +11,7 @@ export interface ReturnPagedUserDefinedTools {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** List of tools returned for the specified `page_number` and `page_size`. */
+    /** List of tools returned for the specified page number and page size. */
     toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,4 +1,3 @@
-/** Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
 export declare const ReturnPromptVersionType: {
     readonly Fixed: "FIXED";
     readonly Latest: "LATEST";

package/dist/cjs/api/resources/empathicVoice/types/ReturnPromptVersionType.js

@@ -2,7 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnPromptVersionType = void 0;
-/** Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
 exports.ReturnPromptVersionType = {
     Fixed: "FIXED",
     Latest: "LATEST",

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

@@ -2,12 +2,8 @@
  * A specific timeout configuration to be returned from the server
  */
 export interface ReturnTimeoutSpec {
-    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
+    /** Duration in seconds for the timeout. */
     durationSecs?: number;
-    /**
-     * Boolean indicating if this timeout is enabled.
-     *
-     * If set to false, EVI will not timeout due to a specified duration being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
-     */
+    /** Boolean indicating if this event message is enabled. */
     enabled: boolean;
 }

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

@@ -1,20 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Collection of timeout specifications returned by the server.
- *
- * Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.
+ * Collection of timeout specs to be returned from the server
  */
 export interface ReturnTimeoutSpecs {
-    /**
-     * 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 30 seconds and a maximum value of 1,800 seconds.
-     */
     inactivity: Hume.empathicVoice.ReturnTimeoutSpec;
-    /**
-     * 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 30 seconds and a maximum value of 1,800 seconds.
-     */
     maxDuration: Hume.empathicVoice.ReturnTimeoutSpec;
 }

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

@@ -3,36 +3,24 @@ import type * as Hume from "../../../index.js";
  * A specific tool version returned from the server
  */
 export interface ReturnUserDefinedTool {
-    /** Time at which the Tool was created. Measured in seconds since the Unix epoch. */
+    /** The timestamp when the first version of this tool was created. */
     createdOn: number;
-    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
+    /** Text describing what the tool does. */
     description?: 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. */
+    /** Text to use if the tool fails to generate content. */
     fallbackContent?: string;
     /** Identifier for a Tool. Formatted as a UUID. */
     id: string;
-    /** Time at which the Tool was last modified. Measured in seconds since the Unix epoch. */
+    /** The timestamp when this version of the tool was created. */
     modifiedOn: number;
     /** Name applied to all versions of a particular Tool. */
     name: string;
-    /**
-     * Stringified JSON defining the parameters used by this version 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.
-     */
+    /** Stringified JSON defining the parameters used by this version of the Tool. */
     parameters: string;
-    /** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
     toolType: Hume.empathicVoice.ReturnUserDefinedToolToolType;
-    /**
-     * Version number for a Tool.
-     *
-     * Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
-     *
-     * Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
-     */
+    /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
-    /** An optional description of the Tool version. */
+    /** Description that is appended to a specific version of a Tool. */
     versionDescription?: string;
-    /** Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
     versionType: Hume.empathicVoice.ReturnUserDefinedToolVersionType;
 }

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

@@ -1,4 +1,3 @@
-/** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
 export declare const ReturnUserDefinedToolToolType: {
     readonly Builtin: "BUILTIN";
     readonly Function: "FUNCTION";

package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js

@@ -2,7 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnUserDefinedToolToolType = void 0;
-/** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
 exports.ReturnUserDefinedToolToolType = {
     Builtin: "BUILTIN",
     Function: "FUNCTION",

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

@@ -1,4 +1,3 @@
-/** Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
 export declare const ReturnUserDefinedToolVersionType: {
     readonly Fixed: "FIXED";
     readonly Latest: "LATEST";

package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js

@@ -2,7 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnUserDefinedToolVersionType = void 0;
-/** Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
 exports.ReturnUserDefinedToolVersionType = {
     Fixed: "FIXED",
     Latest: "LATEST",

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

@@ -4,7 +4,9 @@ import type * as Hume from "../../../index.js";
  */
 export interface ReturnVoice {
     compatibleOctaveModels?: string[];
-    id?: string;
-    name?: string;
-    provider?: Hume.empathicVoice.VoiceProvider;
+    /** ID of the voice in the `Voice Library`. */
+    id: string;
+    /** Name of the voice in the `Voice Library`. */
+    name: string;
+    provider: Hume.empathicVoice.VoiceProvider;
 }

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

@@ -3,12 +3,8 @@ import type * as Hume from "../../../index.js";
  * Collection of webhook URL endpoints to be returned from the server
  */
 export interface ReturnWebhookSpec {
-    /**
-     * The list of events the specified URL is subscribed to.
-     *
-     * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
-     */
+    /** Events this URL is subscribed to */
     events: Hume.empathicVoice.ReturnWebhookEventType[];
-    /** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
+    /** Webhook URL to send the event updates to */
     url: string;
 }

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

@@ -1,30 +1,28 @@
 import type * as Hume from "../../../index.js";
 /**
- * **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.
+ * Settings for this chat session.
  */
 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/speech-to-speech-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 section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
      */
     audio?: Hume.empathicVoice.AudioConfiguration;
     /**
      * 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/speech-to-speech-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/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[];
     /**
-     * Field for injecting additional context into the conversation, which is appended to the end of user messages for the session.
+     * 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 clear injected context.
+     * Set to `null` to disable context injection.
      */
     context?: Hume.empathicVoice.Context;
     /**
@@ -32,7 +30,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/speech-to-speech-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/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
      */
     customSessionId?: string;
     /**
@@ -49,13 +47,13 @@ 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/speech-to-speech-evi/guides/prompting).
+     * For help writing a system prompt, see our [Prompting Guide](/docs/empathic-voice-interface-evi/prompting).
      */
     systemPrompt?: string;
     /**
      * 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/speech-to-speech-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/empathic-voice-interface-evi/tool-use).
      */
     tools?: Hume.empathicVoice.Tool[];
     /**
@@ -63,17 +61,10 @@ 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/speech-to-speech-evi/configuration/session-settings).
+     * 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";
-    /**
-     * 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.
-     *
-     * 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).
-     */
+    /** Dynamic values that can be used to populate EVI prompts. */
     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/cjs/api/resources/empathicVoice/types/SubscribeEvent.d.ts

@@ -1,56 +1,2 @@
 import type * as Hume from "../../../index.js";
-export type SubscribeEvent = 
-/**
- * **Indicates the conclusion of the assistant's response**, signaling that the assistant has finished speaking for the current conversational turn. */
-Hume.empathicVoice.AssistantEnd
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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
-/**
- * **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;
+export type SubscribeEvent = Hume.empathicVoice.AssistantEnd | Hume.empathicVoice.AssistantMessage | Hume.empathicVoice.AssistantProsody | Hume.empathicVoice.AudioOutput | Hume.empathicVoice.ChatMetadata | Hume.empathicVoice.WebSocketError | Hume.empathicVoice.UserInterruption | Hume.empathicVoice.UserMessage | Hume.empathicVoice.ToolCallMessage | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage | Hume.empathicVoice.SessionSettings;

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

@@ -1,21 +1,15 @@
 import type * as Hume from "../../../index.js";
 /**
- * **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.
+ * When provided, the output is a tool call.
  */
 export interface ToolCallMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /** Name of the tool called. */
     name: string;
-    /**
-     * 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 of the tool call. Is a stringified JSON schema. */
     parameters: string;
-    /** 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). */
+    /** 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;
     /**
      * The unique identifier for a specific tool call instance.

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

@@ -1,8 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * **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.
+ * When provided, the output is a function call error.
  */
 export interface ToolErrorMessage {
     /** Error code. Identifies the type of error encountered. */
@@ -18,7 +16,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/speech-to-speech-evi/chat#receive.ToolCallMessage).
+     * 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;
     /** Type of tool called. Either `builtin` for natively implemented tools, like web search, or `function` for user-defined tools. */
@@ -26,7 +24,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/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.
+     * 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";
 }

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

@@ -1,8 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * **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.
+ * When provided, the output is a function call response.
  */
 export interface ToolResponseMessage {
     /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */
@@ -12,21 +10,15 @@ 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/speech-to-speech-evi/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/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.tool_call_id).
      */
     toolCallId: 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/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. */
     toolType?: Hume.empathicVoice.ToolType;
     /**
      * 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/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.
+     * 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";
 }

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

@@ -1,12 +1,16 @@
 /**
- * **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. */
+    /**
+     * 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;
     /** 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,7 +1,5 @@
 /**
- * **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)
+ * When provided, the output is an interruption.
  */
 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,22 +1,13 @@
 import type * as Hume from "../../../index.js";
 /**
- * **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.
+ * When provided, the output is a user message.
  */
 export interface UserMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** 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. */
+    /** 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;
-    /**
-     * Indicates whether this `UserMessage` contains an interim (unfinalized) transcript.
-     *
-     * - `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/speech-to-speech-evi/chat#request.query.verbose_transcription) query parameter is set to `true` in the initial handshake.
-     */
+    /** Indicates if this message contains an immediate and unfinalized transcript of the user's audio input. If it does, words may be repeated across successive UserMessage messages as our transcription model becomes more confident about what was said with additional context. Interim messages are useful to detect if the user is interrupting during audio playback on the client. Even without a finalized transcription, along with `UserInterrupt` messages, interim `UserMessages` are useful for detecting if the user is interrupting during audio playback on the client, signaling to stop playback in your application. */
     interim: boolean;
     /** Detected language of the message text. */
     language?: string;
@@ -26,10 +17,5 @@ export interface UserMessage {
     models: Hume.empathicVoice.Inference;
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
-    /**
-     * 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/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";
 }

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

@@ -1,7 +1,16 @@
 import type * as Hume from "../../../index.js";
 export interface VoiceId {
-    /** ID of the voice in the `Voice Library`. */
+    /** The unique ID associated with the **Voice**. */
     id: string;
-    /** Model provider associated with this Voice ID. */
+    /**
+     * Specifies the source provider associated with the chosen voice.
+     *
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/voices), containing a variety of preset, shared voices.
+     * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
+     *
+     * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.
+     *
+     * Preset voices from Hume's **Voice Library** are accessible by all users. In contrast, your custom voices are private and accessible only via requests authenticated with your API key.
+     */
     provider?: Hume.empathicVoice.VoiceProvider;
 }