hume 0.8.5 → 0.8.7

package/api/resources/empathicVoice/resources/configs/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 Configs {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -27,7 +27,10 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.listConfigs()
+     *     await client.empathicVoice.configs.listConfigs({
+     *         pageNumber: 0,
+     *         pageSize: 1
+     *     })
      */
     listConfigs(request?: Hume.empathicVoice.ConfigsListConfigsRequest, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedConfigs>;
     /**
@@ -36,7 +39,34 @@ export declare class Configs {
      *
      * @example
      *     await client.empathicVoice.configs.createConfig({
-     *         name: "name"
+     *         name: "Weather Assistant Config",
+     *         prompt: {
+     *             id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
+     *             version: 0
+     *         },
+     *         voice: {
+     *             provider: "HUME_AI",
+     *             name: Hume.empathicVoice.PostedVoiceName.Kora
+     *         },
+     *         languageModel: {
+     *             modelProvider: Hume.empathicVoice.PostedLanguageModelModelProvider.Anthropic,
+     *             modelResource: "claude-3-5-sonnet-20240620",
+     *             temperature: 1
+     *         },
+     *         eventMessages: {
+     *             onNewChat: {
+     *                 enabled: false,
+     *                 text: ""
+     *             },
+     *             onInactivityTimeout: {
+     *                 enabled: false,
+     *                 text: ""
+     *             },
+     *             onMaxDurationTimeout: {
+     *                 enabled: false,
+     *                 text: ""
+     *             }
+     *         }
      *     })
      */
     createConfig(request: Hume.empathicVoice.PostedConfig, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
@@ -46,7 +76,7 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.listConfigVersions("id")
+     *     await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3")
      */
     listConfigVersions(id: string, request?: Hume.empathicVoice.ConfigsListConfigVersionsRequest, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnPagedConfigs>;
     /**
@@ -55,7 +85,39 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.createConfigVersion("id")
+     *     await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
+     *         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: ""
+     *             }
+     *         }
+     *     })
      */
     createConfigVersion(id: string, request?: Hume.empathicVoice.PostedConfigVersion, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     /**
@@ -63,7 +125,7 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.deleteConfig("id")
+     *     await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3")
      */
     deleteConfig(id: string, requestOptions?: Configs.RequestOptions): Promise<void>;
     /**
@@ -72,8 +134,8 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.updateConfigName("string", {
-     *         name: "string"
+     *     await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
+     *         name: "Updated Weather Assistant Config Name"
      *     })
      */
     updateConfigName(id: string, request: Hume.empathicVoice.PostedConfigName, requestOptions?: Configs.RequestOptions): Promise<string>;
@@ -87,7 +149,7 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.getConfigVersion("id", 1)
+     *     await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1)
      */
     getConfigVersion(id: string, version: number, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     /**
@@ -100,7 +162,7 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.deleteConfigVersion("id", 1)
+     *     await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1)
      */
     deleteConfigVersion(id: string, version: number, requestOptions?: Configs.RequestOptions): Promise<void>;
     /**
@@ -114,10 +176,12 @@ export declare class Configs {
      * @param {Configs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.empathicVoice.configs.updateConfigDescription("id", 1)
+     *     await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
+     *         versionDescription: "This is an updated version_description."
+     *     })
      */
     updateConfigDescription(id: string, version: number, request?: Hume.empathicVoice.PostedConfigVersionDescription, requestOptions?: Configs.RequestOptions): Promise<Hume.empathicVoice.ReturnConfig>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        'X-Hume-Api-Key': string | undefined;
+        "X-Hume-Api-Key": string | undefined;
     }>;
 }