hume 0.14.2-beta1 → 0.15.0

package/dist/cjs/Client.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { Tts } from "./api/resources/tts/client/Client.js";
+import { EmpathicVoice } from "./api/resources/empathicVoice/client/Client.js";
+import { ExpressionMeasurement } from "./api/resources/expressionMeasurement/client/Client.js";
+export declare namespace HumeClient {
+    interface Options {
+        environment?: core.Supplier<environments.HumeEnvironment | environments.HumeEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class HumeClient {
+    protected readonly _options: HumeClient.Options;
+    protected _tts: Tts | undefined;
+    protected _empathicVoice: EmpathicVoice | undefined;
+    protected _expressionMeasurement: ExpressionMeasurement | undefined;
+    constructor(_options?: HumeClient.Options);
+    get tts(): Tts;
+    get empathicVoice(): EmpathicVoice;
+    get expressionMeasurement(): ExpressionMeasurement;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,69 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HumeClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/tts/client/Client.js");
+const Client_js_2 = require("./api/resources/empathicVoice/client/Client.js");
+const Client_js_3 = require("./api/resources/expressionMeasurement/client/Client.js");
+class HumeClient {
+    constructor(_options = {}) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "hume",
+                "X-Fern-SDK-Version": "0.15.0",
+                "User-Agent": "hume/0.15.0",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get tts() {
+        var _a;
+        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_js_1.Tts(this._options)));
+    }
+    get empathicVoice() {
+        var _a;
+        return ((_a = this._empathicVoice) !== null && _a !== void 0 ? _a : (this._empathicVoice = new Client_js_2.EmpathicVoice(this._options)));
+    }
+    get expressionMeasurement() {
+        var _a;
+        return ((_a = this._expressionMeasurement) !== null && _a !== void 0 ? _a : (this._expressionMeasurement = new Client_js_3.ExpressionMeasurement(this._options)));
+    }
+}
+exports.HumeClient = HumeClient;

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

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import { Tools } from "../resources/tools/client/Client.js";
+import { Prompts } from "../resources/prompts/client/Client.js";
+import { Configs } from "../resources/configs/client/Client.js";
+import { Chats } from "../resources/chats/client/Client.js";
+import { ChatGroups } from "../resources/chatGroups/client/Client.js";
+import { Chat } from "../resources/chat/client/Client.js";
+export declare namespace EmpathicVoice {
+    interface Options {
+        environment?: core.Supplier<environments.HumeEnvironment | environments.HumeEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+}
+export declare class EmpathicVoice {
+    protected readonly _options: EmpathicVoice.Options;
+    protected _tools: Tools | undefined;
+    protected _prompts: Prompts | undefined;
+    protected _configs: Configs | undefined;
+    protected _chats: Chats | undefined;
+    protected _chatGroups: ChatGroups | undefined;
+    protected _chat: Chat | undefined;
+    constructor(_options?: EmpathicVoice.Options);
+    get tools(): Tools;
+    get prompts(): Prompts;
+    get configs(): Configs;
+    get chats(): Chats;
+    get chatGroups(): ChatGroups;
+    get chat(): Chat;
+}

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

@@ -0,0 +1,111 @@
+"use strict";
+/** THIS FILE IS MANUALLY MAINTAINED: see .fernignore */
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chat = void 0;
+const environments = __importStar(require("../../../../../../environments.js"));
+const core = __importStar(require("../../../../../../core/index.js"));
+const headers_js_1 = require("../../../../../../core/headers.js");
+const serializers = __importStar(require("../../../../../../serialization/index.js"));
+const Socket_js_1 = require("./Socket.js");
+class Chat {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    connect(args = {}) {
+        var _a, _b;
+        const { accessToken, configId, configVersion, eventLimit, resumedChatGroupId, verboseTranscription, voiceId, apiKey, sessionSettings, queryParams, headers, debug, reconnectAttempts, } = args;
+        const _queryParams = {};
+        if (accessToken != null) {
+            _queryParams["access_token"] = accessToken;
+        }
+        if (configId != null) {
+            _queryParams["config_id"] = configId;
+        }
+        if (configVersion != null) {
+            _queryParams["config_version"] =
+                typeof configVersion === "number" ? configVersion.toString() : configVersion;
+        }
+        if (eventLimit != null) {
+            _queryParams["event_limit"] = eventLimit.toString();
+        }
+        if (resumedChatGroupId != null) {
+            _queryParams["resumed_chat_group_id"] = resumedChatGroupId;
+        }
+        if (verboseTranscription != null) {
+            _queryParams["verbose_transcription"] = verboseTranscription.toString();
+        }
+        if (voiceId != null) {
+            _queryParams["voice_id"] = voiceId;
+        }
+        if (apiKey != null) {
+            _queryParams["api_key"] = apiKey;
+        }
+        if (sessionSettings != null) {
+            _queryParams["session_settings"] = serializers.empathicVoice.ConnectSessionSettings.jsonOrThrow(sessionSettings, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                omitUndefined: true,
+                breadcrumbsPrefix: ["request", "sessionSettings"],
+            });
+        }
+        // Merge in any additional query parameters
+        if (queryParams != null) {
+            for (const [name, value] of Object.entries(queryParams)) {
+                _queryParams[name] = value;
+            }
+        }
+        let _headers = (0, headers_js_1.mergeHeaders)((0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, this._getCustomAuthorizationHeaders())), headers);
+        const socket = new core.ReconnectingWebSocket({
+            url: core.url.join((_a = core.Supplier.get(this._options["baseUrl"])) !== null && _a !== void 0 ? _a : ((_b = core.Supplier.get(this._options["environment"])) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).evi, "/chat"),
+            protocols: [],
+            queryParameters: _queryParams,
+            headers: _headers,
+            options: { debug: debug !== null && debug !== void 0 ? debug : false, maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30 },
+        });
+        return new Socket_js_1.ChatSocket({ socket });
+    }
+    _getCustomAuthorizationHeaders() {
+        var _a;
+        const apiKeyValue = core.Supplier.get(this._options.apiKey);
+        // This `authHeaderValue` is manually added as if you don't provide it it will
+        // be omitted from the headers which means it won't reach the logic in ws.ts that
+        // extracts values from the headers and adds them to query parameters.
+        const authHeaderValue = core.Supplier.get((_a = this._options.headers) === null || _a === void 0 ? void 0 : _a.Authorization);
+        return { "X-Hume-Api-Key": apiKeyValue, Authorization: authHeaderValue };
+    }
+}
+exports.Chat = Chat;

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

