hume 0.15.4 → 0.15.5

package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts

@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * A paginated list of chat events that occurred across chats in this chat_group from the server
  */
 export interface ReturnChatGroupPagedEvents {
+    /** List of Chat Events for the specified `page_number` and `page_size`. */
+    eventsPage: Hume.empathicVoice.ReturnChatEvent[];
     /** Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same `chat_group_id`. Formatted as a UUID. */
     id: string;
     /**
@@ -17,14 +19,12 @@ export interface ReturnChatGroupPagedEvents {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: 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.ReturnChatGroupPagedEventsPaginationDirection;
-    /** List of Chat Events for the specified `page_number` and `page_size`. */
-    eventsPage: Hume.empathicVoice.ReturnChatEvent[];
+    /** The total number of pages in the collection. */
+    totalPages: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts

@@ -3,38 +3,15 @@ import type * as Hume from "../../../index.mjs";
  * A description of chat status with a paginated list of chat events returned from the server
  */
 export interface ReturnChatPagedEvents {
-    /** Identifier for a Chat. Formatted as a UUID. */
-    id: string;
     /** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
     chatGroupId: string;
-    /**
-     * Indicates the current state of the chat. There are six possible statuses:
-     *
-     * - `ACTIVE`: The chat is currently active and ongoing.
-     *
-     * - `USER_ENDED`: The chat was manually ended by the user.
-     *
-     * - `USER_TIMEOUT`: The chat ended due to a user-defined timeout.
-     *
-     * - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum allowed duration.
-     *
-     * - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout.
-     *
-     * - `ERROR`: The chat ended unexpectedly due to an error.
-     */
-    status: Hume.empathicVoice.ReturnChatPagedEventsStatus;
-    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
-    startTimestamp: number;
+    config?: Hume.empathicVoice.ReturnConfigSpec;
     /** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
     endTimestamp?: 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.ReturnChatPagedEventsPaginationDirection;
     /** List of Chat Events for the specified `page_number` and `page_size`. */
     eventsPage: Hume.empathicVoice.ReturnChatEvent[];
+    /** Identifier for a Chat. Formatted as a UUID. */
+    id: string;
     /** Stringified JSON with additional metadata about the chat. */
     metadata?: string;
     /**
@@ -49,7 +26,30 @@ export interface ReturnChatPagedEvents {
      * 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.ReturnChatPagedEventsPaginationDirection;
+    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
+    startTimestamp: number;
+    /**
+     * Indicates the current state of the chat. There are six possible statuses:
+     *
+     * - `ACTIVE`: The chat is currently active and ongoing.
+     *
+     * - `USER_ENDED`: The chat was manually ended by the user.
+     *
+     * - `USER_TIMEOUT`: The chat ended due to a user-defined timeout.
+     *
+     * - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum allowed duration.
+     *
+     * - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout.
+     *
+     * - `ERROR`: The chat ended unexpectedly due to an error.
+     */
+    status: Hume.empathicVoice.ReturnChatPagedEventsStatus;
     /** The total number of pages in the collection. */
     totalPages: number;
-    config?: Hume.empathicVoice.ReturnConfigSpec;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnConfig.d.mts

@@ -3,52 +3,31 @@ import type * as Hume from "../../../index.mjs";
  * A specific config version returned from the server
  */
 export interface ReturnConfig {
-    /** Name applied to all versions of a particular Config. */
-    name?: string;
+    /** List of built-in tools associated with this config */
+    builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
+    /** The timestamp when the first version of this config was created. */
+    createdOn?: number;
+    ellmModel?: Hume.empathicVoice.ReturnEllmModel;
+    eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
+    /** The version of the EVI used with this config. */
+    eviVersion?: string;
     /** Identifier for a Config. Formatted as a UUID. */
     id?: string;
-    /**
-     * Version number for a Config.
-     *
-     * Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
-     *
-     * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
-     */
-    version?: number;
-    /**
-     * The supplemental language model associated with this Config.
-     *
-     * This model is used to generate longer, more detailed responses from EVI. Choosing an appropriate supplemental language model for your use case is crucial for generating fast, high-quality responses from EVI.
-     */
     languageModel?: Hume.empathicVoice.ReturnLanguageModel;
-    /** List of built-in tools associated with this Config. */
-    builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
-    /**
-     * 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.
-     */
-    eviVersion?: string;
-    timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
+    /** The timestamp when this version of the config was created. */
+    modifiedOn?: number;
+    /** Name applied to all versions of a particular Config. */
+    name?: string;
     nudges?: Hume.empathicVoice.ReturnNudgeSpec;
-    eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
-    /**
-     * The eLLM setup associated with this Config.
-     *
-     * Hume's eLLM (empathic Large Language Model) is a multimodal language model that takes into account both expression measures and language. The eLLM generates short, empathic language responses and guides text-to-speech (TTS) prosody.
-     */
-    ellmModel?: Hume.empathicVoice.ReturnEllmModel;
-    /** A voice specification associated with this Config. */
-    voice?: Hume.empathicVoice.ReturnVoice;
     prompt?: Hume.empathicVoice.ReturnPrompt;
+    timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
+    /** List of user-defined tools associated with this config. */
+    tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
+    /** Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique. */
+    version?: number;
+    /** Description that is appended to a specific version of a Config. */
+    versionDescription?: string;
+    voice?: Hume.empathicVoice.ReturnVoice;
     /** Map of webhooks associated with this config. */
     webhooks?: (Hume.empathicVoice.ReturnWebhookSpec | undefined)[];
-    /** Time at which the Config was created. Measured in seconds since the Unix epoch. */
-    createdOn?: number;
-    /** Time at which the Config was last modified. Measured in seconds since the Unix epoch. */
-    modifiedOn?: number;
-    /** An optional description of the Config version. */
-    versionDescription?: string;
-    /** List of user-defined tools associated with this Config. */
-    tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts

@@ -5,8 +5,6 @@ import type * as Hume from "../../../index.mjs";
  * Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
  */
 export interface ReturnEventMessageSpecs {
-    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
-    onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
     /**
      * Specifies the message EVI provides when the chat is about to be disconnected due to a user inactivity timeout, such as a message mentioning a lack of user input for a period of time.
      *
@@ -19,4 +17,6 @@ export interface ReturnEventMessageSpecs {
     onInactivityTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;
     /** Specifies the message EVI provides when the chat is disconnected due to reaching the maximum chat duration, such as a message mentioning the time limit for the chat has been reached. */
     onMaxDurationTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;
+    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
+    onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts

@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * A paginated list of chat_groups returned from the server
  */
 export interface ReturnPagedChatGroups {
+    /** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
+    chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
     /**
      * The page number of the returned list.
      *
@@ -15,14 +17,12 @@ export interface ReturnPagedChatGroups {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: 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.ReturnPagedChatGroupsPaginationDirection;
-    /** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
-    chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
+    /** The total number of pages in the collection. */
+    totalPages: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChats.d.mts

@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * 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`. */
+    chatsPage: Hume.empathicVoice.ReturnChat[];
     /**
      * The page number of the returned list.
      *
@@ -15,14 +17,12 @@ export interface ReturnPagedChats {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: 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;
-    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
-    chatsPage: Hume.empathicVoice.ReturnChat[];
+    /** The total number of pages in the collection. */
+    totalPages: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnPagedConfigs.d.mts

@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * 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`. */
+    configsPage?: Hume.empathicVoice.ReturnConfig[];
     /**
      * The page number of the returned list.
      *
@@ -17,6 +19,4 @@ export interface ReturnPagedConfigs {
     pageSize?: number;
     /** The total number of pages in the collection. */
     totalPages: number;
-    /** List of configs returned for the specified `page_number` and `page_size`. */
-    configsPage?: Hume.empathicVoice.ReturnConfig[];
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnPagedPrompts.d.mts

@@ -15,8 +15,8 @@ export interface ReturnPagedPrompts {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: number;
     /** 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/esm/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts

@@ -15,8 +15,8 @@ export interface ReturnPagedUserDefinedTools {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: number;
     /** 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/esm/api/resources/empathicVoice/types/ReturnPrompt.d.mts

@@ -1,32 +1,21 @@
-import type * as Hume from "../../../index.mjs";
 /**
- * A Prompt associated with this Config.
+ * A specific prompt version returned from the server
  */
 export interface ReturnPrompt {
-    /** Name applied to all versions of a particular Prompt. */
-    name: string;
+    /** The timestamp when the first version of this prompt was created. */
+    createdOn: number;
     /** Identifier for a Prompt. Formatted as a UUID. */
     id: string;
-    /**
-     * Instructions used to shape EVI's behavior, responses, and style.
-     *
-     * 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).
-     */
+    /** The timestamp when this version of the prompt was created. */
+    modifiedOn: number;
+    /** Name applied to all versions of a particular Prompt. */
+    name: string;
+    /** Text used for this version of the Prompt. */
     text: string;
-    /**
-     * Version number for a Prompt.
-     *
-     * Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
-     *
-     * Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
-     */
+    /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
-    /** Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
-    versionType: Hume.empathicVoice.ReturnPromptVersionType;
-    /** Time at which the Prompt was created. Measured in seconds since the Unix epoch. */
-    createdOn: number;
-    /** Time at which the Prompt was last modified. Measured in seconds since the Unix epoch. */
-    modifiedOn: number;
-    /** An optional description of the Prompt version. */
+    /** Description that is appended to a specific version of a Prompt. */
     versionDescription?: string;
+    /** Indicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
+    versionType: string;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts

@@ -2,12 +2,12 @@
  * 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). */
+    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.
      */
     enabled: boolean;
-    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
-    durationSecs?: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts

@@ -3,10 +3,26 @@ import type * as Hume from "../../../index.mjs";
  * A specific tool version returned from the server
  */
 export interface ReturnUserDefinedTool {
-    /** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
-    toolType: Hume.empathicVoice.ReturnUserDefinedToolToolType;
+    /** Time at which the Tool was created. Measured in seconds since the Unix epoch. */
+    createdOn: number;
+    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
+    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. */
+    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. */
+    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.
+     */
+    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.
      *
@@ -15,24 +31,8 @@ export interface ReturnUserDefinedTool {
      * Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
      */
     version: number;
-    /** 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;
     /** An optional description of the Tool version. */
     versionDescription?: string;
-    /** Name applied to all versions of a particular Tool. */
-    name: string;
-    /** Time at which the Tool was created. Measured in seconds since the Unix epoch. */
-    createdOn: number;
-    /** Time at which the Tool was last modified. Measured in seconds since the Unix epoch. */
-    modifiedOn: number;
-    /** 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. */
-    fallbackContent?: string;
-    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
-    description?: 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.
-     */
-    parameters: 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/esm/api/resources/empathicVoice/types/ReturnVoice.d.mts

@@ -3,8 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * An Octave voice available for text-to-speech
  */
 export interface ReturnVoice {
+    compatibleOctaveModels?: string[];
     id?: string;
     name?: string;
     provider?: Hume.empathicVoice.VoiceProvider;
-    compatibleOctaveModels?: string[];
 }

package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.d.mts

@@ -2,5 +2,6 @@
 export declare const ReturnWebhookEventType: {
     readonly ChatStarted: "chat_started";
     readonly ChatEnded: "chat_ended";
+    readonly ToolCall: "tool_call";
 };
 export type ReturnWebhookEventType = (typeof ReturnWebhookEventType)[keyof typeof ReturnWebhookEventType];

package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.mjs

@@ -3,4 +3,5 @@
 export const ReturnWebhookEventType = {
     ChatStarted: "chat_started",
     ChatEnded: "chat_ended",
+    ToolCall: "tool_call",
 };

package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookSpec.d.mts

@@ -3,12 +3,12 @@ import type * as Hume from "../../../index.mjs";
  * Collection of webhook URL endpoints to be returned from the server
  */
 export interface ReturnWebhookSpec {
-    /** 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. */
-    url: string;
     /**
      * 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: 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. */
+    url: string;
 }

package/dist/esm/api/resources/empathicVoice/types/SubscribeEvent.d.mts

@@ -1,2 +1,35 @@
 import type * as Hume from "../../../index.mjs";
-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;
+export type SubscribeEvent = 
+/**
+ * When provided, the output is an assistant end message. */
+Hume.empathicVoice.AssistantEnd
+/**
+ * When provided, the output is an assistant message. */
+ | Hume.empathicVoice.AssistantMessage
+/**
+ * When provided, the output is an Assistant Prosody message. */
+ | Hume.empathicVoice.AssistantProsody
+/**
+ * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */
+ | Hume.empathicVoice.AudioOutput
+/**
+ * When provided, the output is a chat metadata message. */
+ | Hume.empathicVoice.ChatMetadata
+/**
+ * When provided, the output is an error message. */
+ | Hume.empathicVoice.WebSocketError
+/**
+ * When provided, the output is an interruption. */
+ | Hume.empathicVoice.UserInterruption
+/**
+ * When provided, the output is a user message. */
+ | Hume.empathicVoice.UserMessage
+/**
+ * When provided, the output is a tool call. */
+ | Hume.empathicVoice.ToolCallMessage
+/**
+ * When provided, the output is a function call response. */
+ | Hume.empathicVoice.ToolResponseMessage
+/**
+ * When provided, the output is a function call error. */
+ | Hume.empathicVoice.ToolErrorMessage;

package/dist/esm/api/resources/empathicVoice/types/ToolCallMessage.d.mts

@@ -7,13 +7,9 @@ export interface ToolCallMessage {
     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.
@@ -28,5 +24,5 @@ export interface ToolCallMessage {
      *
      * This message indicates that the supplemental LLM has detected a need to invoke the specified tool.
      */
-    type: "tool_call";
+    type?: "tool_call";
 }

package/dist/esm/api/resources/tts/resources/streamInput/client/Client.d.mts

@@ -26,5 +26,5 @@ export declare class StreamInput {
     protected readonly _options: StreamInput.Options;
     constructor(_options?: StreamInput.Options);
     connect(args?: StreamInput.ConnectArgs): Promise<StreamInputSocket>;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | null | undefined>>;
 }

package/dist/esm/api/resources/tts/resources/streamInput/client/Client.mjs

@@ -76,8 +76,13 @@ export class StreamInput {
     }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
-            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
-            return { "X-Hume-Api-Key": apiKeyValue };
+            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 };
         });
     }
 }

package/dist/esm/api/resources/tts/resources/voices/client/Client.d.mts

@@ -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 | undefined>>;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | null | undefined>>;
 }

package/dist/esm/api/resources/tts/resources/voices/client/Client.mjs

@@ -284,8 +284,13 @@ export class Voices {
     }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
-            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
-            return { "X-Hume-Api-Key": apiKeyValue };
+            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 };
         });
     }
 }

