hume 0.15.12 → 0.15.13

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.d.ts

@@ -11,6 +11,10 @@ export declare class PromptsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PromptsClient.Options>;
     constructor(options?: PromptsClient.Options);
     /**
+     * Fetches a paginated list of **Prompts**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PromptsListPromptsRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -24,6 +28,10 @@ export declare class PromptsClient {
      */
     listPrompts(request?: Hume.empathicVoice.PromptsListPromptsRequest, requestOptions?: PromptsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnPrompt | undefined, Hume.empathicVoice.ReturnPagedPrompts>>;
     /**
+     * Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PostedPrompt} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -38,6 +46,10 @@ export declare class PromptsClient {
     createPrompt(request: Hume.empathicVoice.PostedPrompt, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnPrompt | undefined>;
     private __createPrompt;
     /**
+     * Fetches a list of a **Prompt's** versions.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id
      * @param {Hume.empathicVoice.PromptsListPromptVersionsRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +62,11 @@ export declare class PromptsClient {
     listPromptVersions(id: string, request?: Hume.empathicVoice.PromptsListPromptVersionsRequest, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnPagedPrompts>;
     private __listPromptVersions;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Updates a **Prompt** by creating a new version of the **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptVersion} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -65,7 +81,11 @@ export declare class PromptsClient {
     createPromptVersion(id: string, request: Hume.empathicVoice.PostedPromptVersion, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnPrompt | undefined>;
     private __createPromptVersion;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Deletes a **Prompt** and its versions.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -76,7 +96,11 @@ export declare class PromptsClient {
     deletePrompt(id: string, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deletePrompt;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Updates the name of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptName} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,8 +114,16 @@ export declare class PromptsClient {
     updatePromptName(id: string, request: Hume.empathicVoice.PostedPromptName, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<string>;
     private __updatePromptName;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Fetches a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -102,8 +134,16 @@ export declare class PromptsClient {
     getPromptVersion(id: string, version: number, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnPrompt | undefined>;
     private __getPromptVersion;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Deletes a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -114,8 +154,16 @@ export declare class PromptsClient {
     deletePromptVersion(id: string, version: number, requestOptions?: PromptsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deletePromptVersion;
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Updates the description of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {Hume.empathicVoice.PostedPromptVersionDescription} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.js

@@ -57,6 +57,10 @@ class PromptsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Fetches a paginated list of **Prompts**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PromptsListPromptsRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -140,6 +144,10 @@ class PromptsClient {
         });
     }
     /**
+     * Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PostedPrompt} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -210,6 +218,10 @@ class PromptsClient {
         });
     }
     /**
+     * Fetches a list of a **Prompt's** versions.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id
      * @param {Hume.empathicVoice.PromptsListPromptVersionsRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -278,7 +290,11 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Updates a **Prompt** by creating a new version of the **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptVersion} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -349,7 +365,11 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Deletes a **Prompt** and its versions.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -401,7 +421,11 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * Updates the name of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptName} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -463,8 +487,16 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Fetches a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -525,8 +557,16 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Deletes a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -578,8 +618,16 @@ class PromptsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * Updates the description of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
+     *
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - Version number for a Prompt.
+     *
+     *                           Prompts, Configs, Custom Voices, 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.
      * @param {Hume.empathicVoice.PostedPromptVersionDescription} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts

@@ -8,8 +8,12 @@
 export interface PostedPrompt {
     /** Name applied to all versions of a particular Prompt. */
     name: string;
-    /** 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/speech-to-speech-evi/guides/prompting).
+     */
     text: string;
-    /** Description that is appended to a specific version of a Prompt. */
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
 }

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts

@@ -6,8 +6,12 @@
  *     }
  */
 export interface PostedPromptVersion {
-    /** 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/speech-to-speech-evi/guides/prompting).
+     */
     text: string;
-    /** Description that is appended to a specific version of a Prompt. */
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
 }

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts

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

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts

@@ -15,6 +15,6 @@ export interface PromptsListPromptVersionsRequest {
      * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
      */
     pageSize?: number;
-    /** Only include the most recent version of each prompt in the list. */
+    /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false. */
     restrictToMostRecent?: boolean;
 }

package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts

