hume 0.15.3-beta.1 → 0.15.3-beta.2

package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.d.ts

@@ -28,6 +28,7 @@ export declare namespace ControlPlane {
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface ConnectArgs {
+        chatId: string;
         accessToken?: string | undefined;
         /** Arbitrary headers to send with the websocket connect request. */
         headers?: Record<string, string>;
@@ -66,7 +67,7 @@ export declare class ControlPlane {
      */
     send(chatId: string, request: Hume.empathicVoice.ControlPlanePublishEvent, requestOptions?: ControlPlane.RequestOptions): core.HttpResponsePromise<void>;
     private __send;
-    connect(args?: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
+    connect(args: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Hume-Api-Key": string | undefined;
     }>;

package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.js

@@ -141,17 +141,17 @@ class ControlPlane {
             }
         });
     }
-    connect() {
-        return __awaiter(this, arguments, void 0, function* (args = {}) {
+    connect(args) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
-            const { accessToken, headers, debug, reconnectAttempts } = args;
+            const { chatId, accessToken, headers, debug, reconnectAttempts } = args;
             const _queryParams = {};
             if (accessToken != null) {
                 _queryParams["access_token"] = accessToken;
             }
             let _headers = (0, headers_js_1.mergeHeaders)((0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), headers);
             const socket = new core.ReconnectingWebSocket({
-                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options["environment"]))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, "/chat/"),
+                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options["environment"]))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, `/chat/${encodeURIComponent(chatId)}/connect`),
                 protocols: [],
                 queryParameters: _queryParams,
                 headers: _headers,

package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettings.d.ts

@@ -17,14 +17,9 @@ export interface ConnectSessionSettings {
      * Set to `null` to disable context injection.
      */
     context?: Hume.empathicVoice.ConnectSessionSettingsContext;
-    /**
-     * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
-     *
-     * If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
-     *
-     * It is recommended to pass a `custom_session_id` if you are using a Custom Language Model. Please see our guide to [using a custom language model](/docs/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
-     */
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
+    /** The maximum number of chat events to return from chat history. By default, the system returns up to 300 events (100 events per page × 3 pages). Set this parameter to a smaller value to limit the number of events returned. */
     eventLimit?: number;
     /**
      * Third party API key for the supplemental language model.
@@ -39,7 +34,7 @@ export interface ConnectSessionSettings {
      *
      * 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).
+     * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     systemPrompt?: string;
     /**
@@ -50,5 +45,6 @@ export interface ConnectSessionSettings {
      * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/speech-to-speech-evi/features/dynamic-variables).
      */
     variables?: Record<string, Hume.empathicVoice.ConnectSessionSettingsVariablesValue>;
+    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this EVI session. This will override the speaker set in the selected configuration. */
     voiceId?: string;
 }

package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.ts

@@ -8,10 +8,10 @@ import * as Hume from "../../../index.js";
  * This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
  */
 export interface ConnectSessionSettingsAudio {
-    /** Number of audio channels. */
+    /** Sets number of audio channels for audio input. */
     channels?: number;
-    /** Encoding format of the audio input, such as `linear16`. */
+    /** Sets encoding format of the audio input, such as `linear16`. */
     encoding?: Hume.empathicVoice.Encoding;
-    /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */
+    /** Sets the sample rate for audio input. (Number of samples per second in the audio input, measured in Hertz.) */
     sampleRate?: number;
 }

package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.ts

@@ -13,21 +13,15 @@ export interface ConnectSessionSettingsContext {
     /**
      * The context to be injected into the conversation. Helps inform the LLM's response by providing relevant information about the ongoing conversation.
      *
-     * This text will be appended to the end of user messages based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
+     * This text will be appended to the end of [user_messages](/reference/speech-to-speech-evi/chat#receive.UserMessage.message.content) based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
      */
     text?: string;
     /**
      * The persistence level of the injected context. Specifies how long the injected context will remain active in the session.
      *
-     * There are three possible context types:
+     * - **Temporary**: Context that is only applied to the following assistant response.
      *
-     * - **Persistent**: The context is appended to all user messages for the duration of the session.
-     *
-     * - **Temporary**: The context is appended only to the next user message.
-     *
-     *  - **Editable**: The original context is updated to reflect the new context.
-     *
-     *  If the type is not specified, it will default to `temporary`.
+     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
      */
     type?: Hume.empathicVoice.ContextType;
 }

package/dist/cjs/api/resources/tts/types/PostedTts.d.ts

@@ -9,7 +9,11 @@ export interface PostedTts {
     format?: Hume.tts.Format;
     /** The set of timestamp types to include in the response. */
     includeTimestampTypes?: Hume.tts.TimestampType[];
-    /** Number of generations of the audio to produce. */
+    /**
+     * Number of audio generations to produce from the input utterances.
+     *
+     * Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
+     */
     numGenerations?: number;
     /**
      * Controls how audio output is segmented in the response.

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts

@@ -28,6 +28,7 @@ export declare namespace ControlPlane {
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface ConnectArgs {
+        chatId: string;
         accessToken?: string | undefined;
         /** Arbitrary headers to send with the websocket connect request. */
         headers?: Record<string, string>;
@@ -66,7 +67,7 @@ export declare class ControlPlane {
      */
     send(chatId: string, request: Hume.empathicVoice.ControlPlanePublishEvent, requestOptions?: ControlPlane.RequestOptions): core.HttpResponsePromise<void>;
     private __send;
-    connect(args?: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
+    connect(args: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Hume-Api-Key": string | undefined;
     }>;

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs

@@ -105,17 +105,17 @@ export class ControlPlane {
             }
         });
     }
