hume 0.12.2 → 0.13.0

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

@@ -3,24 +3,18 @@
  */
 import * as Hume from "../../../index";
 export interface Context {
-    /**
-     * The context to be injected into the conversation. Helps inform the LLM's response by providing relevant information about the ongoing conversation.
-     *
-     * This text will be appended to the end of user messages based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
-     */
-    text: string;
     /**
      * The persistence level of the injected context. Specifies how long the injected context will remain active in the session.
      *
-     * There are three possible context types:
-     *
-     * - **Persistent**: The context is appended to all user messages for the duration of the session.
-     *
-     * - **Temporary**: The context is appended only to the next user message.
+     * - **Temporary**: Context that is only applied to the following assistant response.
      *
-     *  - **Editable**: The original context is updated to reflect the new context.
-     *
-     *  If the type is not specified, it will default to `temporary`.
+     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
      */
     type?: Hume.empathicVoice.ContextType;
+    /**
+     * The context to be injected into the conversation. Helps inform the LLM's response by providing relevant information about the ongoing conversation.
+     *
+     * This text will be appended to the end of [user_messages](/reference/speech-to-speech-evi/chat#receive.UserMessage.message.content) based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
+     */
+    text: string;
 }

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

@@ -1,9 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ContextType = "editable" | "persistent" | "temporary";
+export type ContextType = "temporary" | "persistent";
 export declare const ContextType: {
-    readonly Editable: "editable";
-    readonly Persistent: "persistent";
     readonly Temporary: "temporary";
+    readonly Persistent: "persistent";
 };

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

