hume 0.14.0 → 0.14.1

package/.mock/definition/empathic-voice/chat.yml

@@ -98,17 +98,111 @@ channel:
         Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
         of all Chat Groups associated with an API key. This endpoint returns a
         list of all available chat groups.
-    session_settings[audio][channels]: optional<integer>
-    session_settings[audio][encoding]: optional<string>
-    session_settings[audio][sample_rate]: optional<integer>
-    session_settings[context][text]: optional<string>
-    session_settings[context][type]: optional<string>
-    session_settings[custom_session_id]: optional<string>
-    session_settings[event_limit]: optional<integer>
-    session_settings[language_model_api_key]: optional<string>
-    session_settings[system_prompt]: optional<string>
-    session_settings[variables]: optional<string>
-    session_settings[voice_id]: optional<string>
+    session_settings[audio][channels]:
+      type: optional<integer>
+      docs: Sets number of audio channels for audio input.
+    session_settings[audio][encoding]:
+      type: optional<string>
+      docs: Sets encoding format of the audio input, such as `linear16`.
+    session_settings[audio][sample_rate]:
+      type: optional<integer>
+      docs: >-
+        Sets the sample rate for audio input. (Number of samples per second in
+        the audio input, measured in Hertz.)
+    session_settings[context][text]:
+      type: optional<string>
+      docs: >-
+        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](/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}`.
+    session_settings[context][type]:
+      type: optional<string>
+      docs: >-
+        The persistence level of the injected context. Specifies how long the
+        injected context will remain active in the session.
+
+
+        - **Temporary**: Context that is only applied to the following assistant
+        response.
+
+
+        - **Persistent**: Context that is applied to all subsequent assistant
+        responses for the remainder of the Chat.
+    session_settings[custom_session_id]:
+      type: optional<string>
+      docs: >-
+        Used to manage conversational state, correlate frontend and backend
+        data, and persist conversations across EVI sessions.
+    session_settings[event_limit]:
+      type: optional<integer>
+      docs: >-
+        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.
+    session_settings[language_model_api_key]:
+      type: optional<string>
+      docs: >-
+        Third party API key for the supplemental language model.
+
+
+        When provided, EVI will use this key instead of Hume's API key for the
+        supplemental LLM. This allows you to bypass rate limits and utilize your
+        own API key as needed.
+    session_settings[system_prompt]:
+      type: optional<string>
+      docs: >-
+        Instructions used to shape EVI's behavior, responses, and style for the
+        session.
+
+
+        When included in a Session Settings message, the provided Prompt
+        overrides the existing one specified in the EVI configuration. If no
+        Prompt was defined in the configuration, this Prompt will be the one
+        used for the session.
+
+
+        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/speech-to-speech-evi/guides/prompting).
+    session_settings[variables]:
+      type: optional<string>
+      docs: >-
+        This field allows you to assign values to dynamic variables referenced
+        in your system prompt.
+
+
+        Each key represents the variable name, and the corresponding value is
+        the specific content you wish to assign to that variable within the
+        session. While the values for variables can be strings, numbers, or
+        booleans, the value will ultimately be converted to a string when
+        injected into your system prompt.
+
+
+        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).
+    session_settings[voice_id]:
+      type: optional<string>
+      docs: >-
+        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.
     verbose_transcription:
       type: optional<boolean>
       default: false

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

@@ -2,6 +2,7 @@
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
 import { ChatSocket } from "./Socket";
+import { SessionSettings } from "../../../types/SessionSettings";
 export declare function createHostnameWithProtocol(environment: string): string;
 export declare namespace Chat {
     interface Options {
@@ -24,6 +25,9 @@ export declare namespace Chat {
         verboseTranscription?: boolean;
         /** ID of the Voice to use for this chat. If specified, will override the voice set in the Config */
         voiceId?: string;
+        sessionSettings?: Pick<SessionSettings, Exclude<keyof SessionSettings, "builtinTools" | "type" | "metadata" | "tools">> & {
+            eventLimit?: number;
+        };
         /** Extra query parameters sent at WebSocket connection */
         queryParams?: Record<string, string | string[] | object | object[]>;
     }

package/api/resources/empathicVoice/resources/chat/client/Client.js

@@ -58,7 +58,7 @@ class Chat {
         this._options = _options;
     }
     connect(args = {}) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
         const queryParams = {};
         queryParams["fernSdkLanguage"] = "JavaScript";
         queryParams["fernSdkVersion"] = version_1.SDK_VERSION;
@@ -85,15 +85,58 @@ class Chat {
         if (args.voiceId !== null && args.voiceId !== undefined && args.voiceId !== "") {
             queryParams["voice_id"] = args.voiceId;
         }
+        if (args.sessionSettings !== null && args.sessionSettings !== undefined) {
+            if (args.sessionSettings.audio !== null && args.sessionSettings.audio !== undefined) {
+                if (((_a = args.sessionSettings.audio) === null || _a === void 0 ? void 0 : _a.channels) !== null &&
+                    ((_b = args.sessionSettings.audio) === null || _b === void 0 ? void 0 : _b.channels) !== undefined) {
+                    queryParams["session_settings[audio][channels]"] = String(args.sessionSettings.audio.channels);
+                }
+                if (((_c = args.sessionSettings.audio) === null || _c === void 0 ? void 0 : _c.encoding) !== null &&
+                    ((_d = args.sessionSettings.audio) === null || _d === void 0 ? void 0 : _d.encoding) !== undefined) {
+                    queryParams["session_settings[audio][encoding]"] = String(args.sessionSettings.audio.encoding);
+                }
+                if (((_e = args.sessionSettings.audio) === null || _e === void 0 ? void 0 : _e.sampleRate) !== null &&
+                    ((_f = args.sessionSettings.audio) === null || _f === void 0 ? void 0 : _f.sampleRate) !== undefined) {
+                    queryParams["session_settings[audio][sample_rate]"] = String(args.sessionSettings.audio.sampleRate);
+                }
+            }
+            if (args.sessionSettings.context !== null && args.sessionSettings.context !== undefined) {
+                if (((_h = (_g = args.sessionSettings) === null || _g === void 0 ? void 0 : _g.context) === null || _h === void 0 ? void 0 : _h.text) !== null && ((_k = (_j = args.sessionSettings) === null || _j === void 0 ? void 0 : _j.context) === null || _k === void 0 ? void 0 : _k.text) !== undefined) {
+                    queryParams["session_settings[context][text]"] = String(args.sessionSettings.context.text);
+                }
+                if (((_m = (_l = args.sessionSettings) === null || _l === void 0 ? void 0 : _l.context) === null || _m === void 0 ? void 0 : _m.type) !== null && ((_p = (_o = args.sessionSettings) === null || _o === void 0 ? void 0 : _o.context) === null || _p === void 0 ? void 0 : _p.type) !== undefined) {
+                    queryParams["session_settings[context][type]"] = String(args.sessionSettings.context.type);
+                }
+            }
+            if (((_q = args.sessionSettings) === null || _q === void 0 ? void 0 : _q.customSessionId) !== null && ((_r = args.sessionSettings) === null || _r === void 0 ? void 0 : _r.customSessionId) !== undefined) {
+                queryParams["session_settings[custom_session_id]"] = String(args.sessionSettings.customSessionId);
+            }
+            if (((_s = args.sessionSettings) === null || _s === void 0 ? void 0 : _s.eventLimit) !== null && ((_t = args.sessionSettings) === null || _t === void 0 ? void 0 : _t.eventLimit) !== undefined) {
+                queryParams["session_settings[event_limit]"] = String(args.sessionSettings.eventLimit);
+            }
+            if (((_u = args.sessionSettings) === null || _u === void 0 ? void 0 : _u.languageModelApiKey) !== null &&
+                ((_v = args.sessionSettings) === null || _v === void 0 ? void 0 : _v.languageModelApiKey) !== undefined) {
+                queryParams["session_settings[language_model_api_key]"] = String(args.sessionSettings.languageModelApiKey);
+            }
+            if (((_w = args.sessionSettings) === null || _w === void 0 ? void 0 : _w.systemPrompt) !== null && ((_x = args.sessionSettings) === null || _x === void 0 ? void 0 : _x.systemPrompt) !== undefined) {
+                queryParams["session_settings[system_prompt]"] = String(args.sessionSettings.systemPrompt);
+            }
+            if (((_y = args.sessionSettings) === null || _y === void 0 ? void 0 : _y.variables) !== null && ((_z = args.sessionSettings) === null || _z === void 0 ? void 0 : _z.variables) !== undefined) {
+                queryParams["session_settings[variables]"] = String(args.sessionSettings.variables);
+            }
+            if (((_0 = args.sessionSettings) === null || _0 === void 0 ? void 0 : _0.voiceId) !== null && ((_1 = args.sessionSettings) === null || _1 === void 0 ? void 0 : _1.voiceId) !== undefined) {
+                queryParams["session_settings[voice_id]"] = String(args.sessionSettings.voiceId);
+            }
+        }
         if (args.queryParams !== null && args.queryParams !== undefined) {
             for (const [name, value] of Object.entries(args.queryParams)) {
                 queryParams[name] = value;
             }
         }
-        const hostname = createHostnameWithProtocol((_a = core.Supplier.get(this._options.environment)) !== null && _a !== void 0 ? _a : environments.HumeEnvironment.Production);
+        const hostname = createHostnameWithProtocol((_2 = core.Supplier.get(this._options.environment)) !== null && _2 !== void 0 ? _2 : environments.HumeEnvironment.Production);
         const socket = new core.ReconnectingWebSocket(`${hostname}/v0/evi/chat?${qs_1.default.stringify(queryParams)}`, [], {
-            debug: (_b = args.debug) !== null && _b !== void 0 ? _b : false,
-            maxRetries: (_c = args.reconnectAttempts) !== null && _c !== void 0 ? _c : 30,
+            debug: (_3 = args.debug) !== null && _3 !== void 0 ? _3 : false,
+            maxRetries: (_4 = args.reconnectAttempts) !== null && _4 !== void 0 ? _4 : 30,
         });
         return new Socket_1.ChatSocket({
             socket,

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

@@ -2,6 +2,7 @@
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
 import { ChatSocket } from "./Socket";
+import { SessionSettings } from "../../../types/SessionSettings";
 export declare function createHostnameWithProtocol(environment: string): string;
 export declare namespace Chat {
     interface Options {
@@ -24,6 +25,9 @@ export declare namespace Chat {
         verboseTranscription?: boolean;
         /** ID of the Voice to use for this chat. If specified, will override the voice set in the Config */
         voiceId?: string;
+        sessionSettings?: Pick<SessionSettings, Exclude<keyof SessionSettings, "builtinTools" | "type" | "metadata" | "tools">> & {
+            eventLimit?: number;
+        };
         /** Extra query parameters sent at WebSocket connection */
         queryParams?: Record<string, string | string[] | object | object[]>;
     }

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

@@ -58,7 +58,7 @@ class Chat {
         this._options = _options;
     }
     connect(args = {}) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
         const queryParams = {};
         queryParams["fernSdkLanguage"] = "JavaScript";
         queryParams["fernSdkVersion"] = version_1.SDK_VERSION;
@@ -85,15 +85,58 @@ class Chat {
         if (args.voiceId !== null && args.voiceId !== undefined && args.voiceId !== "") {
             queryParams["voice_id"] = args.voiceId;
         }
+        if (args.sessionSettings !== null && args.sessionSettings !== undefined) {
+            if (args.sessionSettings.audio !== null && args.sessionSettings.audio !== undefined) {
+                if (((_a = args.sessionSettings.audio) === null || _a === void 0 ? void 0 : _a.channels) !== null &&
+                    ((_b = args.sessionSettings.audio) === null || _b === void 0 ? void 0 : _b.channels) !== undefined) {
+                    queryParams["session_settings[audio][channels]"] = String(args.sessionSettings.audio.channels);
+                }
+                if (((_c = args.sessionSettings.audio) === null || _c === void 0 ? void 0 : _c.encoding) !== null &&
+                    ((_d = args.sessionSettings.audio) === null || _d === void 0 ? void 0 : _d.encoding) !== undefined) {
+                    queryParams["session_settings[audio][encoding]"] = String(args.sessionSettings.audio.encoding);
+                }
+                if (((_e = args.sessionSettings.audio) === null || _e === void 0 ? void 0 : _e.sampleRate) !== null &&
+                    ((_f = args.sessionSettings.audio) === null || _f === void 0 ? void 0 : _f.sampleRate) !== undefined) {
+                    queryParams["session_settings[audio][sample_rate]"] = String(args.sessionSettings.audio.sampleRate);
+                }
+            }
+            if (args.sessionSettings.context !== null && args.sessionSettings.context !== undefined) {
+                if (((_h = (_g = args.sessionSettings) === null || _g === void 0 ? void 0 : _g.context) === null || _h === void 0 ? void 0 : _h.text) !== null && ((_k = (_j = args.sessionSettings) === null || _j === void 0 ? void 0 : _j.context) === null || _k === void 0 ? void 0 : _k.text) !== undefined) {
+                    queryParams["session_settings[context][text]"] = String(args.sessionSettings.context.text);
+                }
+                if (((_m = (_l = args.sessionSettings) === null || _l === void 0 ? void 0 : _l.context) === null || _m === void 0 ? void 0 : _m.type) !== null && ((_p = (_o = args.sessionSettings) === null || _o === void 0 ? void 0 : _o.context) === null || _p === void 0 ? void 0 : _p.type) !== undefined) {
+                    queryParams["session_settings[context][type]"] = String(args.sessionSettings.context.type);
+                }
+            }
+            if (((_q = args.sessionSettings) === null || _q === void 0 ? void 0 : _q.customSessionId) !== null && ((_r = args.sessionSettings) === null || _r === void 0 ? void 0 : _r.customSessionId) !== undefined) {
+                queryParams["session_settings[custom_session_id]"] = String(args.sessionSettings.customSessionId);
+            }
+            if (((_s = args.sessionSettings) === null || _s === void 0 ? void 0 : _s.eventLimit) !== null && ((_t = args.sessionSettings) === null || _t === void 0 ? void 0 : _t.eventLimit) !== undefined) {
+                queryParams["session_settings[event_limit]"] = String(args.sessionSettings.eventLimit);
+            }
+            if (((_u = args.sessionSettings) === null || _u === void 0 ? void 0 : _u.languageModelApiKey) !== null &&
+                ((_v = args.sessionSettings) === null || _v === void 0 ? void 0 : _v.languageModelApiKey) !== undefined) {
+                queryParams["session_settings[language_model_api_key]"] = String(args.sessionSettings.languageModelApiKey);
+            }
+            if (((_w = args.sessionSettings) === null || _w === void 0 ? void 0 : _w.systemPrompt) !== null && ((_x = args.sessionSettings) === null || _x === void 0 ? void 0 : _x.systemPrompt) !== undefined) {
+                queryParams["session_settings[system_prompt]"] = String(args.sessionSettings.systemPrompt);
+            }
+            if (((_y = args.sessionSettings) === null || _y === void 0 ? void 0 : _y.variables) !== null && ((_z = args.sessionSettings) === null || _z === void 0 ? void 0 : _z.variables) !== undefined) {
+                queryParams["session_settings[variables]"] = String(args.sessionSettings.variables);
+            }
+            if (((_0 = args.sessionSettings) === null || _0 === void 0 ? void 0 : _0.voiceId) !== null && ((_1 = args.sessionSettings) === null || _1 === void 0 ? void 0 : _1.voiceId) !== undefined) {
+                queryParams["session_settings[voice_id]"] = String(args.sessionSettings.voiceId);
+            }
+        }
         if (args.queryParams !== null && args.queryParams !== undefined) {
             for (const [name, value] of Object.entries(args.queryParams)) {
                 queryParams[name] = value;
             }
         }
-        const hostname = createHostnameWithProtocol((_a = core.Supplier.get(this._options.environment)) !== null && _a !== void 0 ? _a : environments.HumeEnvironment.Production);
+        const hostname = createHostnameWithProtocol((_2 = core.Supplier.get(this._options.environment)) !== null && _2 !== void 0 ? _2 : environments.HumeEnvironment.Production);
         const socket = new core.ReconnectingWebSocket(`${hostname}/v0/evi/chat?${qs_1.default.stringify(queryParams)}`, [], {
-            debug: (_b = args.debug) !== null && _b !== void 0 ? _b : false,
-            maxRetries: (_c = args.reconnectAttempts) !== null && _c !== void 0 ? _c : 30,
+            debug: (_3 = args.debug) !== null && _3 !== void 0 ? _3 : false,
+            maxRetries: (_4 = args.reconnectAttempts) !== null && _4 !== void 0 ? _4 : 30,
         });
         return new Socket_1.ChatSocket({
             socket,

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.0";
+export declare const SDK_VERSION = "0.14.1";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.14.0";
+exports.SDK_VERSION = "0.14.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hume",
-    "version": "0.14.0",
+    "version": "0.14.1",
     "private": false,
     "repository": "https://github.com/HumeAI/hume-typescript-sdk",
     "main": "./index.js",

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.0";
+export declare const SDK_VERSION = "0.14.1";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.14.0";
+exports.SDK_VERSION = "0.14.1";