hume 0.8.4 → 0.8.6

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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;
 }

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

@@ -1,14 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
  * A specific LanguageModel
  */
 export interface ReturnLanguageModel {
-    /** The provider of this model. Based on the enum modelProvider. */
-    modelProvider?: string;
-    /** String that specifies the model to use with modelProvider. */
+    /** The provider of the supplemental language model. */
+    modelProvider?: Hume.empathicVoice.ReturnLanguageModelModelProvider;
+    /** String that specifies the language model to use with `model_provider`. */
     modelResource?: string;
-    /** Model temperature. */
+    /**
+     * The model temperature, with values between 0 to 1 (inclusive).
+     *
+     * Controls the randomness of the LLM’s output, with values closer to 0 yielding focused, deterministic responses and values closer to 1 producing more creative, diverse responses.
+     */
     temperature?: number;
 }

package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The provider of the supplemental language model.
+ */
+export declare type ReturnLanguageModelModelProvider = 'OPEN_AI' | 'CUSTOM_LANGUAGE_MODEL' | 'ANTHROPIC' | 'FIREWORKS' | 'GROQ' | 'GOOGLE';
+export declare const ReturnLanguageModelModelProvider: {
+    readonly OpenAi: "OPEN_AI";
+    readonly CustomLanguageModel: "CUSTOM_LANGUAGE_MODEL";
+    readonly Anthropic: "ANTHROPIC";
+    readonly Fireworks: "FIREWORKS";
+    readonly Groq: "GROQ";
+    readonly Google: "GOOGLE";
+};

package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.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.ReturnLanguageModelModelProvider = void 0;
+exports.ReturnLanguageModelModelProvider = {
+    OpenAi: 'OPEN_AI',
+    CustomLanguageModel: 'CUSTOM_LANGUAGE_MODEL',
+    Anthropic: 'ANTHROPIC',
+    Fireworks: 'FIREWORKS',
+    Groq: 'GROQ',
+    Google: 'GOOGLE',
+};

package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts

