hume 0.15.4 → 0.15.6

package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts

@@ -37,32 +37,32 @@ import type * as Hume from "../../../../../../index.mjs";
  *     }
  */
 export interface PostedConfigVersion {
+    /** List of built-in tools associated with this Config version. */
+    builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
+    /**
+     * The eLLM setup associated with this Config version.
+     *
+     * 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.PostedEllmModel;
+    eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
     /** The version of the EVI used with this config. */
     eviVersion: string;
-    /** An optional description of the Config version. */
-    versionDescription?: string;
-    prompt?: Hume.empathicVoice.PostedConfigPromptSpec;
-    /** A voice specification associated with this Config version. */
-    voice?: Hume.empathicVoice.VoiceRef;
     /**
      * The supplemental language model associated with this Config version.
      *
      * This model is used to generate longer, more detailed responses from EVI. Choosing an appropriate supplemental language model for your use case is crucial for generating fast, high-quality responses from EVI.
      */
     languageModel?: Hume.empathicVoice.PostedLanguageModel;
-    /**
-     * The eLLM setup associated with this Config version.
-     *
-     * 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.PostedEllmModel;
+    nudges?: Hume.empathicVoice.PostedNudgeSpec;
+    prompt?: Hume.empathicVoice.PostedConfigPromptSpec;
+    timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
     /** List of user-defined tools associated with this Config version. */
     tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
-    /** List of built-in tools associated with this Config version. */
-    builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
-    eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
-    timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
-    nudges?: Hume.empathicVoice.PostedNudgeSpec;
+    /** An optional description of the Config version. */
+    versionDescription?: string;
+    /** A voice specification associated with this Config version. */
+    voice?: Hume.empathicVoice.VoiceRef;
     /** Webhook config specifications for each subscriber. */
     webhooks?: (Hume.empathicVoice.PostedWebhookSpec | undefined)[];
 }

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts

@@ -8,7 +8,7 @@ export declare namespace ControlPlane {
     interface RequestOptions extends BaseRequestOptions {
     }
     interface ConnectArgs {
-        chatId: string;
+        chat_id: string;
         accessToken?: string | undefined;
         /** Arbitrary headers to send with the websocket connect request. */
         headers?: Record<string, string>;
@@ -38,5 +38,5 @@ export declare class ControlPlane {
     send(chatId: string, request: Hume.empathicVoice.ControlPlanePublishEvent, requestOptions?: ControlPlane.RequestOptions): core.HttpResponsePromise<void>;
     private __send;
     connect(args: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | null | undefined>>;
 }

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs

@@ -98,14 +98,14 @@ export class ControlPlane {
     connect(args) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
-            const { chatId, accessToken, headers, debug, reconnectAttempts } = args;
+            const { chat_id, accessToken, headers, debug, reconnectAttempts } = args;
             const _queryParams = {};
             if (accessToken != null) {
                 _queryParams.access_token = accessToken;
             }
             const _headers = mergeHeaders(mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), headers);
             const socket = new core.ReconnectingWebSocket({
-                url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, `/chat/${core.url.encodePathParam(chatId)}/connect`),
+                url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, `/chat/${core.url.encodePathParam(chat_id)}/connect`),
                 protocols: [],
                 queryParameters: _queryParams,
                 headers: _headers,
@@ -116,8 +116,13 @@ export class ControlPlane {
     }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
-            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
-            return { "X-Hume-Api-Key": apiKeyValue };
+            var _a;
+            const apiKeyValue = core.Supplier.get(this._options.apiKey);
+            // This `authHeaderValue` is manually added as if you don't provide it it will
+            // be omitted from the headers which means it won't reach the logic in ws.ts that
+            // extracts values from the headers and adds them to query parameters.
+            const authHeaderValue = core.Supplier.get((_a = this._options.headers) === null || _a === void 0 ? void 0 : _a.authorization);
+            return { "X-Hume-Api-Key": apiKeyValue, Authorization: authHeaderValue };
         });
     }
 }

package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts

@@ -8,8 +8,6 @@
 export interface PostedPrompt {
     /** Name applied to all versions of a particular Prompt. */
     name: string;
-    /** An optional description of the Prompt version. */
-    versionDescription?: string;
     /**
      * Instructions used to shape EVI's behavior, responses, and style.
      *
@@ -18,4 +16,6 @@ export interface PostedPrompt {
      * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     text: string;
+    /** An optional description of the Prompt version. */
+    versionDescription?: string;
 }

package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts

