hume 0.7.1 → 0.8.0

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

@@ -2,6 +2,15 @@ channel:
   path: /v0/evi/chat
   auth: false
   query-parameters:
+    config_id:
+      type: optional<string>
+      docs: The unique identifier for the EVI configuration to be used.
+    config_version:
+      type: optional<integer>
+      docs: The version number of the specified EVI configuration to be used.
+    resumed_chat_group_id:
+      type: optional<string>
+      docs: The unique identifier for a chat group. Used to resume a previous chat.
     access_token:
       type: optional<string>
       docs: >-
@@ -12,15 +21,6 @@ channel:
       docs: >-
         API key used for authenticating the client. If not provided, an
         `access_token` must be provided to authenticate.
-    config_id:
-      type: optional<string>
-      docs: The unique identifier for the EVI configuration to be used.
-    config_version:
-      type: optional<integer>
-      docs: The version number of the specified EVI configuration to be used.
-    resumed_chat_group_id:
-      type: optional<string>
-      docs: The unique identifier for a chat group. Used to resume a previous chat.
   messages:
     subscribe:
       origin: server
@@ -32,11 +32,11 @@ channel:
     - messages:
         - type: publish
           body:
-            data: data
             type: audio_input
+            data: data
         - type: subscribe
           body:
-            type: assistant_end
+            type: assistant_message
 imports:
   root: __package__.yml
 types:

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

@@ -18,6 +18,12 @@ service:
           page_size:
             type: optional<integer>
             docs: The maximum number of results to include per page.
+          ascending_order:
+            type: optional<boolean>
+            docs: >-
+              Boolean to indicate if the results should be paginated in
+              chronological order or reverse-chronological order. Defaults to
+              true.
       response:
         docs: Success
         type: root.ReturnPagedChatGroups
@@ -26,6 +32,8 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
+              pagination_direction: pagination_direction
               chat_groups_page:
                 - id: id
                   first_start_timestamp: 1
@@ -68,6 +76,7 @@ service:
               id: id
               page_number: 1
               page_size: 1
+              total_pages: 1
               pagination_direction: pagination_direction
               events_page:
                 - id: id

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

@@ -20,7 +20,10 @@ service:
             docs: The maximum number of results to include per page.
           ascending_order:
             type: optional<boolean>
-            docs: List chats in ascending order.
+            docs: >-
+              Boolean to indicate if the results should be paginated in
+              chronological order or reverse-chronological order. Defaults to
+              true.
       response:
         docs: Success
         type: root.ReturnPagedChats
@@ -29,6 +32,8 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
+              pagination_direction: pagination_direction
               chats_page:
                 - id: id
                   chat_group_id: chat_group_id
@@ -58,6 +63,12 @@ service:
           page_number:
             type: optional<integer>
             docs: The page number of the results to return.
+          ascending_order:
+            type: optional<boolean>
+            docs: >-
+              Boolean to indicate if the results should be paginated in
+              chronological order or reverse-chronological order. Defaults to
+              true.
       response:
         docs: Success
         type: root.ReturnChatPagedEvents
@@ -72,6 +83,7 @@ service:
               status: status
               start_timestamp: 1
               end_timestamp: 1
+              pagination_direction: pagination_direction
               events_page:
                 - id: id
                   chat_id: chat_id
@@ -84,6 +96,7 @@ service:
               metadata: metadata
               page_number: 1
               page_size: 1
+              total_pages: 1
               config:
                 id: id
                 version: 1

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

@@ -29,6 +29,7 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
               configs_page:
                 - id: id
                   version: 1
@@ -46,19 +47,8 @@ service:
                     text: text
                   voice:
                     provider: provider
-                    name: name
-                  tools:
-                    tool_type: tool_type
-                    id: id
-                    version: 1
-                    version_type: version_type
-                    name: name
-                    created_on: 1
-                    modified_on: 1
-                    parameters: parameters
-                  builtin_tools:
-                    tool_type: tool_type
-                    name: name
+                  ellm_model:
+                    allow_short_responses: true
     create-config:
       path: /v0/evi/configs
       method: POST
@@ -77,10 +67,16 @@ service:
             prompt: optional<root.PostedPromptSpec>
             voice: optional<root.PostedVoice>
             language_model: optional<root.PostedLanguageModel>