@@ -6,14 +6,26 @@ import * as Hume from '../../../index';
  * A paginated list of chat_groups returned from the server
  */
 export interface ReturnPagedChatGroups {
-    /** 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_groups and their metadata 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.ReturnPagedChatGroupsPaginationDirection;
+    /** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
     chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
 }

package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.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 ReturnPagedChatGroupsPaginationDirection = 'ASC' | 'DESC';
+export declare const ReturnPagedChatGroupsPaginationDirection: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.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.ReturnPagedChatGroupsPaginationDirection = void 0;
+exports.ReturnPagedChatGroupsPaginationDirection = {
+    Asc: 'ASC',
+    Desc: 'DESC',
+};

package/dist/api/resources/empathicVoice/types/ReturnPagedChats.d.ts

@@ -6,14 +6,26 @@ import * as Hume from '../../../index';
  * A paginated list of chats returned from the server
  */
 export interface ReturnPagedChats {
-    /** 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 chats and their metadata 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.ReturnPagedChatsPaginationDirection;
+    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
     chatsPage: Hume.empathicVoice.ReturnChat[];
 }

package/dist/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.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 ReturnPagedChatsPaginationDirection = 'ASC' | 'DESC';
+export declare const ReturnPagedChatsPaginationDirection: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

package/dist/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.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.ReturnPagedChatsPaginationDirection = void 0;
+exports.ReturnPagedChatsPaginationDirection = {
+    Asc: 'ASC',
+    Desc: 'DESC',
+};

package/dist/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts

@@ -6,12 +6,20 @@ import * as Hume from '../../../index';
  * A paginated list of config versions returned from the server
  */
 export interface ReturnPagedConfigs {
-    /** 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;
-    /** List of prompts returned for the specified page number and page size. */
+    /** List of configs returned for the specified `page_number` and `page_size`. */
     configsPage?: Hume.empathicVoice.ReturnConfig[];
 }

package/dist/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts

@@ -6,12 +6,20 @@ import * as Hume from '../../../index';
  * A paginated list of prompt versions returned from the server
  */
 export interface ReturnPagedPrompts {
-    /** 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;
-    /** List of prompts returned for the specified page number and page size. */
+    /** List of prompts returned for the specified `page_number` and `page_size`. */
     promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
 }

package/dist/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts

@@ -6,12 +6,20 @@ import * as Hume from '../../../index';
  * A paginated list of user defined tool versions returned from the server
  */
 export interface ReturnPagedUserDefinedTools {
-    /** 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;
-    /** List of tools returned for the specified page number and page size. */
+    /** List of tools returned for the specified `page_number` and `page_size`. */
     toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
 }

package/dist/api/resources/empathicVoice/types/ReturnPrompt.d.ts

@@ -1,24 +1,37 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
- * A specific prompt version returned from the server
+ * A Prompt associated with this Config.
  */
 export interface ReturnPrompt {
     /** 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 for a Prompt.
+     *
+     * Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
+     *
+     * Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
+     */
     version: number;
-    /** Indicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
-    versionType: string;
-    /** Description that is appended to a specific version of a Prompt. */
+    /** Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
+    versionType: Hume.empathicVoice.ReturnPromptVersionType;
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
     /** Name applied to all versions of a particular Prompt. */
     name: string;
-    /** The timestamp when the first version of this prompt was created. */
+    /** Time at which the Prompt was created. Measured in seconds since the Unix epoch. */
     createdOn: number;
-    /** The timestamp when this version of the prompt was created. */
+    /** Time at which the Prompt was last modified. Measured in seconds since the Unix epoch. */
     modifiedOn: number;
-    /** Text used for this version of the Prompt. */
+    /**
+     * Instructions used to shape EVI’s behavior, responses, and style.
+     *
+     * You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles.
+     *
+     * For help writing a system prompt, see our [Prompting Guide](/docs/empathic-voice-interface-evi/prompting).
+     */
     text: string;
 }

package/dist/api/resources/empathicVoice/types/ReturnPromptVersionType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version.
+ */
+export declare type ReturnPromptVersionType = 'FIXED' | 'LATEST';
+export declare const ReturnPromptVersionType: {
+    readonly Fixed: "FIXED";
+    readonly Latest: "LATEST";
+};

package/dist/api/resources/empathicVoice/types/ReturnPromptVersionType.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.ReturnPromptVersionType = void 0;
+exports.ReturnPromptVersionType = {
+    Fixed: 'FIXED',
+    Latest: 'LATEST',
+};

package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts

@@ -5,8 +5,12 @@
  * A specific timeout configuration to be returned from the server
  */
 export interface ReturnTimeoutSpec {
-    /** Boolean indicating if this event message is enabled. */
+    /**
+     * Boolean indicating if this timeout is enabled.
+     *
+     * If set to false, EVI will not timeout due to a specified duration being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
+     */
     enabled: boolean;
-    /** Duration in seconds for the timeout. */
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
     durationSecs?: number;
 }

package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts

@@ -3,9 +3,21 @@
  */
 import * as Hume from '../../../index';
 /**
- * Collection of timeout specs to be returned from the server
+ * Collection of timeout specifications returned by the server.
+ *
+ * Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.
  */
 export interface ReturnTimeoutSpecs {
+    /**
+     * Specifies the duration of user inactivity (in seconds) after which the EVI WebSocket connection will be automatically disconnected. Default is 600 seconds (10 minutes).
+     *
+     * Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
+     */
     inactivity: Hume.empathicVoice.ReturnTimeoutSpec;
+    /**
+     * Specifies the maximum allowed duration (in seconds) for an EVI WebSocket connection before it is automatically disconnected. Default is 1,800 seconds (30 minutes).
+     *
+     * Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
+     */
     maxDuration: Hume.empathicVoice.ReturnTimeoutSpec;
 }

package/dist/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts

@@ -1,30 +1,41 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
  * A specific tool version returned from the server
  */
 export interface ReturnUserDefinedTool {
-    /** 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.ReturnUserDefinedToolToolType;
     /** Identifier for a Tool. Formatted as a UUID. */
     id: string;
-    /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
+    /**
+     * Version number for a Tool.
+     *
+     * Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
+     *
+     * Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
+     */
     version: number;
-    /** Indicates whether this tool is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
-    versionType: string;
-    /** Description that is appended to a specific version of a Tool. */
+    /** Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
+    versionType: Hume.empathicVoice.ReturnUserDefinedToolVersionType;
+    /** An optional description of the Tool version. */
     versionDescription?: string;
     /** Name applied to all versions of a particular Tool. */
     name: string;
-    /** The timestamp when the first version of this tool was created. */
+    /** Time at which the Tool was created. Measured in seconds since the Unix epoch. */
     createdOn: number;
-    /** The timestamp when this version of the tool was created. */
+    /** Time at which the Tool was last modified. Measured in seconds since the Unix epoch. */
     modifiedOn: number;
-    /** 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;
-    /** Text describing what the tool does. */
+    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
     description?: string;
-    /** Stringified JSON defining the parameters used by this version of the Tool. */
+    /**
+     * 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;
 }

package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.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 ReturnUserDefinedToolToolType = 'BUILTIN' | 'FUNCTION';
+export declare const ReturnUserDefinedToolToolType: {
+    readonly Builtin: "BUILTIN";
+    readonly Function: "FUNCTION";
+};

package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.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.ReturnUserDefinedToolToolType = void 0;
+exports.ReturnUserDefinedToolToolType = {
+    Builtin: 'BUILTIN',
+    Function: 'FUNCTION',
+};

package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version.
+ */
+export declare type ReturnUserDefinedToolVersionType = 'FIXED' | 'LATEST';
+export declare const ReturnUserDefinedToolVersionType: {
+    readonly Fixed: "FIXED";
+    readonly Latest: "LATEST";
+};

package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.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.ReturnUserDefinedToolVersionType = void 0;
+exports.ReturnUserDefinedToolVersionType = {
+    Fixed: 'FIXED',
+    Latest: 'LATEST',
+};

package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from '../../../index';
 /**
  * A specific voice specification
  */
 export interface ReturnVoice {
-    /** The provider of the voice to use. Based on the enum VoiceProvider. */
-    provider: string;
+    /** The provider of the voice to use. Currently, only `HUME_AI` is supported as the voice provider. */
+    provider: 'HUME_AI';
     /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
-    name?: string;
+    name?: Hume.empathicVoice.ReturnVoiceName;
 }