hume 0.8.3 → 0.8.5

package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../../../../../index";
+import * as Hume from '../../../../../../index';
 /**
  * @example
  *     {
@@ -11,15 +11,26 @@ import * as Hume from "../../../../../../index";
 export interface PostedConfig {
     /** Name applied to all versions of a particular Config. */
     name: string;
-    /** 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. */
     voice?: Hume.empathicVoice.PostedVoice;
+    /**
+     * The supplemental language model associated with this Config.
+     *
+     * 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.
+     *
+     * 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. */
     tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
-    /** Built-in tool specification for a Config. */
+    /** List of built-in tools associated with this Config. */
     builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
     eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
     timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;

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

@@ -1,21 +1,32 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../../../../../index";
+import * as Hume from '../../../../../../index';
 /**
  * @example
  *     {}
  */
 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/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts

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

package/api/resources/empathicVoice/resources/configs/client/requests/index.d.ts

@@ -1,6 +1,6 @@
-export { type ConfigsListConfigsRequest } from "./ConfigsListConfigsRequest";
-export { type PostedConfig } from "./PostedConfig";
-export { type ConfigsListConfigVersionsRequest } from "./ConfigsListConfigVersionsRequest";
-export { type PostedConfigVersion } from "./PostedConfigVersion";
-export { type PostedConfigName } from "./PostedConfigName";
-export { type PostedConfigVersionDescription } from "./PostedConfigVersionDescription";
+export { type ConfigsListConfigsRequest } from './ConfigsListConfigsRequest';
+export { type PostedConfig } from './PostedConfig';
+export { type ConfigsListConfigVersionsRequest } from './ConfigsListConfigVersionsRequest';
+export { type PostedConfigVersion } from './PostedConfigVersion';
+export { type PostedConfigName } from './PostedConfigName';
+export { type PostedConfigVersionDescription } from './PostedConfigVersionDescription';

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

@@ -1 +1 @@
-export * from "./client";
+export * from './client';

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

@@ -1,12 +1,12 @@
-export * as chat from "./chat";
-export * from "./chat/types";
-export * as tools from "./tools";
-export * as prompts from "./prompts";
-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 "./configs/client/requests";
-export * from "./chats/client/requests";
-export * from "./chatGroups/client/requests";
+export * as chat from './chat';
+export * from './chat/types';
+export * as tools from './tools';
+export * as prompts from './prompts';
+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 './configs/client/requests';
+export * from './chats/client/requests';
+export * from './chatGroups/client/requests';

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

@@ -1,9 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as environments from "../../../../../../environments";
-import * as core from "../../../../../../core";
-import * as Hume from "../../../../../index";
+import * as environments from '../../../../../../environments';
+import * as core from '../../../../../../core';
+import * as Hume from '../../../../../index';
 export declare namespace Prompts {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -42,7 +42,7 @@ export declare class Prompts {
      */
     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.
      *
@@ -51,7 +51,7 @@ export declare class Prompts {
      */
     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.
      *
@@ -62,7 +62,7 @@ export declare class Prompts {
      */
     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
@@ -70,7 +70,7 @@ export declare class Prompts {
      */
     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.
      *
@@ -81,8 +81,12 @@ export declare class Prompts {
      */
     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
@@ -90,8 +94,12 @@ export declare class Prompts {
      */
     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
@@ -99,8 +107,12 @@ export declare class Prompts {
      */
     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.
      *
@@ -109,6 +121,6 @@ export declare class Prompts {
      */
     updatePromptDescription(id: string, version: number, request?: Hume.empathicVoice.PostedPromptVersionDescription, requestOptions?: Prompts.RequestOptions): Promise<Hume.empathicVoice.ReturnPrompt | undefined>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Hume-Api-Key": string | undefined;
+        'X-Hume-Api-Key': string | undefined;
     }>;
 }