hume 0.8.4 → 0.8.6

package/dist/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 between 1 and 100, inclusive.
+     *
+     * 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/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts

@@ -3,19 +3,26 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         pageNumber: 0,
+ *         pageSize: 2
+ *     }
  */
 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 between 1 and 100, inclusive.
+     *
+     * 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/api/resources/empathicVoice/resources/tools/client/Client.d.ts

@@ -32,7 +32,7 @@ export declare class Tools {
      *         pageSize: 2
      *     })
      */
-    listTools(request?: Hume.empathicVoice.ToolsListToolsRequest, requestOptions?: Tools.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedUserDefinedTools>;
+    listTools(request?: Hume.empathicVoice.ToolsListToolsRequest, requestOptions?: Tools.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnUserDefinedTool | undefined>>;
     /**
      * @param {Hume.empathicVoice.PostedUserDefinedTool} request
      * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
@@ -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/dist/api/resources/empathicVoice/resources/tools/client/Client.js

@@ -59,61 +59,74 @@ class Tools {
      *     })
      */
     listTools(request = {}, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { pageNumber, pageSize, restrictToMostRecent, name } = request;
-            const _queryParams = {};
-            if (pageNumber != null) {
-                _queryParams['page_number'] = pageNumber.toString();
-            }
-            if (pageSize != null) {
-                _queryParams['page_size'] = pageSize.toString();
-            }
-            if (restrictToMostRecent != null) {
-                _queryParams['restrict_to_most_recent'] = restrictToMostRecent.toString();
-            }
-            if (name != null) {
-                _queryParams['name'] = name;
-            }
-            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())),
-                contentType: 'application/json',
-                queryParameters: _queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
-                    ? requestOptions.timeoutInSeconds * 1000
-                    : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return serializers.empathicVoice.ReturnPagedUserDefinedTools.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: 'passthrough',
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    breadcrumbsPrefix: ['response'],
-                });
-            }
-            if (_response.error.reason === 'status-code') {
-                throw new errors.HumeError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
+            const list = (request) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b;
+                const { pageNumber, pageSize, restrictToMostRecent, name } = request;
+                const _queryParams = {};
+                if (pageNumber != null) {
+                    _queryParams['page_number'] = pageNumber.toString();
+                }
+                if (pageSize != null) {
+                    _queryParams['page_size'] = pageSize.toString();
+                }
+                if (restrictToMostRecent != null) {
+                    _queryParams['restrict_to_most_recent'] =
+                        restrictToMostRecent.toString();
+                }
+                if (name != null) {
+                    _queryParams['name'] = name;
+                }
+                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.6', '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
+                        ? requestOptions.timeoutInSeconds * 1000
+                        : 60000,
+                    maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                    abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
                 });
-            }
-            switch (_response.error.reason) {
-                case 'non-json':
-                    throw new errors.HumeError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
+                if (_response.ok) {
+                    return serializers.empathicVoice.ReturnPagedUserDefinedTools.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: 'passthrough',
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ['response'],
                     });
-                case 'timeout':
-                    throw new errors.HumeTimeoutError();
-                case 'unknown':
+                }
+                if (_response.error.reason === 'status-code') {
                     throw new errors.HumeError({
-                        message: _response.error.errorMessage,
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
                     });
-            }
+                }
+                switch (_response.error.reason) {
+                    case 'non-json':
+                        throw new errors.HumeError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.rawBody,
+                        });
+                    case 'timeout':
+                        throw new errors.HumeTimeoutError();
+                    case 'unknown':
+                        throw new errors.HumeError({
+                            message: _response.error.errorMessage,
+                        });
+                }
+            });
+            let _offset = request.pageNumber != null ? request.pageNumber : 1;
+            return new core.Pageable({
+                response: yield list(request),
+                hasNextPage: (response) => { var _a; return ((_a = response === null || response === void 0 ? void 0 : response.toolsPage) !== null && _a !== void 0 ? _a : []).length > 0; },
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.toolsPage) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (_response) => {
+                    _offset += 1;
+                    return list(Object.assign(Object.assign({}, request), { pageNumber: _offset }));
+                },
+            });
         });
     }
     /**
@@ -135,7 +148,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.6', '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 +189,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 +213,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.6', '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 +252,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 +270,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.6', '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 +311,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 +323,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.6', '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 +356,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 +371,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.6', '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 +408,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 +425,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.6', '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 +463,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 +480,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.6', '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 +513,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 +533,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.6', '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/dist/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/dist/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/dist/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/dist/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 between 1 and 100, inclusive.
+     *
+     * 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/dist/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 between 1 and 100, inclusive.
+     *
+     * 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/dist/api/resources/empathicVoice/types/AudioInput.d.ts

@@ -16,9 +16,11 @@ export interface AudioInput {
     /**
      * Base64 encoded audio input to insert into the conversation.
      *
-     * The audio input must be captured and transmitted to EVI as a continuous stream, with the audio data sent in small chunks for better transcription quality. When capturing audio through the browser, we recommend recording the audio in 100ms intervals and adjusting from there to determine if smaller or larger chunks are needed. These chunks should be continuously sent to EVI as Audio Input messages.
+     * The content of an Audio Input message is treated as the user’s speech to EVI and must be streamed continuously. Pre-recorded audio files are not supported.
      *
-     * The content of an Audio Input message is treated as the user’s speech to EVI. EVI processes the audio, conducts expression measurement using the prosody model, and responds accordingly.
+     * For optimal transcription quality, the audio data should be transmitted in small chunks.
+     *
+     * Hume recommends streaming audio with a buffer window of 20 milliseconds (ms), or 100 milliseconds (ms) for web applications.
      */
     data: string;
 }

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

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from '../../../index';
-export declare type JsonMessage = Hume.empathicVoice.AssistantMessage | Hume.empathicVoice.ChatMetadata | Hume.empathicVoice.WebSocketError | Hume.empathicVoice.UserInterruption | Hume.empathicVoice.UserMessage | Hume.empathicVoice.ToolCallMessage | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage;
+export declare type JsonMessage = Hume.empathicVoice.AssistantEnd | Hume.empathicVoice.AssistantMessage | Hume.empathicVoice.ChatMetadata | Hume.empathicVoice.WebSocketError | Hume.empathicVoice.UserInterruption | Hume.empathicVoice.UserMessage | Hume.empathicVoice.ToolCallMessage | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage;

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

@@ -7,6 +7,6 @@
 export interface PostedBuiltinTool {
     /** Name applied to all versions of a particular Tool. */
     name: string;
-    /** Text to use if the tool fails to generate content. */
+    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
     fallbackContent?: string;
 }

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

@@ -5,6 +5,10 @@
  * A eLLM model configuration to be posted to the server
  */
 export interface PostedEllmModel {
-    /** 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/PostedEventMessageSpec.d.ts

@@ -5,8 +5,12 @@
  * Settings for a specific event_message to be posted to the server
  */
 export interface PostedEventMessageSpec {
-    /** 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;
 }