@@ -5,7 +5,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextType = void 0;
 exports.ContextType = {
-    Editable: "editable",
-    Persistent: "persistent",
     Temporary: "temporary",
+    Persistent: "persistent",
 };

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type LanguageModelType = "claude-3-7-sonnet-latest" | "claude-3-5-sonnet-latest" | "claude-3-5-haiku-latest" | "claude-3-5-sonnet-20240620" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307" | "claude-sonnet-4-20250514" | "us.anthropic.claude-3-5-haiku-20241022-v1:0" | "us.anthropic.claude-3-5-sonnet-20240620-v1:0" | "us.anthropic.claude-3-haiku-20240307-v1:0" | "gpt-oss-120b" | "qwen-3-235b-a22b" | "qwen-3-235b-a22b-instruct-2507" | "qwen-3-235b-a22b-thinking-2507" | "gemini-1.5-pro" | "gemini-1.5-flash" | "gemini-1.5-pro-002" | "gemini-1.5-flash-002" | "gemini-2.0-flash" | "gemini-2.5-flash" | "gemini-2.5-flash-preview-04-17" | "gpt-4-turbo" | "gpt-4-turbo-preview" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo" | "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gemma-7b-it" | "llama3-8b-8192" | "llama3-70b-8192" | "llama-3.1-70b-versatile" | "llama-3.3-70b-versatile" | "llama-3.1-8b-instant" | "moonshotai/kimi-k2-instruct" | "accounts/fireworks/models/mixtral-8x7b-instruct" | "accounts/fireworks/models/llama-v3p1-405b-instruct" | "accounts/fireworks/models/llama-v3p1-70b-instruct" | "accounts/fireworks/models/llama-v3p1-8b-instruct" | "sonar" | "sonar-pro" | "sambanova" | "DeepSeek-R1-Distill-Llama-70B" | "Llama-4-Maverick-17B-128E-Instruct" | "Qwen3-32B" | "ellm" | "custom-language-model" | "hume-evi-3-web-search";
+export type LanguageModelType = "claude-3-7-sonnet-latest" | "claude-3-5-sonnet-latest" | "claude-3-5-haiku-latest" | "claude-3-5-sonnet-20240620" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307" | "claude-sonnet-4-20250514" | "us.anthropic.claude-3-5-haiku-20241022-v1:0" | "us.anthropic.claude-3-5-sonnet-20240620-v1:0" | "us.anthropic.claude-3-haiku-20240307-v1:0" | "gpt-oss-120b" | "qwen-3-235b-a22b" | "qwen-3-235b-a22b-instruct-2507" | "qwen-3-235b-a22b-thinking-2507" | "gemini-1.5-pro" | "gemini-1.5-flash" | "gemini-1.5-pro-002" | "gemini-1.5-flash-002" | "gemini-2.0-flash" | "gemini-2.5-flash" | "gemini-2.5-flash-preview-04-17" | "gpt-4-turbo" | "gpt-4-turbo-preview" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo" | "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gemma-7b-it" | "llama3-8b-8192" | "llama3-70b-8192" | "llama-3.1-70b-versatile" | "llama-3.3-70b-versatile" | "llama-3.1-8b-instant" | "moonshotai/kimi-k2-instruct" | "accounts/fireworks/models/mixtral-8x7b-instruct" | "accounts/fireworks/models/llama-v3p1-405b-instruct" | "accounts/fireworks/models/llama-v3p1-70b-instruct" | "accounts/fireworks/models/llama-v3p1-8b-instruct" | "sonar" | "sonar-pro" | "sambanova" | "DeepSeek-R1-Distill-Llama-70B" | "Llama-4-Maverick-17B-128E-Instruct" | "Qwen3-32B" | "ellm" | "custom-language-model" | "hume-evi-3-web-search";
 export declare const LanguageModelType: {
     readonly Claude37SonnetLatest: "claude-3-7-sonnet-latest";
     readonly Claude35SonnetLatest: "claude-3-5-sonnet-latest";
@@ -32,6 +32,9 @@ export declare const LanguageModelType: {
     readonly Gpt4O: "gpt-4o";
     readonly Gpt4OMini: "gpt-4o-mini";
     readonly Gpt41: "gpt-4.1";
+    readonly Gpt5: "gpt-5";
+    readonly Gpt5Mini: "gpt-5-mini";
+    readonly Gpt5Nano: "gpt-5-nano";
     readonly Gemma7BIt: "gemma-7b-it";
     readonly Llama38B8192: "llama3-8b-8192";
     readonly Llama370B8192: "llama3-70b-8192";

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

@@ -34,6 +34,9 @@ exports.LanguageModelType = {
     Gpt4O: "gpt-4o",
     Gpt4OMini: "gpt-4o-mini",
     Gpt41: "gpt-4.1",
+    Gpt5: "gpt-5",
+    Gpt5Mini: "gpt-5-mini",
+    Gpt5Nano: "gpt-5-nano",
     Gemma7BIt: "gemma-7b-it",
     Llama38B8192: "llama3-8b-8192",
     Llama370B8192: "llama3-70b-8192",

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

@@ -5,12 +5,12 @@
  * Pause responses from EVI. Chat history is still saved and sent after resuming.
  */
 export interface PauseAssistantMessage {
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
     /**
      * 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.
      */
     type: "pause_assistant_message";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
 }

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

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

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

@@ -18,6 +18,10 @@ export interface ReturnConfig {
      * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
      */
     version?: number;
+    /** List of user-defined tools associated with this Config. */
+    tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
+    /** An optional description of the Config version. */
+    versionDescription?: string;
     /**
      * The supplemental language model associated with this Config.
      *
@@ -33,6 +37,7 @@ export interface ReturnConfig {
      */
     eviVersion?: string;
     timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
+    nudges?: Hume.empathicVoice.ReturnNudgeSpec;
     eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
     /**
      * The eLLM setup associated with this Config.
@@ -40,17 +45,12 @@ export interface ReturnConfig {
      * 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;
+    voice?: unknown;
+    prompt?: Hume.empathicVoice.ReturnPrompt;
     /** Map of webhooks associated with this config. */
     webhooks?: (Hume.empathicVoice.ReturnWebhookSpec | undefined)[];
-    /** An optional description of the Config version. */
-    versionDescription?: string;
     /** 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;
-    nudges?: Hume.empathicVoice.ReturnNudgeSpec;
-    voice?: unknown;
-    prompt?: Hume.empathicVoice.ReturnPrompt;
-    /** List of user-defined tools associated with this Config. */
-    tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
 }

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

@@ -26,10 +26,10 @@ export interface ReturnPrompt {
      * Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
      */
     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;
     /** An optional description of the Prompt version. */
     versionDescription?: string;
+    /** 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. */

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

@@ -7,27 +7,13 @@ import * as Hume from "../../../index";
  */
 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).
-     */
-    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/empathic-voice-interface-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.
-     */
-    builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
-    /**
-     * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+     * The type of message sent through the socket; must be `session_settings` for our server to correctly identify and process it as a Session Settings message.
      *
-     * 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.
+     * 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.
      *
-     * Set to `null` to disable context injection.
+     * For more information, please refer to the [Session Settings guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
      */
-    context?: Hume.empathicVoice.Context;
+    type: "session_settings";
     /**
      * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
      *
@@ -36,13 +22,6 @@ export interface SessionSettings {
      * 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.
      */
     customSessionId?: string;
-    /**
-     * Third party API key for the supplemental language model.
-     *
-     * When provided, EVI will use this key instead of Hume’s API key for the supplemental LLM. This allows you to bypass rate limits and utilize your own API key as needed.
-     */
-    languageModelApiKey?: string;
-    metadata?: Record<string, unknown>;
     /**
      * Instructions used to shape EVI’s behavior, responses, and style for the session.
      *
@@ -53,6 +32,26 @@ export interface SessionSettings {
      * For help writing a system prompt, see our [Prompting Guide](/docs/empathic-voice-interface-evi/guides/prompting).
      */
     systemPrompt?: string;
+    /**
+     * Field for injecting 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.
+     */
+    context?: Hume.empathicVoice.Context;
+    /**
+     * 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).
+     */
+    audio?: Hume.empathicVoice.AudioConfiguration;
+    /**
+     * Third party API key for the supplemental language model.
+     *
+     * When provided, EVI will use this key instead of Hume’s API key for the supplemental LLM. This allows you to bypass rate limits and utilize your own API key as needed.
+     */
+    languageModelApiKey?: string;
     /**
      * List of user-defined tools to enable for the session.
      *
@@ -60,13 +59,14 @@ export interface SessionSettings {
      */
     tools?: Hume.empathicVoice.Tool[];
     /**
-     * The type of message sent through the socket; must be `session_settings` for our server to correctly identify and process it as a Session Settings message.
+     * List of built-in tools to enable for the 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.
+     * 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).
      *
-     * For more information, please refer to the [Session Settings guide](/docs/empathic-voice-interface-evi/configuration/session-settings).
+     * 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.
      */
-    type: "session_settings";
+    builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
+    metadata?: Record<string, unknown>;
     /**
      * This field allows you to assign values to dynamic variables referenced in your system prompt.
      *

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

@@ -3,10 +3,8 @@
  */
 import * as Hume from "../../../index";
 export interface Tool {
-    /** 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 if the tool call fails. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation. */
-    fallbackContent?: string;
+    /** Type of tool. Set to `function` for user-defined tools. */
+    type: Hume.empathicVoice.ToolType;
     /** Name of the user-defined tool to be enabled. */
     name: string;
     /**
@@ -15,6 +13,8 @@ export interface 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 JSON schema, this format ensures the tool receives data in the expected format.
      */
     parameters: string;
-    /** Type of tool. Set to `function` for user-defined tools. */
-    type: Hume.empathicVoice.ToolType;
+    /** 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 if the tool call fails. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation. */
+    fallbackContent?: string;
 }

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

@@ -6,8 +6,6 @@ import * as Hume from "../../../index";
  * 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;
     /**
@@ -16,20 +14,22 @@ export interface ToolCallMessage {
      * 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;
-    /** 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). */
-    responseRequired: boolean;
     /**
      * The unique identifier for a specific tool call instance.
      *
      * This ID is used to track the request and response of a particular tool invocation, ensuring that the correct response is linked to the appropriate request.
      */
     toolCallId: string;
-    /** 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 Call message, this must be `tool_call`.
      *
      * This message indicates that the supplemental LLM has detected a need to invoke the specified tool.
      */
     type: "tool_call";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
+    /** Type of tool called. Either `builtin` 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). */
+    responseRequired: boolean;
 }

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

@@ -6,28 +6,28 @@ import * as Hume from "../../../index";
  * When provided, the output is a function call error.
  */
 export interface ToolErrorMessage {
-    /** Error code. Identifies the type of error encountered. */
-    code?: 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. */
-    content?: string;
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
-    /** Error message from the tool call, not exposed to the LLM or user. */
-    error: string;
-    /** Indicates the severity of an error; for a Tool Error message, this must be `warn` to signal an unexpected event. */
-    level?: Hume.empathicVoice.ErrorLevel;
     /**
-     * The unique identifier for a specific tool call instance.
+     * The type of message sent through the socket; for a Tool Error message, this must be `tool_error`.
      *
-     * 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).
+     * 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.
      */
-    toolCallId: string;
+    type: "tool_error";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
     /** Type of tool called. Either `builtin` 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 Error message, this must be `tool_error`.
+     * The unique identifier for a specific tool call instance.
      *
-     * 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.
+     * 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).
      */
-    type: "tool_error";
+    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. */
+    content?: string;
+    /** Error message from the tool call, not exposed to the LLM or user. */
+    error: string;
+    /** Error code. Identifies the type of error encountered. */
+    code?: string;
+    /** Indicates the severity of an error; for a Tool Error message, this must be `warn` to signal an unexpected event. */
+    level?: Hume.empathicVoice.ErrorLevel;
 }

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

@@ -6,8 +6,12 @@ import * as Hume from "../../../index";
  * 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. */
-    content: string;
+    /**
+     * 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.
+     */
+    type: "tool_response";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /**
@@ -16,6 +20,8 @@ export interface ToolResponseMessage {
      * 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).
      */
     toolCallId: string;
+    /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */
+    content: string;
     /**
      * Name of the tool.
      *
@@ -24,10 +30,4 @@ export interface ToolResponseMessage {
     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/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.
-     */
-    type: "tool_response";
 }

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

@@ -7,6 +7,8 @@
  * 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 {
+    /** The type of message sent through the socket; must be `user_input` for our server to correctly identify and process it as a User Input message. */
+    type: "user_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /**
@@ -15,6 +17,4 @@ export interface UserInput {
      * 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/api/resources/empathicVoice/types/UserInterruption.d.ts

@@ -5,14 +5,14 @@
  * 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. */
-    customSessionId?: string;
-    /** Unix timestamp of the detected user interruption. */
-    time: number;
     /**
      * The type of message sent through the socket; for a User Interruption message, this must be `user_interruption`.
      *
      * This message indicates the user has interrupted the assistant’s response. EVI detects the interruption in real-time and sends this message to signal the interruption event. This message allows the system to stop the current audio playback, clear the audio queue, and prepare to handle new user input.
      */
     type: "user_interruption";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
+    /** Unix timestamp of the detected user interruption. */
+    time: number;
 }

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

@@ -6,8 +6,20 @@ import * as Hume from "../../../index";
  * When provided, the output is a user message.
  */
 export interface UserMessage {
+    /**
+     * The type of message sent through the socket; for a User Message, this must be `user_message`.
+     *
+     * 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.
+     */
+    type: "user_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
+    /** Transcript of the message. */
+    message: Hume.empathicVoice.ChatMessage;
+    /** Inference model results. */
+    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. */
     fromText: boolean;
     /**
@@ -19,16 +31,4 @@ export interface UserMessage {
      * 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: boolean;
-    /** Transcript of the message. */
-    message: Hume.empathicVoice.ChatMessage;
-    /** Inference model results. */
-    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/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.
-     */
-    type: "user_message";
 }

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

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type VoiceProvider = "HUME_AI" | "CUSTOM_VOICE";
+export type VoiceProvider = "HUME_AI" | "CUSTOM_VOICE" | "OCTAVE_COMBINED";
 export declare const VoiceProvider: {
     readonly HumeAi: "HUME_AI";
     readonly CustomVoice: "CUSTOM_VOICE";
+    readonly OctaveCombined: "OCTAVE_COMBINED";
 };

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

@@ -7,4 +7,5 @@ exports.VoiceProvider = void 0;
 exports.VoiceProvider = {
     HumeAi: "HUME_AI",
     CustomVoice: "CUSTOM_VOICE",
+    OctaveCombined: "OCTAVE_COMBINED",
 };

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

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

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

@@ -3,16 +3,16 @@
  */
 import * as Hume from "../../../index";
 export interface WebhookEventChatEnded extends Hume.empathicVoice.WebhookEventBase {
-    /** Phone number of the caller in E.164 format (e.g., `+12223333333`). This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. */
-    callerNumber?: string;
-    /** User-defined session ID. Relevant only when employing a [custom language model](/docs/empathic-voice-interface-evi/custom-language-model) in the EVI Config. */
-    customSessionId?: string;
+    /** Always `chat_ended`. */
+    eventName?: "chat_ended";
+    /** Unix timestamp (in milliseconds) indicating when the session ended. */
+    endTime: number;
     /** Total duration of the session in seconds. */
     durationSeconds: number;
     /** Reason for the session's termination. */
     endReason: Hume.empathicVoice.WebhookEventChatStatus;
-    /** Unix timestamp (in milliseconds) indicating when the session ended. */
-    endTime: number;
-    /** Always `chat_ended`. */
-    eventName?: "chat_ended";
+    /** Phone number of the caller in E.164 format (e.g., `+12223333333`). This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. */
+    callerNumber?: string;
+    /** User-defined session ID. Relevant only when employing a [custom language model](/docs/empathic-voice-interface-evi/custom-language-model) in the EVI Config. */
+    customSessionId?: string;
 }

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

@@ -3,14 +3,14 @@
  */
 import * as Hume from "../../../index";
 export interface WebhookEventChatStarted extends Hume.empathicVoice.WebhookEventBase {
-    /** Phone number of the caller in E.164 format (e.g., `+12223333333`). This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. */
-    callerNumber?: string;
-    /** Indicates whether the chat is the first in a new Chat Group (`new_chat_group`) or the continuation of an existing chat group (`resumed_chat_group`). */
-    chatStartType: Hume.empathicVoice.WebhookEventChatStartType;
-    /** User-defined session ID. Relevant only when employing a [custom language model](/docs/empathic-voice-interface-evi/custom-language-model) in the EVI Config. */
-    customSessionId?: string;
     /** Always `chat_started`. */
     eventName?: "chat_started";
     /** Unix timestamp (in milliseconds) indicating when the session started. */
     startTime: number;
+    /** Indicates whether the chat is the first in a new Chat Group (`new_chat_group`) or the continuation of an existing chat group (`resumed_chat_group`). */
+    chatStartType: Hume.empathicVoice.WebhookEventChatStartType;
+    /** Phone number of the caller in E.164 format (e.g., `+12223333333`). This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. */
+    callerNumber?: string;
+    /** User-defined session ID. Relevant only when employing a [custom language model](/docs/empathic-voice-interface-evi/custom-language-model) in the EVI Config. */
+    customSessionId?: string;
 }