hume 0.8.1-beta3 → 0.8.1-beta4

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

@@ -963,7 +963,7 @@ types:
     docs: When provided, the output is an assistant end message.
     properties:
       type:
-        type: literal<"assistant_message">
+        type: literal<"assistant_end">
         docs: >-
           The type of message sent through the socket; for an Assistant End
           message, this must be `assistant_end`.

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

@@ -4,23 +4,100 @@ channel:
   query-parameters:
     config_id:
       type: optional<string>
-      docs: The unique identifier for the EVI configuration to be used.
+      docs: >-
+        The unique identifier for an EVI configuration.
+
+
+        Include this ID in your connection request to equip EVI with the Prompt,
+        Language Model, Voice, and Tools associated with the specified
+        configuration. If omitted, EVI will apply [default configuration
+        settings](/docs/empathic-voice-interface-evi/configuration#default-configuration).
+
+
+        For help obtaining this ID, see our [Configuration
+        Guide](/docs/empathic-voice-interface-evi/configuration).
     config_version:
       type: optional<integer>
-      docs: The version number of the specified EVI configuration to be used.
+      docs: >-
+        The version number of the EVI configuration specified by the
+        `config_id`.
+
+
+        Configs, as well as Prompts, Tools, and Language Models, are versioned.
+        This versioning system supports iterative development, allowing you to
+        progressively refine configurations and revert to previous versions if
+        needed.
+
+
+        Include this parameter to apply a specific version of an EVI
+        configuration. If omitted, the latest version will be applied.
     resumed_chat_group_id:
       type: optional<string>
-      docs: The unique identifier for a chat group. Used to resume a previous chat.
+      docs: >-
+        The unique identifier for a Chat Group. Use this field to preserve
+        context from a previous Chat session.
+
+
+        A Chat represents a single session from opening to closing a WebSocket
+        connection. In contrast, a Chat Group is a series of resumed Chats that
+        collectively represent a single conversation spanning multiple sessions.
+        Each Chat includes a Chat Group ID, which is used to preserve the
+        context of previous Chat sessions when starting a new one.
+
+
+        Including the Chat Group ID in the `resumed_chat_group_id` query
+        parameter is useful for seamlessly resuming a Chat after unexpected
+        network disconnections and for picking up conversations exactly where
+        you left off at a later time. This ensures preserved context across
+        multiple sessions.
+
+
+        There are three ways to obtain the Chat Group ID:
+
+
+        - [Chat
+        Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
+        Upon establishing a WebSocket connection with EVI, the user receives a
+        Chat Metadata message. This message contains a `chat_group_id`, which
+        can be used to resume conversations within this chat group in future
+        sessions.
+
+
+        - [List Chats
+        endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use
+        the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of
+        individual Chat sessions. This endpoint lists all available Chat
+        sessions and their associated Chat Group ID.
+
+
+        - [List Chat Groups
+        endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups):
+        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.
     access_token:
       type: optional<string>
       docs: >-
         Access token used for authenticating the client. If not provided, an
         `api_key` must be provided to authenticate.
+
+
+        The access token is generated using both an API key and a Secret key,
+        which provides an additional layer of security compared to using just an
+        API key.
+
+
+        For more details, refer to the [Authentication Strategies
+        Guide](/docs/introduction/api-key#authentication-strategies).
     api_key:
       type: optional<string>
       docs: >-
         API key used for authenticating the client. If not provided, an
         `access_token` must be provided to authenticate.
+
+
+        For more details, refer to the [Authentication Strategies
+        Guide](/docs/introduction/api-key#authentication-strategies).
   messages:
     subscribe:
       origin: server
@@ -36,7 +113,7 @@ channel:
             data: data
         - type: subscribe
           body:
-            type: assistant_message
+            type: assistant_end
 imports:
   root: __package__.yml
 types:

package/Client.d.ts

@@ -3,8 +3,8 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client";
 import { ExpressionMeasurement } from "./api/resources/expressionMeasurement/client/Client";
+import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client";
 export declare namespace HumeClient {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -23,8 +23,8 @@ export declare namespace HumeClient {
 export declare class HumeClient {
     protected readonly _options: HumeClient.Options;
     constructor(_options?: HumeClient.Options);
-    protected _empathicVoice: EmpathicVoice | undefined;
-    get empathicVoice(): EmpathicVoice;
     protected _expressionMeasurement: ExpressionMeasurement | undefined;
     get expressionMeasurement(): ExpressionMeasurement;
+    protected _empathicVoice: EmpathicVoice | undefined;
+    get empathicVoice(): EmpathicVoice;
 }

package/Client.js

@@ -4,19 +4,19 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HumeClient = void 0;
-const Client_1 = require("./api/resources/empathicVoice/client/Client");
-const Client_2 = require("./api/resources/expressionMeasurement/client/Client");
+const Client_1 = require("./api/resources/expressionMeasurement/client/Client");
+const Client_2 = require("./api/resources/empathicVoice/client/Client");
 class HumeClient {
     constructor(_options = {}) {
         this._options = _options;
     }
-    get empathicVoice() {
+    get expressionMeasurement() {
         var _a;
-        return ((_a = this._empathicVoice) !== null && _a !== void 0 ? _a : (this._empathicVoice = new Client_1.EmpathicVoice(this._options)));
+        return ((_a = this._expressionMeasurement) !== null && _a !== void 0 ? _a : (this._expressionMeasurement = new Client_1.ExpressionMeasurement(this._options)));
     }
-    get expressionMeasurement() {
+    get empathicVoice() {
         var _a;
-        return ((_a = this._expressionMeasurement) !== null && _a !== void 0 ? _a : (this._expressionMeasurement = new Client_2.ExpressionMeasurement(this._options)));
+        return ((_a = this._empathicVoice) !== null && _a !== void 0 ? _a : (this._empathicVoice = new Client_2.EmpathicVoice(this._options)));
     }
 }
 exports.HumeClient = HumeClient;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,2 +1,3 @@
 export * from "./resources";
 export * from "./types";
+export * from "./client";

package/api/resources/empathicVoice/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./resources"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);

package/api/resources/empathicVoice/types/AssistantEnd.d.ts

@@ -6,7 +6,7 @@
  */
 export interface AssistantEnd {
     /** The type of message sent through the socket; for an Assistant End message, this must be `assistant_end`. */
-    type: "assistant_message";
+    type: "assistant_end";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
 }

package/api/resources/index.d.ts

@@ -1,2 +1,2 @@
-export * as empathicVoice from "./empathicVoice";
 export * as expressionMeasurement from "./expressionMeasurement";
+export * as empathicVoice from "./empathicVoice";

package/api/resources/index.js

@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expressionMeasurement = exports.empathicVoice = void 0;
-exports.empathicVoice = __importStar(require("./empathicVoice"));
+exports.empathicVoice = exports.expressionMeasurement = void 0;
 exports.expressionMeasurement = __importStar(require("./expressionMeasurement"));
+exports.empathicVoice = __importStar(require("./empathicVoice"));

package/dist/Client.d.ts

@@ -3,8 +3,8 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client";
 import { ExpressionMeasurement } from "./api/resources/expressionMeasurement/client/Client";
+import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client";
 export declare namespace HumeClient {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -23,8 +23,8 @@ export declare namespace HumeClient {
 export declare class HumeClient {
     protected readonly _options: HumeClient.Options;
     constructor(_options?: HumeClient.Options);
-    protected _empathicVoice: EmpathicVoice | undefined;
-    get empathicVoice(): EmpathicVoice;
     protected _expressionMeasurement: ExpressionMeasurement | undefined;
     get expressionMeasurement(): ExpressionMeasurement;
+    protected _empathicVoice: EmpathicVoice | undefined;
+    get empathicVoice(): EmpathicVoice;
 }

package/dist/Client.js

@@ -4,19 +4,19 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HumeClient = void 0;
-const Client_1 = require("./api/resources/empathicVoice/client/Client");
-const Client_2 = require("./api/resources/expressionMeasurement/client/Client");
+const Client_1 = require("./api/resources/expressionMeasurement/client/Client");
+const Client_2 = require("./api/resources/empathicVoice/client/Client");
 class HumeClient {
     constructor(_options = {}) {
         this._options = _options;
     }
-    get empathicVoice() {
+    get expressionMeasurement() {
         var _a;
-        return ((_a = this._empathicVoice) !== null && _a !== void 0 ? _a : (this._empathicVoice = new Client_1.EmpathicVoice(this._options)));
+        return ((_a = this._expressionMeasurement) !== null && _a !== void 0 ? _a : (this._expressionMeasurement = new Client_1.ExpressionMeasurement(this._options)));
     }
-    get expressionMeasurement() {
+    get empathicVoice() {
         var _a;
-        return ((_a = this._expressionMeasurement) !== null && _a !== void 0 ? _a : (this._expressionMeasurement = new Client_2.ExpressionMeasurement(this._options)));
+        return ((_a = this._empathicVoice) !== null && _a !== void 0 ? _a : (this._empathicVoice = new Client_2.EmpathicVoice(this._options)));
     }
 }
 exports.HumeClient = HumeClient;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,2 +1,3 @@
 export * from "./resources";
 export * from "./types";
+export * from "./client";

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

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./resources"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/resources/empathicVoice/types/AssistantEnd.d.ts

@@ -6,7 +6,7 @@
  */
 export interface AssistantEnd {
     /** The type of message sent through the socket; for an Assistant End message, this must be `assistant_end`. */
-    type: "assistant_message";
+    type: "assistant_end";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
 }

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

@@ -1,2 +1,2 @@
-export * as empathicVoice from "./empathicVoice";
 export * as expressionMeasurement from "./expressionMeasurement";
+export * as empathicVoice from "./empathicVoice";

package/dist/api/resources/index.js

@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expressionMeasurement = exports.empathicVoice = void 0;
-exports.empathicVoice = __importStar(require("./empathicVoice"));
+exports.empathicVoice = exports.expressionMeasurement = void 0;
 exports.expressionMeasurement = __importStar(require("./expressionMeasurement"));
+exports.empathicVoice = __importStar(require("./empathicVoice"));

package/dist/serialization/resources/empathicVoice/types/AssistantEnd.d.ts

@@ -7,7 +7,7 @@ import * as core from "../../../../core";
 export declare const AssistantEnd: core.serialization.ObjectSchema<serializers.empathicVoice.AssistantEnd.Raw, Hume.empathicVoice.AssistantEnd>;
 export declare namespace AssistantEnd {
     interface Raw {
-        type: "assistant_message";
+        type: "assistant_end";
         custom_session_id?: string | null;
     }
 }

package/dist/serialization/resources/empathicVoice/types/AssistantEnd.js

@@ -29,6 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssistantEnd = void 0;
 const core = __importStar(require("../../../../core"));
 exports.AssistantEnd = core.serialization.object({
-    type: core.serialization.stringLiteral("assistant_message"),
+    type: core.serialization.stringLiteral("assistant_end"),
     customSessionId: core.serialization.property("custom_session_id", core.serialization.string().optional()),
 });

package/dist/serialization/resources/index.d.ts

@@ -1,2 +1,2 @@
-export * as empathicVoice from "./empathicVoice";
 export * as expressionMeasurement from "./expressionMeasurement";
+export * as empathicVoice from "./empathicVoice";

package/dist/serialization/resources/index.js

@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.expressionMeasurement = exports.empathicVoice = void 0;
-exports.empathicVoice = __importStar(require("./empathicVoice"));
+exports.empathicVoice = exports.expressionMeasurement = void 0;
 exports.expressionMeasurement = __importStar(require("./expressionMeasurement"));
+exports.empathicVoice = __importStar(require("./empathicVoice"));

package/package.json

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