@@ -0,0 +1,106 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Hume from "../../../../../index.js";
+export declare namespace ChatGroups {
+    interface Options {
+        environment?: core.Supplier<environments.HumeEnvironment | environments.HumeEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class ChatGroups {
+    protected readonly _options: ChatGroups.Options;
+    constructor(_options?: ChatGroups.Options);
+    /**
+     * Fetches a paginated list of **Chat Groups**.
+     *
+     * @param {Hume.empathicVoice.ChatGroupsListChatGroupsRequest} request
+     * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
+     * @example
+     *     await client.empathicVoice.chatGroups.listChatGroups({
+     *         pageNumber: 0,
+     *         pageSize: 1,
+     *         ascendingOrder: true,
+     *         configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
+     *     })
+     */
+    listChatGroups(request?: Hume.empathicVoice.ChatGroupsListChatGroupsRequest, requestOptions?: ChatGroups.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChatGroup>>;
+    /**
+     * Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
+     *
+     * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
+     * @param {Hume.empathicVoice.ChatGroupsGetChatGroupRequest} request
+     * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
+     * @example
+     *     await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
+     *         pageNumber: 0,
+     *         pageSize: 1,
+     *         ascendingOrder: true
+     *     })
+     */
+    getChatGroup(id: string, request?: Hume.empathicVoice.ChatGroupsGetChatGroupRequest, requestOptions?: ChatGroups.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnChatGroupPagedChats>;
+    private __getChatGroup;
+    /**
+     * Fetches a paginated list of **Chat** events associated with a **Chat Group**.
+     *
+     * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
+     * @param {Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest} request
+     * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
+     * @example
+     *     await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
+     *         pageNumber: 0,
+     *         pageSize: 3,
+     *         ascendingOrder: true
+     *     })
+     */
+    listChatGroupEvents(id: string, request?: Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest, requestOptions?: ChatGroups.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChatEvent>>;
+    /**
+     * Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
+     *
+     * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
+     * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request
+     * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.BadRequestError}
+     *
+     * @example
+     *     await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
+     *         pageNumber: 0,
+     *         pageSize: 10,
+     *         ascendingOrder: true
+     *     })
+     */
+    getAudio(id: string, request?: Hume.empathicVoice.ChatGroupsGetAudioRequest, requestOptions?: ChatGroups.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructions>;
+    private __getAudio;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-Hume-Api-Key": string | undefined;
+    }>;
+}