-            tools: optional<root.PostedUserDefinedToolSpec>
-            builtin_tools: optional<root.PostedBuiltinTool>
+            ellm_model: optional<root.PostedEllmModel>
+            tools:
+              type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
+              docs: Tool specification for a Config.
+            builtin_tools:
+              type: optional<list<optional<root.PostedBuiltinTool>>>
+              docs: Built-in tool specification for a Config.
+            event_messages: optional<root.PostedEventMessageSpecs>
       response:
-        docs: Success
+        docs: Created
         type: root.ReturnConfig
       examples:
         - request:
@@ -109,22 +105,28 @@ service:
                 model_provider: model_provider
                 model_resource: model_resource
                 temperature: 1.1
+              ellm_model:
+                allow_short_responses: true
               tools:
-                tool_type: tool_type
-                id: id
-                version: 1
-                version_type: version_type
-                version_description: version_description
-                name: name
-                created_on: 1
-                modified_on: 1
-                fallback_content: fallback_content
-                description: description
-                parameters: parameters
+                - tool_type: tool_type
+                  id: id
+                  version: 1
+                  version_type: version_type
+                  version_description: version_description
+                  name: name
+                  created_on: 1
+                  modified_on: 1
+                  fallback_content: fallback_content
+                  description: description
+                  parameters: parameters
               builtin_tools:
-                tool_type: tool_type
-                name: name
-                fallback_content: fallback_content
+                - tool_type: tool_type
+                  name: name
+                  fallback_content: fallback_content
+              event_messages:
+                on_new_chat:
+                  enabled: true
+                  text: text
     list-config-versions:
       path: /v0/evi/configs/{id}
       method: GET
@@ -156,6 +158,7 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
               configs_page:
                 - id: id
                   version: 1
@@ -173,19 +176,8 @@ service:
                     text: text
                   voice:
                     provider: provider
-                    name: name
-                  tools:
-                    tool_type: tool_type
-                    id: id
-                    version: 1
-                    version_type: version_type
-                    name: name
-                    created_on: 1
-                    modified_on: 1
-                    parameters: parameters
-                  builtin_tools:
-                    tool_type: tool_type
-                    name: name
+                  ellm_model:
+                    allow_short_responses: true
     create-config-version:
       path: /v0/evi/configs/{id}
       method: POST
@@ -205,10 +197,16 @@ service:
             prompt: optional<root.PostedPromptSpec>
             voice: optional<root.PostedVoice>
             language_model: optional<root.PostedLanguageModel>
-            tools: optional<root.PostedUserDefinedToolSpec>
-            builtin_tools: optional<root.PostedBuiltinTool>
+            ellm_model: optional<root.PostedEllmModel>
+            tools:
+              type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
+              docs: Tool specification for a Config.
+            builtin_tools:
+              type: optional<list<optional<root.PostedBuiltinTool>>>
+              docs: Built-in tool specification for a Config.
+            event_messages: optional<root.PostedEventMessageSpecs>
       response:
-        docs: Success
+        docs: Created
         type: root.ReturnConfig
       examples:
         - path-parameters:
@@ -238,22 +236,28 @@ service:
                 model_provider: model_provider
                 model_resource: model_resource
                 temperature: 1.1
+              ellm_model:
+                allow_short_responses: true
               tools:
-                tool_type: tool_type
-                id: id
-                version: 1
-                version_type: version_type
-                version_description: version_description
-                name: name
-                created_on: 1
-                modified_on: 1
-                fallback_content: fallback_content
-                description: description
-                parameters: parameters
+                - tool_type: tool_type
+                  id: id
+                  version: 1
+                  version_type: version_type
+                  version_description: version_description
+                  name: name
+                  created_on: 1
+                  modified_on: 1
+                  fallback_content: fallback_content
+                  description: description
+                  parameters: parameters
               builtin_tools:
-                tool_type: tool_type
-                name: name
-                fallback_content: fallback_content
+                - tool_type: tool_type
+                  name: name
+                  fallback_content: fallback_content
+              event_messages:
+                on_new_chat:
+                  enabled: true
+                  text: text
     delete-config:
       path: /v0/evi/configs/{id}
       method: DELETE
