hume 0.15.8 → 0.15.10

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

@@ -1,15 +1,13 @@
 /**
- * **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).
+ * When provided, the output is a chat metadata message.
  */
 export interface ChatMetadata {
     /**
      * ID of the Chat Group.
      *
-     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/speech-to-speech-evi/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
+     * Used to resume a Chat when passed in the [resumed_chat_group_id](/reference/empathic-voice-interface-evi/chat/chat#request.query.resumed_chat_group_id) query parameter of a subsequent connection request. This allows EVI to continue the conversation from where it left off within the Chat Group.
      *
-     * Learn more about [supporting chat resumability](/docs/speech-to-speech-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
+     * Learn more about [supporting chat resumability](/docs/empathic-voice-interface-evi/faq#does-evi-support-chat-resumability) from the EVI FAQ.
      */
     chatGroupId: string;
     /** ID of the Chat session. Allows the Chat session to be tracked and referenced. */

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

@@ -14,9 +14,14 @@ export interface ConnectSessionSettings {
      * Set to `null` to disable context injection.
      */
     context?: Hume.empathicVoice.ConnectSessionSettingsContext;
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    /**
+     * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
+     *
+     * If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
+     *
+     * It is recommended to pass a `custom_session_id` if you are using a Custom Language Model. Please see our guide to [using a custom language model](/docs/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
+     */
     customSessionId?: string;
-    /** The maximum number of chat events to return from chat history. By default, the system returns up to 300 events (100 events per page × 3 pages). Set this parameter to a smaller value to limit the number of events returned. */
     eventLimit?: number;
     /**
      * Third party API key for the supplemental language model.
@@ -31,10 +36,9 @@ export interface ConnectSessionSettings {
      *
      * 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;
-    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this EVI session. This will override the speaker set in the selected configuration. */
     voiceId?: string;
     /**
      * This field allows you to assign values to dynamic variables referenced in your system prompt.

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

@@ -5,10 +5,10 @@ import type * as Hume from "../../../index.mjs";
  * 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.
  */
 export interface ConnectSessionSettingsAudio {
-    /** Sets number of audio channels for audio input. */
+    /** Number of audio channels. */
     channels?: number;
-    /** Sets encoding format of the audio input, such as `linear16`. */
+    /** Encoding format of the audio input, such as `linear16`. */
     encoding?: Hume.empathicVoice.Encoding;
-    /** Sets the sample rate for audio input. (Number of samples per second in the audio input, measured in Hertz.) */
+    /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */
     sampleRate?: number;
 }

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

@@ -10,15 +10,21 @@ export interface ConnectSessionSettingsContext {
     /**
      * 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}`.
+     * 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.
      *
-     * - **Temporary**: Context that is only applied to the following assistant response.
+     * There are three possible context types:
      *
-     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
+     * - **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.
+     *
+     *  - **Editable**: The original context is updated to reflect the new context.
+     *
+     *  If the type is not specified, it will default to `temporary`.
      */
     type?: Hume.empathicVoice.ContextType;
 }

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

@@ -3,15 +3,21 @@ 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](/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}`.
+     * 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.
      *
-     * - **Temporary**: Context that is only applied to the following assistant response.
+     * There are three possible context types:
      *
-     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
+     * - **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.
+     *
+     *  - **Editable**: The original context is updated to reflect the new context.
+     *
+     *  If the type is not specified, it will default to `temporary`.
      */
     type?: Hume.empathicVoice.ContextType;
 }

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

@@ -1,37 +1,2 @@
 import type * as Hume from "../../../index.mjs";
-export type ControlPlanePublishEvent = 
-/**
- * **Settings for this chat session.** Session settings are temporary and apply only to the current Chat session.
- *
- * These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings. */
-Hume.empathicVoice.SessionSettings
-/**
- * **User text to insert into the conversation.** Text sent through a User Input message is treated as the user's speech to EVI. EVI processes this input and provides a corresponding response.
- *
- * Expression measurement results are not available for User Input messages, as the prosody model relies on audio input and cannot process text alone. */
- | Hume.empathicVoice.UserInput
-/**
- * **Assistant text to synthesize into spoken audio and insert into the conversation.** EVI uses this text to generate spoken audio using our proprietary expressive text-to-speech model.
- *
- * Our model adds appropriate emotional inflections and tones to the text based on the user's expressions and the context of the conversation. The synthesized audio is streamed back to the user as an Assistant Message. */
- | Hume.empathicVoice.AssistantInput
-/**
- * **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
-/**
- * **Pause responses from EVI.** Chat history is still saved and sent after resuming. Once this message is sent, EVI will not respond until a Resume Assistant message is sent.
- *
- * When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details. */
- | Hume.empathicVoice.PauseAssistantMessage
-/**
- * **Resume responses from EVI.** Chat history sent while paused will now be sent.
- *
- * Upon resuming, if any audio input was sent during the pause, EVI will retain context from all messages sent but only respond to the last user message. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details. */
- | Hume.empathicVoice.ResumeAssistantMessage;
+export type ControlPlanePublishEvent = Hume.empathicVoice.SessionSettings | Hume.empathicVoice.UserInput | Hume.empathicVoice.AssistantInput | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage | Hume.empathicVoice.PauseAssistantMessage | Hume.empathicVoice.ResumeAssistantMessage;

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

@@ -1,51 +1,2 @@
 import type * as Hume from "../../../index.mjs";
-export type JsonMessage = 
-/**
- * **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
-/**
- * **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 JsonMessage = Hume.empathicVoice.AssistantEnd | Hume.empathicVoice.AssistantMessage | Hume.empathicVoice.AssistantProsody | 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/esm/api/resources/empathicVoice/types/PauseAssistantMessage.d.mts

@@ -1,7 +1,5 @@
 /**
- * **Pause responses from EVI.** Chat history is still saved and sent after resuming. Once this message is sent, EVI will not respond until a Resume Assistant message is sent.
- *
- * When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details.
+ * 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. */
@@ -9,7 +7,7 @@ export interface PauseAssistantMessage {
     /**
      * The type of message sent through the socket; must be `pause_assistant_message` for our server to correctly identify and process it as a Pause Assistant message.
      *
-     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/speech-to-speech-evi/chat#send.ResumeAssistantMessage) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
+     * Once this message is sent, EVI will not respond until a [Resume Assistant message](/reference/empathic-voice-interface-evi/chat/chat#send.Resume%20Assistant%20Message.type) is sent. When paused, EVI won't respond, but transcriptions of your audio inputs will still be recorded.
      */
     type: "pause_assistant_message";
 }

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

@@ -3,15 +3,7 @@ import type * as Hume from "../../../index.mjs";
  * A configuration of a built-in tool to be posted to the server
  */
 export interface PostedBuiltinTool {
-    /** 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;
-    /**
-     * Name of the built-in tool to use. Hume supports the following built-in tools:
-     *
-     * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
-     * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
-     *
-     * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
-     */
     name: Hume.empathicVoice.PostedBuiltinToolName;
 }

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

@@ -1,11 +1,3 @@
-/**
- * Name of the built-in tool to use. Hume supports the following built-in tools:
- *
- * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
- * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
- *
- * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
- */
 export declare const PostedBuiltinToolName: {
     readonly WebSearch: "web_search";
     readonly HangUp: "hang_up";

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

@@ -1,12 +1,4 @@
 // This file was auto-generated by Fern from our API Definition.
-/**
- * Name of the built-in tool to use. Hume supports the following built-in tools:
- *
- * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
- * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
- *
- * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
- */
 export const PostedBuiltinToolName = {
     WebSearch: "web_search",
     HangUp: "hang_up",

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

@@ -2,10 +2,6 @@
  * A eLLM model configuration to be posted to the server
  */
 export interface PostedEllmModel {
-    /**
-     * Boolean indicating if the eLLM is allowed to generate short responses.
-     *
-     * If omitted, short responses from the eLLM are enabled by default.
-     */
+    /** Boolean indicating if the model is allowed to generate short responses. */
     allowShortResponses?: boolean;
 }

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

@@ -2,12 +2,8 @@
  * Settings for a specific event_message to be posted to the server
  */
 export interface PostedEventMessageSpec {
-    /**
-     * Boolean indicating if this event message is enabled.
-     *
-     * If set to `true`, a message will be sent when the circumstances for the specific event are met.
-     */
+    /** Boolean indicating if this event message is enabled. */
     enabled: boolean;
-    /** Text to use as the event message when the corresponding event occurs. If no text is specified, EVI will generate an appropriate message based on its current context and the system prompt. */
+    /** Optional text that will be used as a verbatim event message. If the text is null and the event message is enabled, the system will generate a message based using the language model. */
     text?: string;
 }

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

@@ -1,22 +1,9 @@
 import type * as Hume from "../../../index.mjs";
 /**
- * Collection of event messages returned by the server.
- *
- * 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.
+ * Collection of event_message specs to be posted to the server
  */
 export interface PostedEventMessageSpecs {
-    /**
-     * 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.
-     *
-     * Enabling an inactivity message allows developers to use this message event for "checking in" with the user if they are not responding to see if they are still active.
-     *
-     * If the user does not respond in the number of seconds specified in the `inactivity_timeout` field, then EVI will say the message and the user has 15 seconds to respond. If they respond in time, the conversation will continue; if not, the conversation will end.
-     *
-     * However, if the inactivity message is not enabled, then reaching the inactivity timeout will immediately end the connection.
-     */
     onInactivityTimeout?: Hume.empathicVoice.PostedEventMessageSpec;
-    /** 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.PostedEventMessageSpec;
-    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
     onNewChat?: Hume.empathicVoice.PostedEventMessageSpec;
 }

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

@@ -3,14 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * A LanguageModel to be posted to the server
  */
 export interface PostedLanguageModel {
-    /** The provider of the supplemental language model. */
     modelProvider?: Hume.empathicVoice.ModelProviderEnum;
-    /** String that specifies the language model to use with `model_provider`. */
     modelResource?: Hume.empathicVoice.LanguageModelType;
-    /**
-     * The model temperature, with values between 0 to 1 (inclusive).
-     *
-     * Controls the randomness of the LLM's output, with values closer to 0 yielding focused, deterministic responses and values closer to 1 producing more creative, diverse responses.
-     */
+    /** Model temperature. */
     temperature?: number;
 }

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

@@ -2,8 +2,8 @@
  * A nudge specification posted to the server
  */
 export interface PostedNudgeSpec {
-    /** If true, EVI will 'nudge' the user to speak after a determined interval of silence. */
+    /** EVI will nudge user after inactivity */
     enabled?: boolean;
-    /** The interval of inactivity (in seconds) before a nudge is triggered. */
+    /** Time interval in seconds after which the nudge will be sent. */
     intervalSecs?: number;
 }

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

@@ -1,20 +1,8 @@
 import type * as Hume from "../../../index.mjs";
 /**
- * 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 posted to the server
  */
 export interface PostedTimeoutSpecs {
-    /**
-     * 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.PostedTimeoutSpecsInactivity;
-    /**
-     * 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.PostedTimeoutSpecsMaxDuration;
 }

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

@@ -1,15 +1,4 @@
-/**
- * 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.
- */
 export interface PostedTimeoutSpecsInactivity {
-    /** 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 of user inactivity 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;
 }

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

@@ -1,15 +1,4 @@
-/**
- * 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.
- */
 export interface PostedTimeoutSpecsMaxDuration {
-    /** 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 maximum 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;
 }

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

@@ -4,12 +4,6 @@
 export interface PostedUserDefinedToolSpec {
     /** Identifier for a Tool. Formatted as a UUID. */
     id: string;
-    /**
-     * 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;
 }

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

@@ -3,12 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * URL and settings for a specific webhook to be posted to the server
  */
 export interface PostedWebhookSpec {
-    /**
-     * 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.PostedWebhookEventType[];
-    /** 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 to send the webhook to */
     url: string;
 }

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

@@ -1,7 +1,5 @@
 /**
- * **Resume responses from EVI.** Chat history sent while paused will now be sent.
- *
- * Upon resuming, if any audio input was sent during the pause, EVI will retain context from all messages sent but only respond to the last user message. See our [Pause Response Guide](/docs/speech-to-speech-evi/features/pause-responses) for further details.
+ * 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. */

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

@@ -3,10 +3,9 @@ import type * as Hume from "../../../index.mjs";
  * A specific builtin tool version returned from the server
  */
 export interface ReturnBuiltinTool {
-    /** 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;
     /** Name applied to all versions of a particular Tool. */
     name: string;
-    /** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
     toolType: Hume.empathicVoice.ReturnBuiltinToolToolType;
 }

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

@@ -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 ReturnBuiltinToolToolType: {
     readonly Builtin: "BUILTIN";
     readonly Function: "FUNCTION";

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

@@ -1,5 +1,4 @@
 // This file was auto-generated by Fern from our API Definition.
-/** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
 export const ReturnBuiltinToolToolType = {
     Builtin: "BUILTIN",
     Function: "FUNCTION",

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

@@ -3,33 +3,18 @@ import type * as Hume from "../../../index.mjs";
  * A description of chat and its status
  */
 export interface ReturnChat {
-    /** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
+    /** Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID. */
     chatGroupId: string;
     config?: Hume.empathicVoice.ReturnConfigSpec;
-    /** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
+    /** The timestamp when the chat ended, formatted as a Unix epoch milliseconds. */
     endTimestamp?: number;
     /** The total number of events currently in this chat. */
     eventCount?: number;
-    /** Identifier for a Chat. Formatted as a UUID. */
+    /** Identifier for a chat. Formatted as a UUID. */
     id: string;
     /** Stringified JSON with additional metadata about the chat. */
     metadata?: string;
-    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
+    /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
     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.ReturnChatStatus;
 }

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

@@ -13,19 +13,6 @@ export interface ReturnChatAudioReconstruction {
     signedAudioUrl?: string;
     /** The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds. */
     signedUrlExpirationTimestampMillis?: number;
-    /**
-     * Indicates the current state of the audio reconstruction job. There are five possible statuses:
-     *
-     * - `QUEUED`: The reconstruction job is waiting to be processed.
-     *
-     * - `IN_PROGRESS`: The reconstruction is currently being processed.
-     *
-     * - `COMPLETE`: The audio reconstruction is finished and ready for download.
-     *
-     * - `ERROR`: An error occurred during the reconstruction process.
-     *
-     * - `CANCELED`: The reconstruction job has been canceled.
-     */
     status: Hume.empathicVoice.ReturnChatAudioReconstructionStatus;
     /** Identifier for the user that owns this chat. Formatted as a UUID. */
     userId: string;

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

@@ -1,16 +1,3 @@
-/**
- * Indicates the current state of the audio reconstruction job. There are five possible statuses:
- *
- * - `QUEUED`: The reconstruction job is waiting to be processed.
- *
- * - `IN_PROGRESS`: The reconstruction is currently being processed.
- *
- * - `COMPLETE`: The audio reconstruction is finished and ready for download.
- *
- * - `ERROR`: An error occurred during the reconstruction process.
- *
- * - `CANCELED`: The reconstruction job has been canceled.
- */
 export declare const ReturnChatAudioReconstructionStatus: {
     readonly Queued: "QUEUED";
     readonly InProgress: "IN_PROGRESS";

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

@@ -1,17 +1,4 @@
 // This file was auto-generated by Fern from our API Definition.
-/**
- * Indicates the current state of the audio reconstruction job. There are five possible statuses:
- *
- * - `QUEUED`: The reconstruction job is waiting to be processed.
- *
- * - `IN_PROGRESS`: The reconstruction is currently being processed.
- *
- * - `COMPLETE`: The audio reconstruction is finished and ready for download.
- *
- * - `ERROR`: An error occurred during the reconstruction process.
- *
- * - `CANCELED`: The reconstruction job has been canceled.
- */
 export const ReturnChatAudioReconstructionStatus = {
     Queued: "QUEUED",
     InProgress: "IN_PROGRESS",