-    connect() {
-        return __awaiter(this, arguments, void 0, function* (args = {}) {
+    connect(args) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
-            const { accessToken, headers, debug, reconnectAttempts } = args;
+            const { chatId, accessToken, headers, debug, reconnectAttempts } = args;
             const _queryParams = {};
             if (accessToken != null) {
                 _queryParams["access_token"] = accessToken;
             }
             let _headers = mergeHeaders(mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), headers);
             const socket = new core.ReconnectingWebSocket({
-                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options["environment"]))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, "/chat/"),
+                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options["environment"]))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, `/chat/${encodeURIComponent(chatId)}/connect`),
                 protocols: [],
                 queryParameters: _queryParams,
                 headers: _headers,

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettings.d.mts

@@ -17,14 +17,9 @@ export interface ConnectSessionSettings {
      * Set to `null` to disable context injection.
      */
     context?: Hume.empathicVoice.ConnectSessionSettingsContext;
-    /**
-     * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
-     *
-     * If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
-     *
-     * It is recommended to pass a `custom_session_id` if you are using a Custom Language Model. Please see our guide to [using a custom language model](/docs/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
-     */
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
+    /** The maximum number of chat events to return from chat history. By default, the system returns up to 300 events (100 events per page × 3 pages). Set this parameter to a smaller value to limit the number of events returned. */
     eventLimit?: number;
     /**
      * Third party API key for the supplemental language model.
@@ -39,7 +34,7 @@ export interface ConnectSessionSettings {
      *
      * 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).
+     * For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
      */
     systemPrompt?: string;
     /**
@@ -50,5 +45,6 @@ export interface ConnectSessionSettings {
      * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/speech-to-speech-evi/features/dynamic-variables).
      */
     variables?: Record<string, Hume.empathicVoice.ConnectSessionSettingsVariablesValue>;
+    /** The name or ID of the voice from the `Voice Library` to be used as the speaker for this EVI session. This will override the speaker set in the selected configuration. */
     voiceId?: string;
 }

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.mts

@@ -8,10 +8,10 @@ import * as Hume from "../../../index.mjs";
  * This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
  */
 export interface ConnectSessionSettingsAudio {
-    /** Number of audio channels. */
+    /** Sets number of audio channels for audio input. */
     channels?: number;
-    /** Encoding format of the audio input, such as `linear16`. */
+    /** Sets encoding format of the audio input, such as `linear16`. */
     encoding?: Hume.empathicVoice.Encoding;
-    /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */
+    /** Sets the sample rate for audio input. (Number of samples per second in the audio input, measured in Hertz.) */
     sampleRate?: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.mts

@@ -13,21 +13,15 @@ export interface ConnectSessionSettingsContext {
     /**
      * The context to be injected into the conversation. Helps inform the LLM's response by providing relevant information about the ongoing conversation.
      *
-     * This text will be appended to the end of user messages based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
+     * This text will be appended to the end of [user_messages](/reference/speech-to-speech-evi/chat#receive.UserMessage.message.content) based on the chosen persistence level. For example, if you want to remind EVI of its role as a helpful weather assistant, the context you insert will be appended to the end of user messages as `{Context: You are a helpful weather assistant}`.
      */
     text?: string;
     /**
      * The persistence level of the injected context. Specifies how long the injected context will remain active in the session.
      *
-     * There are three possible context types:
+     * - **Temporary**: Context that is only applied to the following assistant response.
      *
-     * - **Persistent**: The context is appended to all user messages for the duration of the session.
-     *
-     * - **Temporary**: The context is appended only to the next user message.
-     *
-     *  - **Editable**: The original context is updated to reflect the new context.
-     *
-     *  If the type is not specified, it will default to `temporary`.
+     * - **Persistent**: Context that is applied to all subsequent assistant responses for the remainder of the Chat.
      */
     type?: Hume.empathicVoice.ContextType;
 }

package/dist/esm/api/resources/tts/types/PostedTts.d.mts

@@ -9,7 +9,11 @@ export interface PostedTts {
     format?: Hume.tts.Format;
     /** The set of timestamp types to include in the response. */
     includeTimestampTypes?: Hume.tts.TimestampType[];
-    /** Number of generations of the audio to produce. */
+    /**
+     * Number of audio generations to produce from the input utterances.
+     *
+     * Using `num_generations` enables faster processing than issuing multiple sequential requests. Additionally, specifying `num_generations` allows prosody continuation across all generations without repeating context, ensuring each generation sounds slightly different while maintaining contextual consistency.
+     */
     numGenerations?: number;
     /**
      * Controls how audio output is segmented in the response.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hume",
-    "version": "0.15.3-beta.1",
+    "version": "0.15.3-beta.2",
     "private": false,
     "repository": "github:humeai/hume-typescript-sdk",
     "type": "commonjs",