@@ -18,7 +18,7 @@ export interface PromptsListPromptsRequest {
      * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
      */
     pageSize?: number;
-    /** Only include the most recent version of each prompt in the list. */
+    /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false. */
     restrictToMostRecent?: boolean;
     /** Filter to only include prompts with name. */
     name?: string;

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

@@ -11,6 +11,10 @@ export declare class ToolsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ToolsClient.Options>;
     constructor(options?: ToolsClient.Options);
     /**
+     * Fetches a paginated list of **Tools**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {Hume.empathicVoice.ToolsListToolsRequest} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -24,6 +28,10 @@ export declare class ToolsClient {
      */
     listTools(request?: Hume.empathicVoice.ToolsListToolsRequest, requestOptions?: ToolsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
     /**
+     * Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {Hume.empathicVoice.PostedUserDefinedTool} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,6 +49,10 @@ export declare class ToolsClient {
     createTool(request: Hume.empathicVoice.PostedUserDefinedTool, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __createTool;
     /**
+     * Fetches a list of a **Tool's** versions.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {string} id
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -52,7 +64,11 @@ export declare class ToolsClient {
      */
     listToolVersions(id: string, request?: Hume.empathicVoice.ToolsListToolVersionsRequest, requestOptions?: ToolsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined, Hume.empathicVoice.ReturnPagedUserDefinedTools>>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Updates a **Tool** by creating a new version of the **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -69,7 +85,11 @@ export declare class ToolsClient {
     createToolVersion(id: string, request: Hume.empathicVoice.PostedUserDefinedToolVersion, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __createToolVersion;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Deletes a **Tool** and its versions.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -80,7 +100,11 @@ export declare class ToolsClient {
     deleteTool(id: string, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteTool;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Updates the name of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -94,8 +118,16 @@ export declare class ToolsClient {
     updateToolName(id: string, request: Hume.empathicVoice.PostedUserDefinedToolName, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<string>;
     private __updateToolName;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Fetches a specified version of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -106,8 +138,16 @@ export declare class ToolsClient {
     getToolVersion(id: string, version: number, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     private __getToolVersion;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Deletes a specified version of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -118,8 +158,16 @@ export declare class ToolsClient {
     deleteToolVersion(id: string, version: number, requestOptions?: ToolsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteToolVersion;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Updates the description of a specified **Tool** version.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/empathicVoice/resources/tools/client/Client.js

@@ -57,6 +57,10 @@ class ToolsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Fetches a paginated list of **Tools**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {Hume.empathicVoice.ToolsListToolsRequest} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -140,6 +144,10 @@ class ToolsClient {
         });
     }
     /**
+     * Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {Hume.empathicVoice.PostedUserDefinedTool} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -213,6 +221,10 @@ class ToolsClient {
         });
     }
     /**
+     * Fetches a list of a **Tool's** versions.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
      * @param {string} id
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -293,7 +305,11 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Updates a **Tool** by creating a new version of the **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -366,7 +382,11 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Deletes a **Tool** and its versions.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -418,7 +438,11 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * Updates the name of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -480,8 +504,16 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Fetches a specified version of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -542,8 +574,16 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Deletes a specified version of a **Tool**.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -595,8 +635,16 @@ class ToolsClient {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * Updates the description of a specified **Tool** version.
+     *
+     * Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
+     *
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - Version number for a Tool.
+     *
+     *                           Tools, Configs, Custom Voices, 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.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
      * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -9,14 +9,25 @@
  *     }
  */
 export interface PostedUserDefinedTool {
-    /** 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;
-    /** Text to use if the tool fails to generate content. */
+    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
     fallbackContent?: string;
-    /** Name applied to all versions of a particular Tool. */
+    /**
+     * Name of the built-in tool to use. Hume supports the following built-in tools:
+     *
+     * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
+     * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
+     *
+     * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
+     */
     name: string;
-    /** 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;
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: string;
 }

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

@@ -5,6 +5,13 @@
  *     }
  */
 export interface PostedUserDefinedToolName {
-    /** Name applied to all versions of a particular Tool. */
+    /**
+     * Name of the built-in tool to use. Hume supports the following built-in tools:
+     *
+     * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
+     * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
+     *
+     * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
+     */
     name: string;
 }

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

@@ -8,12 +8,16 @@
  *     }
  */
 export interface PostedUserDefinedToolVersion {
-    /** 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;
-    /** 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;
-    /** 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;
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: string;
 }