hume 0.8.4 → 0.8.5

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

@@ -75,7 +75,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/evi/prompts'),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -129,7 +129,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/evi/prompts'),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedPrompt.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -170,7 +170,7 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PromptsListPromptVersionsRequest} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -194,7 +194,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -233,7 +233,7 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptVersion} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -248,7 +248,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}`),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedPromptVersion.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -289,7 +289,7 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -301,7 +301,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}`),
                 method: 'DELETE',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -334,7 +334,7 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptName} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -349,7 +349,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}`),
                 method: 'PATCH',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedPromptName.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -386,8 +386,12 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -399,7 +403,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -437,8 +441,12 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -450,7 +458,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'DELETE',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -483,8 +491,12 @@ class Prompts {
         });
     }
     /**
-     * @param {string} id - Identifier for a prompt. Formatted as a UUID.
-     * @param {number} version - Version number for a prompt. Version numbers should be integers.
+     * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Hume.empathicVoice.PostedPromptVersionDescription} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -497,7 +509,7 @@ class Prompts {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/prompts/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'PATCH',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedPromptVersionDescription.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',

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

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

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

@@ -8,8 +8,14 @@
  *     }
  */
 export interface PostedPromptVersion {
-    /** Description that is appended to a specific version of a Prompt. */
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
-    /** Text used for this version of the Prompt. */
+    /**
+     * Instructions used to shape EVI’s behavior, responses, and style for this version of the Prompt.
+     *
+     * 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/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts

@@ -6,6 +6,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/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts

@@ -7,15 +7,19 @@
  */
 export interface PromptsListPromptVersionsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. 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/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts

@@ -7,15 +7,19 @@
  */
 export interface PromptsListPromptsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. 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/api/resources/empathicVoice/resources/tools/client/Client.d.ts

@@ -48,7 +48,7 @@ export declare class Tools {
      */
     createTool(request: Hume.empathicVoice.PostedUserDefinedTool, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,7 +57,7 @@ export declare class Tools {
      */
     listToolVersions(id: string, request?: Hume.empathicVoice.ToolsListToolVersionsRequest, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedUserDefinedTools>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -71,7 +71,7 @@ export declare class Tools {
      */
     createToolVersion(id: string, request: Hume.empathicVoice.PostedUserDefinedToolVersion, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -79,7 +79,7 @@ export declare class Tools {
      */
     deleteTool(id: string, requestOptions?: Tools.RequestOptions): Promise<void>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,8 +90,12 @@ export declare class Tools {
      */
     updateToolName(id: string, request: Hume.empathicVoice.PostedUserDefinedToolName, requestOptions?: Tools.RequestOptions): Promise<string>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -99,8 +103,12 @@ export declare class Tools {
      */
     getToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnUserDefinedTool | undefined>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -108,8 +116,12 @@ export declare class Tools {
      */
     deleteToolVersion(id: string, version: number, requestOptions?: Tools.RequestOptions): Promise<void>;
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -78,7 +78,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/evi/tools'),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -135,7 +135,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, 'v0/evi/tools'),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedUserDefinedTool.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -176,7 +176,7 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.ToolsListToolVersionsRequest} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -200,7 +200,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
@@ -239,7 +239,7 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersion} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -257,7 +257,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}`),
                 method: 'POST',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedUserDefinedToolVersion.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -298,7 +298,7 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -310,7 +310,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}`),
                 method: 'DELETE',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -343,7 +343,7 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedUserDefinedToolName} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -358,7 +358,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}`),
                 method: 'PATCH',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedUserDefinedToolName.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',
@@ -395,8 +395,12 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -408,7 +412,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'GET',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -446,8 +450,12 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -459,7 +467,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'DELETE',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
                     ? requestOptions.timeoutInSeconds * 1000
@@ -492,8 +500,12 @@ class Tools {
         });
     }
     /**
-     * @param {string} id - Identifier for a tool. Formatted as a UUID.
-     * @param {number} version - Version number for a tool. Version numbers should be integers.
+     * @param {string} id - Identifier for a Tool. Formatted as a UUID.
+     * @param {number} version - 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.
      * @param {Hume.empathicVoice.PostedUserDefinedToolVersionDescription} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -508,7 +520,7 @@ class Tools {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/tools/${encodeURIComponent(id)}/version/${encodeURIComponent(version)}`),
                 method: 'PATCH',
-                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.2', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ 'X-Fern-Language': 'JavaScript', 'X-Fern-SDK-Name': 'hume', 'X-Fern-SDK-Version': '0.8.5', 'X-Fern-Runtime': core.RUNTIME.type, 'X-Fern-Runtime-Version': core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: 'application/json',
                 body: serializers.empathicVoice.PostedUserDefinedToolVersionDescription.jsonOrThrow(request, {
                     unrecognizedObjectKeys: 'strip',

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

@@ -14,12 +14,16 @@
 export interface PostedUserDefinedTool {
     /** Name applied to all versions of a particular Tool. */
     name: string;
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: 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;
-    /** 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/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts

@@ -11,12 +11,16 @@
  *     }
  */
 export interface PostedUserDefinedToolVersion {
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: 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;
-    /** 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/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts

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

package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolVersionsRequest.d.ts

@@ -7,15 +7,19 @@
  */
 export interface ToolsListToolVersionsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. 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 tool in the list.
+     * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false.
      */
     restrictToMostRecent?: boolean;
 }

package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts

@@ -10,15 +10,19 @@
  */
 export interface ToolsListToolsRequest {
     /**
-     * The page number of the results to return.
+     * Specifies the page number to retrieve, enabling pagination.
+     *
+     * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
      */
     pageNumber?: number;
     /**
-     * The maximum number of results to include per page.
+     * Specifies the maximum number of results to include per page, enabling pagination.
+     *
+     * The value must be greater than or equal to 1. 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 tool in the list.
+     * By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false.
      */
     restrictToMostRecent?: boolean;
     /**

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

@@ -6,7 +6,7 @@ export interface Inference {
     /**
      * 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.
+     * EVI uses the prosody model to measure 48 emotions related to speech and vocal characteristics within a given expression.
      */
     prosody?: Hume.empathicVoice.ProsodyInference;
 }