package/dist/esm/api/resources/tts/types/ErrorResponse.d.mts

@@ -1,5 +1,5 @@
 export interface ErrorResponse {
+    code?: string;
     error?: string;
     message?: string;
-    code?: string;
 }

package/dist/esm/api/resources/tts/types/PostedTts.d.mts

@@ -4,7 +4,7 @@ export interface PostedTts {
     context?: Hume.tts.PostedContext;
     /** 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. Only supported for Octave 2 requests. */
     includeTimestampTypes?: Hume.tts.TimestampType[];
     /**
      * Number of audio generations to produce from the input utterances.

package/dist/esm/api/resources/tts/types/ReturnVoice.d.mts

@@ -3,6 +3,7 @@ import type * as Hume from "../../../index.mjs";
  * An Octave voice available for text-to-speech
  */
 export interface ReturnVoice {
+    compatibleOctaveModels?: string[];
     /** ID of the voice in the `Voice Library`. */
     id?: string;
     /** Name of the voice in the `Voice Library`. */
@@ -13,5 +14,4 @@ export interface ReturnVoice {
      * Voices created through this endpoint will always have the provider set to `CUSTOM_VOICE`, indicating a custom voice stored in your account.
      */
     provider?: Hume.tts.VoiceProvider;
-    compatibleOctaveModels?: string[];
 }

package/dist/esm/api/resources/tts/types/Snippet.d.mts

@@ -8,7 +8,7 @@ export interface Snippet {
     id: string;
     /** The text for this **Snippet**. */
     text: string;
-    /** A list of word or phoneme level timestamps for the generated audio. */
+    /** A list of word or phoneme level timestamps for the generated audio. Timestamps are only returned for Octave 2 requests. */
     timestamps: Hume.tts.Timestamp[];
     /** The transcribed text of the generated audio. It is only present if `instant_mode` is set to `false`. */
     transcribedText?: string;

package/dist/esm/api/resources/tts/types/Timestamp.d.mts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.mjs";
 export interface Timestamp {
+    /** The word or phoneme text that the timestamp corresponds to. */
     text: string;
+    /** The start and end timestamps for the word or phoneme in milliseconds. */
     time: Hume.tts.MillisecondInterval;
     type: Hume.tts.TimestampType;
 }

package/dist/esm/core/websocket/ws.mjs

@@ -29,9 +29,10 @@ const DEFAULT_OPTIONS = {
     debug: false,
 };
 function addApiKeyFromHeader({ headers, queryParameters, }) {
-    const apiKeyValue = headers === null || headers === void 0 ? void 0 : headers["X-Hume-Api-Key"];
+    var _a;
+    const apiKeyValue = (_a = Object.entries(headers !== null && headers !== void 0 ? headers : {}).find(([k]) => k.toLowerCase() === "x-hume-api-key")) === null || _a === void 0 ? void 0 : _a[1];
     if (apiKeyValue && !(queryParameters === null || queryParameters === void 0 ? void 0 : queryParameters["api_key"])) {
-        return Object.assign(Object.assign({}, queryParameters), { apiKey: apiKeyValue });
+        return Object.assign(Object.assign({}, queryParameters), { api_key: apiKeyValue });
     }
     return queryParameters;
 }