hume 0.8.4 → 0.8.6

package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts

@@ -4,18 +4,61 @@
 import * as Hume from '../../../../../../index';
 /**
  * @example
- *     {}
+ *     {
+ *         versionDescription: "This is an updated version of the Weather Assistant Config.",
+ *         prompt: {
+ *             id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
+ *             version: 0
+ *         },
+ *         voice: {
+ *             provider: "HUME_AI",
+ *             name: Hume.empathicVoice.PostedVoiceName.Ito
+ *         },
+ *         languageModel: {
+ *             modelProvider: Hume.empathicVoice.PostedLanguageModelModelProvider.Anthropic,
+ *             modelResource: "claude-3-5-sonnet-20240620",
+ *             temperature: 1
+ *         },
+ *         ellmModel: {
+ *             allowShortResponses: true
+ *         },
+ *         eventMessages: {
+ *             onNewChat: {
+ *                 enabled: false,
+ *                 text: ""
+ *             },
+ *             onInactivityTimeout: {
+ *                 enabled: false,
+ *                 text: ""
+ *             },
+ *             onMaxDurationTimeout: {
+ *                 enabled: false,
+ *                 text: ""
+ *             }
+ *         }
+ *     }
  */
 export interface PostedConfigVersion {
-    /** Description that is appended to a specific version of a Config. */
+    /** An optional description of the Config version. */
     versionDescription?: string;
     prompt?: Hume.empathicVoice.PostedPromptSpec;
+    /** A voice specification associated with this Config version. */
     voice?: Hume.empathicVoice.PostedVoice;
+    /**
+     * The supplemental language model associated with this Config version.
+     *
+     * This model is used to generate longer, more detailed responses from EVI. Choosing an appropriate supplemental language model for your use case is crucial for generating fast, high-quality responses from EVI.
+     */
     languageModel?: Hume.empathicVoice.PostedLanguageModel;
+    /**
+     * The eLLM setup associated with this Config version.
+     *
+     * Hume's eLLM (empathic Large Language Model) is a multimodal language model that takes into account both expression measures and language. The eLLM generates short, empathic language responses and guides text-to-speech (TTS) prosody.
+     */
     ellmModel?: Hume.empathicVoice.PostedEllmModel;
-    /** Tool specification for a Config. */
+    /** List of user-defined tools associated with this Config version. */
     tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
-    /** Built-in tool specification for a Config. */
+    /** List of built-in tools associated with this Config version. */
     builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
     timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;

package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts

@@ -3,9 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         versionDescription: "This is an updated version_description."
+ *     }
  */
 export interface PostedConfigVersionDescription {
-    /** Description that is appended to a specific version of a Config. */
+    /** An optional description of the Config version. */
     versionDescription?: string;
 }

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