@@ -328,22 +332,28 @@ service:
                 model_provider: model_provider
                 model_resource: model_resource
                 temperature: 1.1
+              ellm_model:
+                allow_short_responses: true
               tools:
-                tool_type: tool_type
-                id: id
-                version: 1
-                version_type: version_type
-                version_description: version_description
-                name: name
-                created_on: 1
-                modified_on: 1
-                fallback_content: fallback_content
-                description: description
-                parameters: parameters
+                - tool_type: tool_type
+                  id: id
+                  version: 1
+                  version_type: version_type
+                  version_description: version_description
+                  name: name
+                  created_on: 1
+                  modified_on: 1
+                  fallback_content: fallback_content
+                  description: description
+                  parameters: parameters
               builtin_tools:
-                tool_type: tool_type
-                name: name
-                fallback_content: fallback_content
+                - tool_type: tool_type
+                  name: name
+                  fallback_content: fallback_content
+              event_messages:
+                on_new_chat:
+                  enabled: true
+                  text: text
     delete-config-version:
       path: /v0/evi/configs/{id}/version/{version}
       method: DELETE
@@ -411,19 +421,25 @@ service:
                 model_provider: model_provider
                 model_resource: model_resource
                 temperature: 1.1
+              ellm_model:
+                allow_short_responses: true
               tools:
-                tool_type: tool_type
-                id: id
-                version: 1
-                version_type: version_type
-                version_description: version_description
-                name: name
-                created_on: 1
-                modified_on: 1
-                fallback_content: fallback_content
-                description: description
-                parameters: parameters
+                - tool_type: tool_type
+                  id: id
+                  version: 1
+                  version_type: version_type
+                  version_description: version_description
+                  name: name
+                  created_on: 1
+                  modified_on: 1
+                  fallback_content: fallback_content
+                  description: description
+                  parameters: parameters
               builtin_tools:
-                tool_type: tool_type
-                name: name
-                fallback_content: fallback_content
+                - tool_type: tool_type
+                  name: name
+                  fallback_content: fallback_content
+              event_messages:
+                on_new_chat:
+                  enabled: true
+                  text: text

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

@@ -29,6 +29,7 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
               prompts_page:
                 - id: id
                   version: 1
@@ -57,7 +58,7 @@ service:
               type: string
               docs: Text used for this version of the Prompt.
       response:
-        docs: Success
+        docs: Created
         type: optional<root.ReturnPrompt>
       examples:
         - request:
@@ -104,6 +105,7 @@ service:
             body:
               page_number: 1
               page_size: 1
+              total_pages: 1
               prompts_page:
                 - id: id
                   version: 1
@@ -133,7 +135,7 @@ service:
               type: string
               docs: Text used for this version of the Prompt.
       response:
-        docs: Success
+        docs: Created
         type: optional<root.ReturnPrompt>
       examples:
         - path-parameters:

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

@@ -32,6 +32,7 @@ service:
             body:
               page_number: 0
               page_size: 2
+              total_pages: 1
               tools_page:
                 - tool_type: FUNCTION
                   id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2
@@ -95,7 +96,7 @@ service:
               type: optional<string>
               docs: Text to use if the tool fails to generate content.
       response:
-        docs: Success
+        docs: Created
         type: optional<root.ReturnUserDefinedTool>
       examples:
         - request:
@@ -164,6 +165,7 @@ service:
             body:
               page_number: 0
               page_size: 10
+              total_pages: 1
               tools_page:
                 - tool_type: FUNCTION
                   id: 00183a3f-79ba-413d-9f3b-609864268bea
@@ -212,7 +214,7 @@ service:
               type: optional<string>
               docs: Text to use if the tool fails to generate content.
       response:
-        docs: Success
+        docs: Created
         type: optional<root.ReturnUserDefinedTool>
       examples:
         - path-parameters:

package/.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "hume",
-  "version" : "0.7.0"
+  "version" : "0.31.9"
 }

package/Client.d.ts