@@ -6,8 +6,6 @@
  *     }
  */
 export interface PostedPromptVersion {
-    /** An optional description of the Prompt version. */
-    versionDescription?: string;
     /**
      * Instructions used to shape EVI's behavior, responses, and style for this version of the Prompt.
      *
@@ -16,4 +14,6 @@ export interface PostedPromptVersion {
      * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     text: string;
+    /** An optional description of the Prompt version. */
+    versionDescription?: string;
 }

package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts

@@ -9,18 +9,18 @@
  *     }
  */
 export interface PostedUserDefinedTool {
-    /** Name applied to all versions of a particular Tool. */
-    name: string;
-    /** An optional description of the Tool version. */
-    versionDescription?: string;
     /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
     description?: string;
+    /** 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: string;
     /**
      * Stringified JSON defining the parameters used by this version of the Tool.
      *
      * These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the Tool receives data in the expected format.
      */
     parameters: string;
-    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
-    fallbackContent?: string;
+    /** An optional description of the Tool version. */
+    versionDescription?: string;
 }

package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts

@@ -8,16 +8,16 @@
  *     }
  */
 export interface PostedUserDefinedToolVersion {
-    /** An optional description of the Tool version. */
-    versionDescription?: string;
     /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
     description?: string;
+    /** 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;
     /**
      * Stringified JSON defining the parameters used by this version of the Tool.
      *
      * These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the Tool receives data in the expected format.
      */
     parameters: string;
-    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
-    fallbackContent?: string;
+    /** An optional description of the Tool version. */
+    versionDescription?: string;
 }

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

@@ -1,2 +1,25 @@
 import type * as Hume from "../../../index.mjs";
-export type ControlPlanePublishEvent = Hume.empathicVoice.SessionSettings | Hume.empathicVoice.UserInput | Hume.empathicVoice.AssistantInput | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage | Hume.empathicVoice.PauseAssistantMessage | Hume.empathicVoice.ResumeAssistantMessage;
+export type ControlPlanePublishEvent = 
+/**
+ * Settings for this chat session. */
+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
+/**
+ * When provided, the input is spoken by EVI. */
+ | Hume.empathicVoice.AssistantInput
+/**
+ * When provided, the output is a function call response. */
+ | Hume.empathicVoice.ToolResponseMessage
+/**
+ * When provided, the output is a function call error. */
+ | Hume.empathicVoice.ToolErrorMessage
+/**
+ * Pause responses from EVI. Chat history is still saved and sent after resuming.  */
+ | Hume.empathicVoice.PauseAssistantMessage
+/**
+ * Resume responses from EVI. Chat history sent while paused will now be sent.  */
+ | Hume.empathicVoice.ResumeAssistantMessage;

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

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

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

@@ -1,2 +1,32 @@
 import type * as Hume from "../../../index.mjs";
-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;
+export type JsonMessage = 
+/**
+ * When provided, the output is an assistant end message. */
+Hume.empathicVoice.AssistantEnd
+/**
+ * When provided, the output is an assistant message. */
+ | Hume.empathicVoice.AssistantMessage
+/**
+ * When provided, the output is an Assistant Prosody message. */
+ | Hume.empathicVoice.AssistantProsody
+/**
+ * When provided, the output is a chat metadata message. */
+ | Hume.empathicVoice.ChatMetadata
+/**
+ * When provided, the output is an error message. */
+ | Hume.empathicVoice.WebSocketError
+/**
+ * When provided, the output is an interruption. */
+ | Hume.empathicVoice.UserInterruption
+/**
+ * When provided, the output is a user message. */
+ | Hume.empathicVoice.UserMessage
+/**
+ * When provided, the output is a tool call. */
+ | Hume.empathicVoice.ToolCallMessage
+/**
+ * When provided, the output is a function call response. */
+ | Hume.empathicVoice.ToolResponseMessage
+/**
+ * When provided, the output is a function call error. */
+ | Hume.empathicVoice.ToolErrorMessage;

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

@@ -3,6 +3,8 @@ 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. */
+    fallbackContent?: string;
     /**
      * Name of the built-in tool to use. Hume supports the following built-in tools:
      *
@@ -12,6 +14,4 @@ export interface PostedBuiltinTool {
      * 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;
-    /** 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;
 }

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

@@ -4,8 +4,8 @@
 export interface PostedConfigPromptSpec {
     /** Identifier for a Prompt. Formatted as a UUID. */
     id?: string;
-    /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
-    version?: number;
     /** Text used to create a new prompt for a particular config. */
     text?: string;
+    /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
+    version?: number;
 }

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

