hume 0.15.9 → 0.15.10

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

@@ -3,45 +3,20 @@ 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 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.
-     */
+    /** Stringified JSON with data about emotional content/prosody of the event. */
     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 Event. This field contains the message content for each event type listed in the `type` field. */
+    /** The text of the chat message, either transcribed from speaker audio or generated by the agent. */
     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.
-     * - `AGENT`: The assistant, capable of sending agent messages.
-     * - `SYSTEM`: The backend server, capable of transmitting errors.
-     * - `TOOL`: The function calling mechanism.
-     */
     role: Hume.empathicVoice.ReturnChatEventRole;
-    /** Time at which the Chat Event occurred. Measured in seconds since the Unix epoch. */
+    /** The timestamp when the chat event occurred, formatted as a Unix epoch milliseconds. */
     timestamp: number;
-    /**
-     * Type of Chat Event. There are eleven Chat Event types:
-     * - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
-     * - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
-     * - `USER_RECORDING_START_MESSAGE`: Marks when the client began streaming audio and the start of audio processing.
-     * - `USER_MESSAGE`: A message sent by the user.
-     * - `USER_INTERRUPTION`: A user-initiated interruption while the assistant is speaking.
-     * - `AGENT_MESSAGE`: A response generated by the assistant.
-     * - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
-     * - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or tool.
-     * - `PAUSE_ONSET`: Marks when the client sent a `pause_assistant_message` to pause the assistant.
-     * - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message` to resume the assistant.
-     * - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
-     */
     type: Hume.empathicVoice.ReturnChatEventType;
 }

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

