hume 0.8.10 → 0.9.0

package/api/resources/empathicVoice/resources/customVoices/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);

package/api/resources/empathicVoice/resources/index.d.ts

@@ -2,11 +2,13 @@ export * as chat from "./chat";
 export * from "./chat/types";
 export * as tools from "./tools";
 export * as prompts from "./prompts";
+export * as customVoices from "./customVoices";
 export * as configs from "./configs";
 export * as chats from "./chats";
 export * as chatGroups from "./chatGroups";
 export * from "./tools/client/requests";
 export * from "./prompts/client/requests";
+export * from "./customVoices/client/requests";
 export * from "./configs/client/requests";
 export * from "./chats/client/requests";
 export * from "./chatGroups/client/requests";

package/api/resources/empathicVoice/resources/index.js

@@ -26,16 +26,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chatGroups = exports.chats = exports.configs = exports.prompts = exports.tools = exports.chat = void 0;
+exports.chatGroups = exports.chats = exports.configs = exports.customVoices = exports.prompts = exports.tools = exports.chat = void 0;
 exports.chat = __importStar(require("./chat"));
 __exportStar(require("./chat/types"), exports);
 exports.tools = __importStar(require("./tools"));
 exports.prompts = __importStar(require("./prompts"));
+exports.customVoices = __importStar(require("./customVoices"));
 exports.configs = __importStar(require("./configs"));
 exports.chats = __importStar(require("./chats"));
 exports.chatGroups = __importStar(require("./chatGroups"));
 __exportStar(require("./tools/client/requests"), exports);
 __exportStar(require("./prompts/client/requests"), exports);
+__exportStar(require("./customVoices/client/requests"), exports);
 __exportStar(require("./configs/client/requests"), exports);
 __exportStar(require("./chats/client/requests"), exports);
 __exportStar(require("./chatGroups/client/requests"), exports);

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

@@ -23,9 +23,15 @@ export declare class Prompts {
     protected readonly _options: Prompts.Options;
     constructor(_options?: Prompts.Options);
     /**
+     * Fetches a paginated list of **Prompts**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PromptsListPromptsRequest} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.listPrompts({
      *         pageNumber: 0,
@@ -34,9 +40,15 @@ export declare class Prompts {
      */
     listPrompts(request?: Hume.empathicVoice.PromptsListPromptsRequest, requestOptions?: Prompts.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnPrompt | undefined>>;
     /**
+     * Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {Hume.empathicVoice.PostedPrompt} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.createPrompt({
      *         name: "Weather Assistant Prompt",
@@ -45,19 +57,31 @@ export declare class Prompts {
      */
     createPrompt(request: Hume.empathicVoice.PostedPrompt, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
+     * Fetches a list of a **Prompt's** versions.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PromptsListPromptVersionsRequest} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     listPromptVersions(id: string, request?: Hume.empathicVoice.PromptsListPromptVersionsRequest, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedPrompts>;
     /**
+     * Updates a **Prompt** by creating a new version of the **Prompt**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptVersion} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     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>",
@@ -66,18 +90,30 @@ export declare class Prompts {
      */
     createPromptVerison(id: string, request: Hume.empathicVoice.PostedPromptVersion, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
+     * Deletes a **Prompt** and its versions.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5")
      */
     deletePrompt(id: string, requestOptions?: Prompts.RequestOptions): Promise<void>;
     /**
+     * Updates the name of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {Hume.empathicVoice.PostedPromptName} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
      *         name: "Updated Weather Assistant Prompt Name"
@@ -85,41 +121,59 @@ export declare class Prompts {
      */
     updatePromptName(id: string, request: Hume.empathicVoice.PostedPromptName, requestOptions?: Prompts.RequestOptions): Promise<string>;
     /**
+     * Fetches a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {number} version - Version number for a Prompt.
      *
-     *                           Prompts, 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.
+     *                           Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0)
      */
     getPromptVersion(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     /**
+     * Deletes a specified version of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {number} version - Version number for a Prompt.
      *
-     *                           Prompts, 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.
+     *                           Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1)
      */
     deletePromptVersion(id: string, version: number, requestOptions?: Prompts.RequestOptions): Promise<void>;
     /**
+     * Updates the description of a **Prompt**.
+     *
+     * See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
+     *
      * @param {string} id - Identifier for a Prompt. Formatted as a UUID.
      * @param {number} version - Version number for a Prompt.
      *
-     *                           Prompts, 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.
+     *                           Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
      *
      *                           Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
      * @param {Hume.empathicVoice.PostedPromptVersionDescription} request
      * @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
      * @example
      *     await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
      *         versionDescription: "This is an updated version_description."