@@ -5,8 +5,6 @@ import type * as Hume from "../../../index.mjs";
  * Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
  */
 export interface PostedEventMessageSpecs {
-    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
-    onNewChat?: Hume.empathicVoice.PostedEventMessageSpec;
     /**
      * Specifies the message EVI provides when the chat is about to be disconnected due to a user inactivity timeout, such as a message mentioning a lack of user input for a period of time.
      *
@@ -19,4 +17,6 @@ export interface PostedEventMessageSpecs {
     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/PostedTimeoutSpec.d.mts

@@ -2,8 +2,8 @@
  * Settings for a specific timeout to be posted to the server
  */
 export interface PostedTimeoutSpec {
-    /** Boolean indicating if this event message is enabled. */
-    enabled: boolean;
     /** Duration in seconds for the timeout. */
     durationSecs?: number;
+    /** Boolean indicating if this event message is enabled. */
+    enabled: boolean;
 }

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

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

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

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

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

@@ -3,12 +3,12 @@ import type * as Hume from "../../../index.mjs";
  * URL and settings for a specific webhook to be posted to the server
  */
 export interface PostedWebhookSpec {
-    /** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
-    url: string;
     /**
      * The list of events the specified URL is subscribed to.
      *
      * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
      */
     events: Hume.empathicVoice.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: string;
 }

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

@@ -3,10 +3,10 @@ import type * as Hume from "../../../index.mjs";
  * A specific builtin tool version returned from the server
  */
 export interface ReturnBuiltinTool {
-    /** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
-    toolType: Hume.empathicVoice.ReturnBuiltinToolToolType;
-    /** Name applied to all versions of a particular Tool. */
-    name: string;
     /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
     fallbackContent?: string;
+    /** 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/ReturnChat.d.mts

@@ -3,10 +3,19 @@ import type * as Hume from "../../../index.mjs";
  * A description of chat and its status
  */
 export interface ReturnChat {
-    /** Identifier for a Chat. Formatted as a UUID. */
-    id: string;
     /** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
     chatGroupId: string;
+    config?: Hume.empathicVoice.ReturnConfigSpec;
+    /** 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. */
+    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. */
+    startTimestamp: number;
     /**
      * Indicates the current state of the chat. There are six possible statuses:
      *
@@ -23,13 +32,4 @@ export interface ReturnChat {
      * - `ERROR`: The chat ended unexpectedly due to an error.
      */
     status: Hume.empathicVoice.ReturnChatStatus;
-    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
-    startTimestamp: number;
-    /** 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;
-    /** Stringified JSON with additional metadata about the chat. */
-    metadata?: string;
-    config?: Hume.empathicVoice.ReturnConfigSpec;
 }

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

@@ -3,10 +3,16 @@ import type * as Hume from "../../../index.mjs";
  * List of chat audio reconstructions returned for the specified page number and page size.
  */
 export interface ReturnChatAudioReconstruction {
+    /** Name of the chat audio reconstruction file. */
+    filename?: string;
     /** Identifier for the chat. Formatted as a UUID. */
     id: string;
-    /** Identifier for the user that owns this chat. Formatted as a UUID. */
-    userId: string;
+    /** The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch. */
+    modifiedAt?: number;
+    /** Signed URL used to download the chat audio reconstruction file. */
+    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:
      *
@@ -21,12 +27,6 @@ export interface ReturnChatAudioReconstruction {
      * - `CANCELED`: The reconstruction job has been canceled.
      */
     status: Hume.empathicVoice.ReturnChatAudioReconstructionStatus;
-    /** Name of the chat audio reconstruction file. */
-    filename?: string;
-    /** The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch. */
-    modifiedAt?: number;
-    /** Signed URL used to download the chat audio reconstruction file. */
-    signedAudioUrl?: string;
-    /** The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds. */
-    signedUrlExpirationTimestampMillis?: number;
+    /** Identifier for the user that owns this chat. Formatted as a UUID. */
+    userId: string;
 }

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

@@ -3,12 +3,22 @@ import type * as Hume from "../../../index.mjs";
  * A description of a single event in a chat returned from the server
  */
 export interface ReturnChatEvent {
-    /** Identifier for a Chat Event. Formatted as a UUID. */
-    id: string;
     /** Identifier for the Chat this event occurred in. Formatted as a UUID. */
     chatId: string;
-    /** Time at which the Chat Event occurred. Measured in seconds since the Unix epoch. */
-    timestamp: number;
+    /**
+     * 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. */
+    id: string;
+    /** 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;
     /**
      * The role of the entity which generated the Chat Event. There are four possible values:
      * - `USER`: The user, capable of sending user messages and interruptions.
@@ -17,6 +27,8 @@ export interface ReturnChatEvent {
      * - `TOOL`: The function calling mechanism.
      */
     role: Hume.empathicVoice.ReturnChatEventRole;
+    /** Time at which the Chat Event occurred. Measured in seconds since the Unix epoch. */
+    timestamp: number;
     /**
      * Type of Chat Event. There are eleven Chat Event types:
      * - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
@@ -32,16 +44,4 @@ export interface ReturnChatEvent {
      * - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
      */
     type: Hume.empathicVoice.ReturnChatEventType;
-    /** 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 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;
-    /** 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;
 }

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

@@ -3,17 +3,17 @@ import type * as Hume from "../../../index.mjs";
  * A description of chat_group and its status
  */
 export interface ReturnChatGroup {
-    /** 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;
+    /** Denotes whether there is an active Chat associated with this Chat Group. */
+    active?: boolean;
     /** Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
     firstStartTimestamp: number;
-    /** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
-    mostRecentStartTimestamp: number;
+    /** 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. */
     mostRecentChatId?: string;
     mostRecentConfig?: Hume.empathicVoice.ReturnConfigSpec;
+    /** 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. */
     numChats: number;
-    /** Denotes whether there is an active Chat associated with this Chat Group. */
-    active?: boolean;
 }

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

@@ -3,10 +3,10 @@ import type * as Hume from "../../../index.mjs";
  * A paginated list of chat reconstructions for a particular chatgroup
  */
 export interface ReturnChatGroupPagedAudioReconstructions {
+    /** List of chat audio reconstructions returned for the specified page number and page size. */
+    audioReconstructionsPage: Hume.empathicVoice.ReturnChatAudioReconstruction[];
     /** Identifier for the chat group. Formatted as a UUID. */
     id: string;
-    /** Identifier for the user that owns this chat. Formatted as a UUID. */
-    userId: string;
     /** Total number of chats in this chatgroup */
     numChats: number;
     /**
@@ -21,14 +21,14 @@ export interface ReturnChatGroupPagedAudioReconstructions {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: number;
     /**
      * Indicates the order in which the paginated results are presented, based on their creation date.
      *
      * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
      */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructionsPaginationDirection;
-    /** List of chat audio reconstructions returned for the specified page number and page size. */
-    audioReconstructionsPage: Hume.empathicVoice.ReturnChatAudioReconstruction[];
+    /** The total number of pages in the collection. */
+    totalPages: number;
+    /** Identifier for the user that owns this chat. Formatted as a UUID. */
+    userId: string;
 }

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

@@ -3,10 +3,14 @@ import type * as Hume from "../../../index.mjs";
  * A description of chat_group and its status with a paginated list of each chat in the chat_group
  */
 export interface ReturnChatGroupPagedChats {
-    /** 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;
+    /** Denotes whether there is an active Chat associated with this Chat Group. */
+    active?: boolean;
+    /** List of Chats for the specified `page_number` and `page_size`. */
+    chatsPage: Hume.empathicVoice.ReturnChat[];
     /** 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 Group will have the same `chat_group_id`. Formatted as a UUID. */
+    id: string;
     /** 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 associated with this Chat Group. */
@@ -23,16 +27,12 @@ export interface ReturnChatGroupPagedChats {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: number;
     /**
      * Indicates the order in which the paginated results are presented, based on their creation date.
      *
      * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
      */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedChatsPaginationDirection;
-    /** List of Chats for the specified `page_number` and `page_size`. */
-    chatsPage: Hume.empathicVoice.ReturnChat[];
-    /** Denotes whether there is an active Chat associated with this Chat Group. */
-    active?: boolean;
+    /** The total number of pages in the collection. */
+    totalPages: number;
 }

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

@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.mjs";
  * A paginated list of chat events that occurred across chats in this chat_group from the server
  */
 export interface ReturnChatGroupPagedEvents {
+    /** List of Chat Events for the specified `page_number` and `page_size`. */
+    eventsPage: Hume.empathicVoice.ReturnChatEvent[];
     /** Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same `chat_group_id`. Formatted as a UUID. */
     id: string;
     /**
@@ -17,14 +19,12 @@ export interface ReturnChatGroupPagedEvents {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** The total number of pages in the collection. */
-    totalPages: number;
     /**
      * Indicates the order in which the paginated results are presented, based on their creation date.
      *
      * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
      */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedEventsPaginationDirection;
-    /** List of Chat Events for the specified `page_number` and `page_size`. */
-    eventsPage: Hume.empathicVoice.ReturnChatEvent[];
+    /** The total number of pages in the collection. */
+    totalPages: number;
 }