@@ -1,10 +1,3 @@
-/**
- * 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.
- * - `AGENT`: The assistant, capable of sending agent messages.
- * - `SYSTEM`: The backend server, capable of transmitting errors.
- * - `TOOL`: The function calling mechanism.
- */
 export declare const ReturnChatEventRole: {
     readonly User: "USER";
     readonly Agent: "AGENT";

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

@@ -2,13 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatEventRole = void 0;
-/**
- * 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.
- * - `AGENT`: The assistant, capable of sending agent messages.
- * - `SYSTEM`: The backend server, capable of transmitting errors.
- * - `TOOL`: The function calling mechanism.
- */
 exports.ReturnChatEventRole = {
     User: "USER",
     Agent: "AGENT",

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

@@ -1,17 +1,3 @@
-/**
- * Type of Chat Event. There are eleven Chat Event types:
- * - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
- * - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
- * - `USER_RECORDING_START_MESSAGE`: Marks when the client began streaming audio and the start of audio processing.
- * - `USER_MESSAGE`: A message sent by the user.
- * - `USER_INTERRUPTION`: A user-initiated interruption while the assistant is speaking.
- * - `AGENT_MESSAGE`: A response generated by the assistant.
- * - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
- * - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or tool.
- * - `PAUSE_ONSET`: Marks when the client sent a `pause_assistant_message` to pause the assistant.
- * - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message` to resume the assistant.
- * - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
- */
 export declare const ReturnChatEventType: {
     readonly FunctionCall: "FUNCTION_CALL";
     readonly FunctionCallResponse: "FUNCTION_CALL_RESPONSE";

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

@@ -2,20 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatEventType = void 0;
-/**
- * Type of Chat Event. There are eleven Chat Event types:
- * - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
- * - `CHAT_START_MESSAGE`: Marks the beginning of the chat session.
- * - `USER_RECORDING_START_MESSAGE`: Marks when the client began streaming audio and the start of audio processing.
- * - `USER_MESSAGE`: A message sent by the user.
- * - `USER_INTERRUPTION`: A user-initiated interruption while the assistant is speaking.
- * - `AGENT_MESSAGE`: A response generated by the assistant.
- * - `FUNCTION_CALL`: A record of a tool invocation by the assistant.
- * - `FUNCTION_CALL_RESPONSE`: The result of a previously invoked function or tool.
- * - `PAUSE_ONSET`: Marks when the client sent a `pause_assistant_message` to pause the assistant.
- * - `RESUME_ONSET`: Marks when the client sent a `resume_assistant_message` to resume the assistant.
- * - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
- */
 exports.ReturnChatEventType = {
     FunctionCall: "FUNCTION_CALL",
     FunctionCallResponse: "FUNCTION_CALL_RESPONSE",

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

@@ -3,17 +3,16 @@ import type * as Hume from "../../../index.js";
  * A description of chat_group and its status
  */
 export interface ReturnChatGroup {
-    /** 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. */
+    /** The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds. */
     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. */
+    /** Identifier for the chat group. Any chat resumed from this chat 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;
-    /** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
+    /** The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds. */
     mostRecentStartTimestamp: number;
-    /** The total number of Chats in this Chat Group. */
+    /** The total number of chats in this chat group. */
     numChats: number;
 }

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

@@ -9,11 +9,7 @@ export interface ReturnChatGroupPagedAudioReconstructions {
     id: string;
     /** Total number of chats in this chatgroup */
     numChats: number;
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -21,11 +17,6 @@ export interface ReturnChatGroupPagedAudioReconstructions {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructionsPaginationDirection;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatGroupPagedAudioReconstructionsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

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

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatGroupPagedAudioReconstructionsPaginationDirection = void 0;
-/**
- * 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.
- */
 exports.ReturnChatGroupPagedAudioReconstructionsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",

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

@@ -3,23 +3,18 @@ import type * as Hume from "../../../index.js";
  * A description of chat_group and its status with a paginated list of each chat in the chat_group
  */
 export interface ReturnChatGroupPagedChats {
-    /** 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`. */
+    /** List of chats and their metadata returned 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. */
+    /** The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds. */
     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. */
+    /** Identifier for the chat group. Any chat resumed from this chat 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. */
+    /** The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds. */
     mostRecentStartTimestamp: number;
-    /** The total number of Chats associated with this Chat Group. */
+    /** The total number of chats in this chat group. */
     numChats: number;
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -27,11 +22,6 @@ export interface ReturnChatGroupPagedChats {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedChatsPaginationDirection;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatGroupPagedChatsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

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

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatGroupPagedChatsPaginationDirection = void 0;
-/**
- * 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.
- */
 exports.ReturnChatGroupPagedChatsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",

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

@@ -3,15 +3,11 @@ 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 for the specified `page_number` and `page_size`. */
+    /** List of chat_events returned 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. */
+    /** Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID. */
     id: string;
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -19,11 +15,6 @@ export interface ReturnChatGroupPagedEvents {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedEventsPaginationDirection;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatGroupPagedEventsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

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

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatGroupPagedEventsPaginationDirection = void 0;
-/**
- * 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.
- */
 exports.ReturnChatGroupPagedEventsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",

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

@@ -3,22 +3,18 @@ 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;
-    /** 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;
-    /** List of Chat Events for the specified `page_number` and `page_size`. */
+    /** List of chat events with 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 list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -26,29 +22,9 @@ export interface ReturnChatPagedEvents {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnChatPagedEventsPaginationDirection;
-    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
+    /** 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.ReturnChatPagedEventsStatus;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatPagedEventsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

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

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatPagedEventsPaginationDirection = void 0;
-/**
- * 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.
- */
 exports.ReturnChatPagedEventsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",

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

@@ -1,18 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatPagedEventsStatus: {
     readonly Active: "ACTIVE";
     readonly UserEnded: "USER_ENDED";

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

@@ -2,21 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatPagedEventsStatus = void 0;
-/**
- * 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.
- */
 exports.ReturnChatPagedEventsStatus = {
     Active: "ACTIVE",
     UserEnded: "USER_ENDED",

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

@@ -1,18 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnChatStatus: {
     readonly Active: "ACTIVE";
     readonly UserEnded: "USER_ENDED";

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

@@ -2,21 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnChatStatus = void 0;
-/**
- * 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.
- */
 exports.ReturnChatStatus = {
     Active: "ACTIVE",
     UserEnded: "USER_ENDED",

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

@@ -1,15 +1,9 @@
 /**
- * The Config associated with this Chat.
+ * An id/version number for a specific config version
  */
 export interface ReturnConfigSpec {
     /** Identifier for a Config. Formatted as a UUID. */
     id: string;
-    /**
-     * Version number for a Config.
-     *
-     * Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
-     *
-     * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
-     */
+    /** Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique. */
     version?: number;
 }

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

@@ -2,10 +2,6 @@
  * A specific eLLM Model configuration
  */
 export interface ReturnEllmModel {
-    /**
-     * 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/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts

@@ -2,12 +2,8 @@
  * A specific event message configuration to be returned from the server
  */
 export interface ReturnEventMessageSpec {
-    /**
-     * 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/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts

@@ -1,22 +1,9 @@
 import type * as Hume from "../../../index.js";
 /**
- * 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 returned from the server
  */
 export interface ReturnEventMessageSpecs {
-    /**
-     * 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.ReturnEventMessageSpec;
-    /** Specifies the message EVI provides when the chat is disconnected due to reaching the maximum chat duration, such as a message mentioning the time limit for the chat has been reached. */
     onMaxDurationTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;
-    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
     onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
 }

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

@@ -3,14 +3,8 @@ import type * as Hume from "../../../index.js";
  * A specific LanguageModel
  */
 export interface ReturnLanguageModel {
-    /** 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/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts

@@ -3,13 +3,9 @@ import type * as Hume from "../../../index.js";
  * A paginated list of chat_groups returned from the server
  */
 export interface ReturnPagedChatGroups {
-    /** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
+    /** List of chat_groups and their metadata returned for the specified page number and page size. */
     chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
-    /**
-     * The page number of the returned list.
-     *
-     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
-     */
+    /** The page number of the returned results. */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -17,11 +13,6 @@ export interface ReturnPagedChatGroups {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /**
-     * Indicates the order in which the paginated results are presented, based on their creation date.
-     *
-     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
-     */
     paginationDirection: Hume.empathicVoice.ReturnPagedChatGroupsPaginationDirection;
     /** The total number of pages in the collection. */
     totalPages: number;

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

@@ -1,8 +1,3 @@
-/**
- * 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.
- */
 export declare const ReturnPagedChatGroupsPaginationDirection: {
     readonly Asc: "ASC";
     readonly Desc: "DESC";

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

@@ -2,11 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnPagedChatGroupsPaginationDirection = void 0;
-/**
- * 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.
- */
 exports.ReturnPagedChatGroupsPaginationDirection = {
     Asc: "ASC",
     Desc: "DESC",