hume 0.15.11 → 0.15.13

package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts

@@ -5,6 +5,6 @@
  *     }
  */
 export interface PostedUserDefinedToolVersionDescription {
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: string;
 }

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

@@ -1,5 +1,5 @@
 /**
- * When provided, the output is an assistant end message.
+ * **Indicates the conclusion of the assistant's response**, signaling that the assistant has finished speaking for the current conversational turn.
  */
 export interface AssistantEnd {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the input is spoken by EVI.
+ * **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.
  */
 export interface AssistantInput {
     customSessionId?: string;

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

@@ -1,6 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is an assistant message.
+ * **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.
  */
 export interface AssistantMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,6 +1,6 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is an Assistant Prosody message.
+ * **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.
  */
 export interface AssistantProsody {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the input is audio.
+ * **Base64 encoded audio input to insert into the conversation.** The content is treated as the user's speech to EVI and must be streamed continuously. Pre-recorded audio files are not supported.
+ *
+ * For optimal transcription quality, the audio data should be transmitted in small chunks. Hume recommends streaming audio with a buffer window of `20` milliseconds (ms), or `100` milliseconds (ms) for web applications. See our [Audio Guide](/docs/speech-to-speech-evi/guides/audio) for more details on preparing and processing audio.
  */
 export interface AudioInput {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`.
+ * **Base64 encoded audio output.** This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction. The returned audio format is WAV and the sample rate is 48kHz.
+ *
+ * Contains the audio data, an ID to track and reference the audio output, and an index indicating the chunk position relative to the whole audio segment. See our [Audio Guide](/docs/speech-to-speech-evi/guides/audio) for more details on preparing and processing audio.
  */
 export interface AudioOutput {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is a chat metadata message.
+ * **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).
  */
 export interface ChatMetadata {
     /**

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

@@ -7,11 +7,11 @@ export interface ConnectSessionSettings {
      */
     audio?: Hume.empathicVoice.ConnectSessionSettingsAudio;
     /**
-     * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+     * 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 disable context injection.
+     * Set to `null` to clear injected context.
      */
     context?: Hume.empathicVoice.ConnectSessionSettingsContext;
     /**
@@ -22,6 +22,7 @@ export interface ConnectSessionSettings {
      * 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.
@@ -39,6 +40,7 @@ export interface ConnectSessionSettings {
      * For help writing a system prompt, see our [Prompting Guide](/docs/empathic-voice-interface-evi/prompting).
      */
     systemPrompt?: string;
+    /** Allows you to change the voice during an active chat. Updating the voice does not affect chat context or conversation history. */
     voiceId?: string;
     /**
      * This field allows you to assign values to dynamic variables referenced in your system prompt.

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

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

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

@@ -1,30 +1,24 @@
 import type * as Hume from "../../../index.js";
 /**
- * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+ * 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 disable context injection.
+ * Set to `null` to clear injected context.
  */
 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 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](/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;
     /**
      * 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:
+     * - **Temporary**: Context that is only applied to the following assistant response.
      *
-     * - **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`.
+     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
      */
     type?: Hume.empathicVoice.ContextType;
 }

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

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

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

@@ -3,7 +3,7 @@ import type * as Hume from "../../../index.js";
  * A configuration of a built-in tool to be posted to the server
  */
 export interface PostedBuiltinTool {
-    /** Text to use if the tool fails to generate content. */
+    /** 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;
     name: Hume.empathicVoice.PostedBuiltinToolName;
 }

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

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

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

@@ -2,8 +2,12 @@
  * Settings for a specific event_message to be posted to the server
  */
 export interface PostedEventMessageSpec {
-    /** Boolean indicating if this event message is enabled. */
+    /**
+     * 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.
+     */
     enabled: boolean;
-    /** 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 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. */
     text?: string;
 }

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Collection of event_message specs to be posted to the server
+ * 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.
  */
 export interface PostedEventMessageSpecs {
     onInactivityTimeout?: Hume.empathicVoice.PostedEventMessageSpec;

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

@@ -5,6 +5,10 @@ import type * as Hume from "../../../index.js";
 export interface PostedLanguageModel {
     modelProvider?: Hume.empathicVoice.ModelProviderEnum;
     modelResource?: Hume.empathicVoice.LanguageModelType;
-    /** Model temperature. */
+    /**
+     * 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.
+     */
     temperature?: number;
 }

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

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

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

@@ -2,8 +2,12 @@
  * Settings for a specific timeout to be posted to the server
  */
 export interface PostedTimeoutSpec {
-    /** Duration in seconds for the timeout. */
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
     durationSecs?: number;
-    /** Boolean indicating if this event message is enabled. */
+    /**
+     * 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;
 }

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

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Collection of timeout specs to be posted to the server
+ * 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.
  */
 export interface PostedTimeoutSpecs {
     inactivity?: Hume.empathicVoice.PostedTimeoutSpecsInactivity;

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

@@ -1,4 +1,8 @@
-/** Events this URL is subscribed to */
+/**
+ * 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.
+ */
 export declare const PostedWebhookEventType: {
     readonly ChatStarted: "chat_started";
     readonly ChatEnded: "chat_ended";

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

@@ -2,7 +2,11 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostedWebhookEventType = void 0;
-/** Events this URL is subscribed to */
+/**
+ * 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.
+ */
 exports.PostedWebhookEventType = {
     ChatStarted: "chat_started",
     ChatEnded: "chat_ended",

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

@@ -3,8 +3,12 @@ import type * as Hume from "../../../index.js";
  * URL and settings for a specific webhook to be posted to the server
  */
 export interface PostedWebhookSpec {
-    /** Events this URL is subscribed to */
+    /**
+     * 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.PostedWebhookEventType[];
-    /** URL to send the webhook to */
+    /** 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/cjs/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts

@@ -1,5 +1,7 @@
 /**
- * Resume responses from EVI. Chat history sent while paused will now be sent.
+ * **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.
  */
 export interface ResumeAssistantMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

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

@@ -3,9 +3,16 @@ import type * as Hume from "../../../index.js";
  * A specific builtin tool version returned from the server
  */
 export interface ReturnBuiltinTool {
-    /** Text to use if the tool fails to generate content. */
+    /** 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;
-    /** Name applied to all versions of a particular Tool. */
+    /**
+     * 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: string;
     toolType: Hume.empathicVoice.ReturnBuiltinToolToolType;
 }

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

@@ -3,18 +3,18 @@ import type * as Hume from "../../../index.js";
  * 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;
-    /** The timestamp when the chat ended, formatted as a Unix epoch milliseconds. */
+    /** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
     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;
-    /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
     startTimestamp: number;
     status: Hume.empathicVoice.ReturnChatStatus;
 }

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

@@ -3,20 +3,24 @@ import type * as Hume from "../../../index.js";
  * A description of a single event in a chat returned from the server
  */
 export interface ReturnChatEvent {
-    /** Identifier for the chat this event occurred in. Formatted as a UUID. */
+    /** Identifier for the Chat this event occurred in. Formatted as a UUID. */
     chatId: string;
-    /** Stringified JSON with data about emotional content/prosody of the event. */
+    /**
+     * Stringified JSON containing the prosody model inference results.
+     *
+     * EVI uses the prosody model to measure 48 expressions related to speech and vocal characteristics. These results contain a detailed emotional and tonal analysis of the audio. Scores typically range from 0 to 1, with higher values indicating a stronger confidence level in the measured attribute.
+     */
     emotionFeatures?: string;
-    /** Identifier for a chat event. Formatted as a UUID. */
+    /** Identifier for a Chat Event. Formatted as a UUID. */
     id: string;
-    /** The text of the chat message, either transcribed from speaker audio or generated by the agent. */
+    /** The text of the Chat Event. This field contains the message content for each event type listed in the `type` field. */
     messageText?: string;
     /** Stringified JSON with additional metadata about the chat event. */
     metadata?: string;
     /** Identifier for a related chat event. Currently only seen on ASSISTANT_PROSODY events, to point back to the ASSISTANT_MESSAGE that generated these prosody scores */
     relatedEventId?: string;
     role: Hume.empathicVoice.ReturnChatEventRole;
-    /** The timestamp when the chat event occurred, formatted as a Unix epoch milliseconds. */
+    /** Time at which the Chat Event occurred. Measured in seconds since the Unix epoch. */
     timestamp: number;
     type: Hume.empathicVoice.ReturnChatEventType;
 }

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

@@ -4,15 +4,15 @@ import type * as Hume from "../../../index.js";
  */
 export interface ReturnChatGroup {
     active?: boolean;
-    /** The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
     firstStartTimestamp: number;
-    /** 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 Group will have the same `chat_group_id`. Formatted as a UUID. */
     id: string;
-    /** The chat_id of the most recent chat in this chat group. Formatted as a UUID. */
+    /** The `chat_id` of the most recent Chat in this Chat Group. Formatted as a UUID. */
     mostRecentChatId?: string;
     mostRecentConfig?: Hume.empathicVoice.ReturnConfigSpec;
-    /** The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
     mostRecentStartTimestamp: number;
-    /** The total number of chats in this chat group. */
+    /** The total number of Chats associated with this Chat Group. */
     numChats: number;
 }

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

@@ -9,7 +9,11 @@ export interface ReturnChatGroupPagedAudioReconstructions {
     id: string;
     /** Total number of chats in this chatgroup */
     numChats: number;
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

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

@@ -4,17 +4,21 @@ import type * as Hume from "../../../index.js";
  */
 export interface ReturnChatGroupPagedChats {
     active?: boolean;
-    /** List of chats and their metadata returned for the specified page number and page size. */
+    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
     chatsPage: Hume.empathicVoice.ReturnChat[];
-    /** The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
     firstStartTimestamp: number;
-    /** 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 Group will have the same `chat_group_id`. Formatted as a UUID. */
     id: string;
-    /** The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
     mostRecentStartTimestamp: number;
-    /** The total number of chats in this chat group. */
+    /** The total number of Chats associated with this Chat Group. */
     numChats: number;
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

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

@@ -3,11 +3,15 @@ import type * as Hume from "../../../index.js";
  * A paginated list of chat events that occurred across chats in this chat_group from the server
  */
 export interface ReturnChatGroupPagedEvents {
-    /** List of chat_events returned for the specified page number and page size. */
+    /** 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 will have the same chat_group_id. Formatted as a UUID. */
+    /** 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;
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

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

@@ -3,18 +3,22 @@ import type * as Hume from "../../../index.js";
  * A description of chat status with a paginated list of chat events returned from the server
  */
 export interface ReturnChatPagedEvents {
-    /** 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;
-    /** The timestamp when the chat ended, formatted as a Unix epoch milliseconds. */
+    /** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
     endTimestamp?: number;
-    /** List of chat events with the specified page number and page size. */
+    /** List of Chat Events for the specified `page_number` and `page_size`. */
     eventsPage: Hume.empathicVoice.ReturnChatEvent[];
-    /** 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;
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -23,7 +27,7 @@ export interface ReturnChatPagedEvents {
      */
     pageSize: number;
     paginationDirection: Hume.empathicVoice.ReturnChatPagedEventsPaginationDirection;
-    /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
+    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
     startTimestamp: number;
     status: Hume.empathicVoice.ReturnChatPagedEventsStatus;
     /** The total number of pages in the collection. */

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

@@ -3,29 +3,39 @@ import type * as Hume from "../../../index.js";
  * A specific config version returned from the server
  */
 export interface ReturnConfig {
-    /** List of built-in tools associated with this config */
+    /** 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. */
+    /** Time at which the Config was created. Measured in seconds since the Unix epoch. */
     createdOn?: number;
     ellmModel?: Hume.empathicVoice.ReturnEllmModel;
     eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
-    /** The version of the EVI used with this config. */
+    /**
+     * 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;
     /** Identifier for a Config. Formatted as a UUID. */
     id?: string;
     languageModel?: Hume.empathicVoice.ReturnLanguageModel;
-    /** The timestamp when this version of the config was created. */
+    /** Time at which the Config was last modified. Measured in seconds since the Unix epoch. */
     modifiedOn?: number;
     /** Name applied to all versions of a particular Config. */
     name?: string;
     nudges?: Hume.empathicVoice.ReturnNudgeSpec;
     prompt?: Hume.empathicVoice.ReturnPrompt;
     timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
-    /** List of user-defined tools associated with this config. */
+    /** 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 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;
-    /** Description that is appended to a specific version of a Config. */
+    /** An optional description of the Config version. */
     versionDescription?: string;
     voice?: Hume.empathicVoice.ReturnVoice;
     /** Map of webhooks associated with this config. */

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

@@ -1,9 +1,15 @@
 /**
- * An id/version number for a specific config version
+ * The Config associated with this Chat.
  */
 export interface ReturnConfigSpec {
     /** Identifier for a Config. Formatted as a UUID. */
     id: string;
-    /** Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique. */
+    /**
+     * 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;
 }

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

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