@@ -3,7 +3,6 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { CustomModels } from "./api/resources/customModels/client/Client";
 import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client";
 import { ExpressionMeasurement } from "./api/resources/expressionMeasurement/client/Client";
 export declare namespace HumeClient {
@@ -21,8 +20,6 @@ export declare namespace HumeClient {
 export declare class HumeClient {
     protected readonly _options: HumeClient.Options;
     constructor(_options?: HumeClient.Options);
-    protected _customModels: CustomModels | undefined;
-    get customModels(): CustomModels;
     protected _empathicVoice: EmpathicVoice | undefined;
     get empathicVoice(): EmpathicVoice;
     protected _expressionMeasurement: ExpressionMeasurement | undefined;

package/Client.js

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

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

@@ -8,6 +8,7 @@ import { Prompts } from "../resources/prompts/client/Client";
 import { Configs } from "../resources/configs/client/Client";
 import { Chats } from "../resources/chats/client/Client";
 import { ChatGroups } from "../resources/chatGroups/client/Client";
+import { Chat } from "../resources/chat/client/Client";
 export declare namespace EmpathicVoice {
     interface Options {
         environment?: core.Supplier<environments.HumeEnvironment | string>;
@@ -33,4 +34,6 @@ export declare class EmpathicVoice {
     get chats(): Chats;
     protected _chatGroups: ChatGroups | undefined;
     get chatGroups(): ChatGroups;
+    protected _chat: Chat | undefined;
+    get chat(): Chat;
 }

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

@@ -9,6 +9,7 @@ const Client_2 = require("../resources/prompts/client/Client");
 const Client_3 = require("../resources/configs/client/Client");
 const Client_4 = require("../resources/chats/client/Client");
 const Client_5 = require("../resources/chatGroups/client/Client");
+const Client_6 = require("../resources/chat/client/Client");
 class EmpathicVoice {
     constructor(_options = {}) {
         this._options = _options;
@@ -33,5 +34,9 @@ class EmpathicVoice {
         var _a;
         return ((_a = this._chatGroups) !== null && _a !== void 0 ? _a : (this._chatGroups = new Client_5.ChatGroups(this._options)));
     }
+    get chat() {
+        var _a;
+        return ((_a = this._chat) !== null && _a !== void 0 ? _a : (this._chat = new Client_6.Chat(this._options)));
+    }
 }
 exports.EmpathicVoice = EmpathicVoice;

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

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

package/api/resources/empathicVoice/index.js

@@ -16,4 +16,3 @@ 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/resources/chat/client/Client.d.ts

@@ -0,0 +1,21 @@
+import * as core from "../../../../../../core";
+import { ChatSocket } from "./Socket";
+export declare namespace Chat {
+    interface Options {
+        apiKey?: core.Supplier<string | undefined>;
+        accessToken?: core.Supplier<string | undefined>;
+    }
+    interface ConnectArgs {
+        /** The ID of the configuration. */
+        configId?: string;
+        /** The version of the configuration. */
+        configVersion?: string;
+        /** The ID of a chat group, used to resume a previous chat. */
+        resumedChatGroupId?: string;
+    }
+}
+export declare class Chat {
+    protected readonly _options: Chat.Options;
+    constructor(_options: Chat.Options);
+    connect(args?: Chat.ConnectArgs): ChatSocket;
+}

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

@@ -0,0 +1,60 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chat = void 0;
+const core = __importStar(require("../../../../../../core"));
+const qs_1 = __importDefault(require("qs"));
+const Socket_1 = require("./Socket");
+class Chat {
+    constructor(_options) {
+        this._options = _options;
+    }
+    connect(args = {}) {
+        const queryParams = {};
+        if (this._options.accessToken != null) {
+            queryParams["accessToken"] = core.Supplier.get(this._options.accessToken);
+        }
+        else if (this._options.apiKey != null) {
+            queryParams["apiKey"] = core.Supplier.get(this._options.apiKey);
+        }
+        if (args.configId != null) {
+            queryParams["config_id"] = args.configId;
+        }
+        if (args.configVersion != null) {
+            queryParams["config_version"] = args.configVersion;
+        }
+        if (args.resumedChatGroupId != null) {
+            queryParams["resumed_chat_group_id"] = args.resumedChatGroupId;
+        }
+        const socket = new core.ReconnectingWebSocket(`wss://api.hume.ai/v0/evi/chat?${qs_1.default.stringify(queryParams)}`);
+        return new Socket_1.ChatSocket({
+            socket,
+        });
+    }
+}
+exports.Chat = Chat;