hume 0.8.4 → 0.8.6

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

@@ -1,14 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
  * A specific builtin tool version returned from the server
  */
 export interface ReturnBuiltinTool {
-    /** Type of Tool. Values from the ToolType enum. */
-    toolType: string;
+    /** 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;
-    /** 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;
 }

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

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

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnBuiltinToolToolType = void 0;
+exports.ReturnBuiltinToolToolType = {
+    Builtin: 'BUILTIN',
+    Function: 'FUNCTION',
+};

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

@@ -6,17 +6,29 @@ import * as Hume from '../../../index';
  * A description of chat and its status
  */
 export interface ReturnChat {
-    /** Identifier for a chat. Formatted as a UUID. */
+    /** 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. */
+    /** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
     chatGroupId: string;
-    /** Optional tag applied to this chat used to group chats by user, application, etc. */
-    tag?: string;
-    /** The status of the chat. Values from the ChatStatus enum. */
-    status: string;
-    /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
+    /**
+     * Indicates the current state of the chat. There are six possible statuses:
+     *
+     * - `ACTIVE`: The chat is currently active and ongoing.
+     *
+     * - `USER_ENDED`: The chat was manually ended by the user.
+     *
+     * - `USER_TIMEOUT`: The chat ended due to a user-defined timeout.
+     *
+     * - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum allowed duration.
+     *
+     * - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout.
+     *
+     * - `ERROR`: The chat ended unexpectedly due to an error.
+     */
+    status: Hume.empathicVoice.ReturnChatStatus;
+    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
     startTimestamp: number;
-    /** 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;

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

@@ -1,23 +1,52 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
  * 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. */
+    /** Identifier for a Chat Event. Formatted as a UUID. */
     id: string;
-    /** 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;
-    /** 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;
-    /** The role of the user who generated the chat event. Values from the Role enum. */
-    role: string;
-    /** The type of chat event. Values from the ChatEventType enum. */
-    type: string;
-    /** The text of the chat message, either transcribed from speaker audio or generated by the agent. */
+    /**
+     * 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;
+    /**
+     * Type of Chat Event. There are six possible values:
+     *
+     * - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
+     *
+     * - `USER_MESSAGE`: Contains the message sent by the user.
+     *
+     * - `USER_INTERRUPTION`: Contains an interruption made by the user while the agent is speaking.
+     *
+     * - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s eLLM and supplemental LLM.
+     *
+     * - `FUNCTION_CALL`: Contains the invocation of a tool.
+     *
+     * - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
+     */
+    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 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;
     /** Stringified JSON with additional metadata about the chat event. */
     metadata?: string;

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 type ReturnChatEventRole = 'USER' | 'AGENT' | 'SYSTEM' | 'TOOL';
+export declare const ReturnChatEventRole: {
+    readonly User: "USER";
+    readonly Agent: "AGENT";
+    readonly System: "SYSTEM";
+    readonly Tool: "TOOL";
+};

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

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatEventRole = void 0;
+exports.ReturnChatEventRole = {
+    User: 'USER',
+    Agent: 'AGENT',
+    System: 'SYSTEM',
+    Tool: 'TOOL',
+};

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Type of Chat Event. There are six possible values:
+ *
+ * - `SYSTEM_PROMPT`: Contains the system prompt for use in the session.
+ *
+ * - `USER_MESSAGE`: Contains the message sent by the user.
+ *
+ * - `USER_INTERRUPTION`: Contains an interruption made by the user while the agent is speaking.
+ *
+ * - `AGENT_MESSAGE`: Contains the assistant’s message, generated by Hume’s eLLM and supplemental LLM.
+ *
+ * - `FUNCTION_CALL`: Contains the invocation of a tool.
+ *
+ * - `FUNCTION_CALL_RESPONSE`: Contains the tool response.
+ */
+export declare type ReturnChatEventType = 'SYSTEM_PROMPT' | 'USER_MESSAGE' | 'USER_INTERRUPTION' | 'AGENT_MESSAGE' | 'FUNCTION_CALL' | 'FUNCTION_CALL_RESPONSE';
+export declare const ReturnChatEventType: {
+    readonly SystemPrompt: "SYSTEM_PROMPT";
+    readonly UserMessage: "USER_MESSAGE";
+    readonly UserInterruption: "USER_INTERRUPTION";
+    readonly AgentMessage: "AGENT_MESSAGE";
+    readonly FunctionCall: "FUNCTION_CALL";
+    readonly FunctionCallResponse: "FUNCTION_CALL_RESPONSE";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatEventType = void 0;
+exports.ReturnChatEventType = {
+    SystemPrompt: 'SYSTEM_PROMPT',
+    UserMessage: 'USER_MESSAGE',
+    UserInterruption: 'USER_INTERRUPTION',
+    AgentMessage: 'AGENT_MESSAGE',
+    FunctionCall: 'FUNCTION_CALL',
+    FunctionCallResponse: 'FUNCTION_CALL_RESPONSE',
+};

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

@@ -5,15 +5,15 @@
  * A description of chat_group and its status
  */
 export interface ReturnChatGroup {
-    /** 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 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;
-    /** 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 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;
-    /** The total number of chats in this chat group. */
+    /** The total number of Chats in this Chat Group. */
     numChats: number;
     active?: boolean;
 }

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

@@ -6,16 +6,28 @@ import * as Hume from '../../../index';
  * A paginated list of chat events that occurred across chats in this chat_group from the server
  */
 export interface ReturnChatGroupPagedEvents {
-    /** 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 number of results returned per page. */
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
     pageSize: number;
-    /** The total number of pages in the collection */
+    /** The total number of pages in the collection. */
     totalPages: number;
-    /** The direction of the pagination (ASC or DESC). */
-    paginationDirection: string;
-    /** List of chat_events returned for the specified page number and page size. */
+    /**
+     * 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[];
 }

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 type ReturnChatGroupPagedEventsPaginationDirection = 'ASC' | 'DESC';
+export declare const ReturnChatGroupPagedEventsPaginationDirection: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatGroupPagedEventsPaginationDirection = void 0;
+exports.ReturnChatGroupPagedEventsPaginationDirection = {
+    Asc: 'ASC',
+    Desc: 'DESC',
+};

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

@@ -6,29 +6,53 @@ import * as Hume from '../../../index';
  * A description of chat status with a paginated list of chat events returned from the server
  */
 export interface ReturnChatPagedEvents {
-    /** Identifier for a chat. Formatted as a UUID. */
+    /** 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. */
+    /** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
     chatGroupId: string;
-    /** Optional tag applied to this chat used to group chats by user, application, etc. */
-    tag?: string;
-    /** The status of the chat. Values from the ChatStatus enum. */
-    status: string;
-    /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
+    /**
+     * 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;
+    /** Time at which the Chat started. Measured in seconds since the Unix epoch. */
     startTimestamp: number;
-    /** 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 direction of the pagination (ASC or DESC). */
-    paginationDirection: string;
-    /** List of chat events with the specified page number and page size. */
+    /**
+     * 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;
+    /** List of Chat Events for the specified `page_number` and `page_size`. */
     eventsPage: Hume.empathicVoice.ReturnChatEvent[];
     /** 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 number of results returned per page. */
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
     pageSize: number;
-    /** The total number of pages in the collection */
+    /** The total number of pages in the collection. */
     totalPages: number;
     config?: Hume.empathicVoice.ReturnConfigSpec;
 }

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 type ReturnChatPagedEventsPaginationDirection = 'ASC' | 'DESC';
+export declare const ReturnChatPagedEventsPaginationDirection: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatPagedEventsPaginationDirection = void 0;
+exports.ReturnChatPagedEventsPaginationDirection = {
+    Asc: 'ASC',
+    Desc: 'DESC',
+};

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 type ReturnChatPagedEventsStatus = 'ACTIVE' | 'USER_ENDED' | 'USER_TIMEOUT' | 'MAX_DURATION_TIMEOUT' | 'INACTIVITY_TIMEOUT' | 'ERROR';
+export declare const ReturnChatPagedEventsStatus: {
+    readonly Active: "ACTIVE";
+    readonly UserEnded: "USER_ENDED";
+    readonly UserTimeout: "USER_TIMEOUT";
+    readonly MaxDurationTimeout: "MAX_DURATION_TIMEOUT";
+    readonly InactivityTimeout: "INACTIVITY_TIMEOUT";
+    readonly Error: "ERROR";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatPagedEventsStatus = void 0;
+exports.ReturnChatPagedEventsStatus = {
+    Active: 'ACTIVE',
+    UserEnded: 'USER_ENDED',
+    UserTimeout: 'USER_TIMEOUT',
+    MaxDurationTimeout: 'MAX_DURATION_TIMEOUT',
+    InactivityTimeout: 'INACTIVITY_TIMEOUT',
+    Error: 'ERROR',
+};

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 type ReturnChatStatus = 'ACTIVE' | 'USER_ENDED' | 'USER_TIMEOUT' | 'MAX_DURATION_TIMEOUT' | 'INACTIVITY_TIMEOUT' | 'ERROR';
+export declare const ReturnChatStatus: {
+    readonly Active: "ACTIVE";
+    readonly UserEnded: "USER_ENDED";
+    readonly UserTimeout: "USER_TIMEOUT";
+    readonly MaxDurationTimeout: "MAX_DURATION_TIMEOUT";
+    readonly InactivityTimeout: "INACTIVITY_TIMEOUT";
+    readonly Error: "ERROR";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnChatStatus = void 0;
+exports.ReturnChatStatus = {
+    Active: 'ACTIVE',
+    UserEnded: 'USER_ENDED',
+    UserTimeout: 'USER_TIMEOUT',
+    MaxDurationTimeout: 'MAX_DURATION_TIMEOUT',
+    InactivityTimeout: 'INACTIVITY_TIMEOUT',
+    Error: 'ERROR',
+};

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

@@ -8,23 +8,40 @@ import * as Hume from '../../../index';
 export interface ReturnConfig {
     /** 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, as well as Prompts 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;
     /** Name applied to all versions of a particular Config. */
     name?: string;
-    /** 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;
-    /** 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;
     prompt?: Hume.empathicVoice.ReturnPrompt;
+    /** A voice specification associated with this Config. */
     voice?: Hume.empathicVoice.ReturnVoice;
+    /**
+     * The supplemental language model associated with this Config.
+     *
+     * 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.ReturnLanguageModel;
+    /**
+     * The eLLM setup associated with this Config.
+     *
+     * Hume's eLLM (empathic Large Language Model) is a multimodal language model that takes into account both expression measures and language. The eLLM generates short, empathic language responses and guides text-to-speech (TTS) prosody.
+     */
     ellmModel?: Hume.empathicVoice.ReturnEllmModel;
-    /** List of user-defined tools associated with this config. */
+    /** List of user-defined tools associated with this Config. */
     tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
-    /** List of built-in tools associated with this config */
+    /** List of built-in tools associated with this Config. */
     builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
     timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;

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

@@ -2,11 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * 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, as well as Prompts 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/api/resources/empathicVoice/types/ReturnEllmModel.d.ts

@@ -5,6 +5,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;
 }

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

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

@@ -3,9 +3,23 @@
  */
 import * as Hume from '../../../index';
 /**
- * Collection of event_message specs to be returned from 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 ReturnEventMessageSpecs {
-    /** `enabled` causes the LLM to generate an initial message using the system prompt. `text` is the string to use verbatim as the initial message. */
+    /** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
     onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
+    /**
+     * 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;
 }