@@ -27,85 +27,103 @@ export declare class Prompts {
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.prompts.listPrompts()
+     *     await client.empathicVoice.prompts.listPrompts({
+     *         pageNumber: 0,
+     *         pageSize: 2
+     *     })
      */
-    listPrompts(request?: Hume.empathicVoice.PromptsListPromptsRequest, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedPrompts>;
+    listPrompts(request?: Hume.empathicVoice.PromptsListPromptsRequest, requestOptions?: Prompts.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnPrompt | undefined>>;
     /**
      * @param {Hume.empathicVoice.PostedPrompt} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.empathicVoice.prompts.createPrompt({
-     *         name: "name",
-     *         text: "text"
+     *         name: "Weather Assistant Prompt",
+     *         text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
      *     })
      */
     createPrompt(request: Hume.empathicVoice.PostedPrompt, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
-     * @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.
      *
      * @example
-     *     await client.empathicVoice.prompts.listPromptVersions("id")
+     *     await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     listPromptVersions(id: string, request?: Hume.empathicVoice.PromptsListPromptVersionsRequest, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedPrompts>;
     /**
-     * @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.
      *
      * @example
-     *     await client.empathicVoice.prompts.createPromptVerison("id", {
-     *         text: "text"
+     *     await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
+     *         text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
+     *         versionDescription: "This is an updated version of the Weather Assistant Prompt."
      *     })
      */
     createPromptVerison(id: string, request: Hume.empathicVoice.PostedPromptVersion, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
-     * @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
-     *     await client.empathicVoice.prompts.deletePrompt("id")
+     *     await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     deletePrompt(id: string, requestOptions?: Prompts.RequestOptions): Promise<void>;
     /**
-     * @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.
      *
      * @example
-     *     await client.empathicVoice.prompts.updatePromptName("string", {
-     *         name: "string"
+     *     await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
+     *         name: "Updated Weather Assistant Prompt Name"
      *     })
      */
     updatePromptName(id: string, request: Hume.empathicVoice.PostedPromptName, requestOptions?: Prompts.RequestOptions): Promise<string>;
     /**
-     * @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
-     *     await client.empathicVoice.prompts.getPromptVersion("id", 1)
+     *     await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0)
      */
     getPromptVersion(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
-     * @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
-     *     await client.empathicVoice.prompts.deletePromptVersion("id", 1)
+     *     await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1)
      */
     deletePromptVersion(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<void>;
     /**
-     * @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.
      *
      * @example
-     *     await client.empathicVoice.prompts.updatePromptDescription("id", 1)
+     *     await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
+     *         versionDescription: "This is an updated version_description."
+     *     })
      */
     updatePromptDescription(id: string, version: number, request?: Hume.empathicVoice.PostedPromptVersionDescription, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -53,64 +53,80 @@ class Prompts {
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.prompts.listPrompts()
+     *     await client.empathicVoice.prompts.listPrompts({
+     *         pageNumber: 0,
+     *         pageSize: 2
+     *     })
      */
     listPrompts(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/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())),
-                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.ReturnPagedPrompts.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/prompts'),
+                    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.ReturnPagedPrompts.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.promptsPage) !== null && _a !== void 0 ? _a : []).length > 0; },
+                getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.promptsPage) !== null && _a !== void 0 ? _a : []; },
+                loadPage: (_response) => {
+                    _offset += 1;
+                    return list(Object.assign(Object.assign({}, request), { pageNumber: _offset }));
+                },
+            });
         });
     }
     /**
@@ -119,8 +135,8 @@ class Prompts {
      *
      * @example
      *     await client.empathicVoice.prompts.createPrompt({
-     *         name: "name",
-     *         text: "text"
+     *         name: "Weather Assistant Prompt",
+     *         text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
      *     })
      */
     createPrompt(request, requestOptions) {
@@ -129,7 +145,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.6', '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,12 +186,12 @@ 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.
      *
      * @example
-     *     await client.empathicVoice.prompts.listPromptVersions("id")
+     *     await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     listPromptVersions(id, request = {}, requestOptions) {
         var _a, _b;
@@ -194,7 +210,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.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
@@ -233,13 +249,14 @@ 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.
      *
      * @example
-     *     await client.empathicVoice.prompts.createPromptVerison("id", {
-     *         text: "text"
+     *     await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
+     *         text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
+     *         versionDescription: "This is an updated version of the Weather Assistant Prompt."
      *     })
      */
     createPromptVerison(id, request, requestOptions) {
@@ -248,7 +265,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.6', '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,11 +306,11 @@ 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
-     *     await client.empathicVoice.prompts.deletePrompt("id")
+     *     await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     deletePrompt(id, requestOptions) {
         var _a, _b;
@@ -301,7 +318,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.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
@@ -334,13 +351,13 @@ 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.
      *
      * @example
-     *     await client.empathicVoice.prompts.updatePromptName("string", {
-     *         name: "string"
+     *     await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
+     *         name: "Updated Weather Assistant Prompt Name"
      *     })
      */
     updatePromptName(id, request, requestOptions) {
@@ -349,7 +366,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.6', '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,12 +403,16 @@ 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
-     *     await client.empathicVoice.prompts.getPromptVersion("id", 1)
+     *     await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0)
      */
     getPromptVersion(id, version, requestOptions) {
         var _a, _b;
@@ -399,7 +420,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.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
@@ -437,12 +458,16 @@ 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
-     *     await client.empathicVoice.prompts.deletePromptVersion("id", 1)
+     *     await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1)
      */
     deletePromptVersion(id, version, requestOptions) {
         var _a, _b;
@@ -450,7 +475,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.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
@@ -483,13 +508,19 @@ 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.
      *
      * @example
-     *     await client.empathicVoice.prompts.updatePromptDescription("id", 1)
+     *     await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
+     *         versionDescription: "This is an updated version_description."
+     *     })
      */
     updatePromptDescription(id, version, request = {}, requestOptions) {
         var _a, _b;
@@ -497,7 +528,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.6', '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/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts

@@ -4,15 +4,21 @@
 /**
  * @example
  *     {
- *         name: "name",
- *         text: "text"
+ *         name: "Weather Assistant Prompt",
+ *         text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
  *     }
  */
 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/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptName.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         name: "string"
+ *         name: "Updated Weather Assistant Prompt Name"
  *     }
  */
 export interface PostedPromptName {

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

@@ -4,12 +4,19 @@
 /**
  * @example
  *     {
- *         text: "text"
+ *         text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
+ *         versionDescription: "This is an updated version of the Weather Assistant Prompt."
  *     }
  */
 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/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts

@@ -3,9 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         versionDescription: "This is an updated version_description."
+ *     }
  */
 export interface PostedPromptVersionDescription {
-    /** Description that is appended to a specific version of a Prompt. */
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
 }