hume 0.12.1 → 0.13.0

package/core/form-data-utils/FormDataWrapper.js

@@ -41,51 +41,110 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebFormData = exports.Node16FormData = exports.Node18FormData = void 0;
+exports.FormDataWrapper = void 0;
 exports.newFormData = newFormData;
+const json_js_1 = require("../../core/json.js");
 const index_js_1 = require("../runtime/index.js");
-const toReadableStream_js_1 = require("./toReadableStream.js");
 function isNamedValue(value) {
     return typeof value === "object" && value != null && "name" in value;
 }
 function isPathedValue(value) {
     return typeof value === "object" && value != null && "path" in value;
 }
+function isStreamLike(value) {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+function isReadableStream(value) {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+function isBuffer(value) {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+function isArrayBufferView(value) {
+    return ArrayBuffer.isView(value);
+}
 function getLastPathSegment(pathStr) {
     const lastForwardSlash = pathStr.lastIndexOf("/");
     const lastBackSlash = pathStr.lastIndexOf("\\");
     const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
     return lastSlashIndex >= 0 ? pathStr.substring(lastSlashIndex + 1) : pathStr;
 }
-function newFormData() {
+function streamToBuffer(stream) {
     return __awaiter(this, void 0, void 0, function* () {
-        let formdata;
-        if (index_js_1.RUNTIME.type === "node" && index_js_1.RUNTIME.parsedVersion != null && index_js_1.RUNTIME.parsedVersion >= 18) {
-            formdata = new Node18FormData();
-        }
-        else if (index_js_1.RUNTIME.type === "node") {
-            formdata = new Node16FormData();
+        var _a, stream_1, stream_1_1;
+        var _b, e_1, _c, _d;
+        if (index_js_1.RUNTIME.type === "node") {
+            const { Readable } = yield Promise.resolve().then(() => __importStar(require("stream")));
+            if (stream instanceof Readable) {
+                const chunks = [];
+                try {
+                    for (_a = true, stream_1 = __asyncValues(stream); stream_1_1 = yield stream_1.next(), _b = stream_1_1.done, !_b; _a = true) {
+                        _d = stream_1_1.value;
+                        _a = false;
+                        const chunk = _d;
+                        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_a && !_b && (_c = stream_1.return)) yield _c.call(stream_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return Buffer.concat(chunks);
+            }
         }
-        else {
-            formdata = new WebFormData();
+        if (isReadableStream(stream)) {
+            const reader = stream.getReader();
+            const chunks = [];
+            try {
+                while (true) {
+                    const { done, value } = yield reader.read();
+                    if (done)
+                        break;
+                    chunks.push(value);
+                }
+            }
+            finally {
+                reader.releaseLock();
+            }
+            const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+            const result = new Uint8Array(totalLength);
+            let offset = 0;
+            for (const chunk of chunks) {
+                result.set(chunk, offset);
+                offset += chunk.length;
+            }
+            return Buffer.from(result);
         }
-        yield formdata.setup();
-        return formdata;
+        throw new Error("Unsupported stream type: " + typeof stream + ". Expected Node.js Readable stream or Web ReadableStream.");
+    });
+}
+function newFormData() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new FormDataWrapper();
     });
 }
-/**
- * Form Data Implementation for Node.js 18+
- */
-class Node18FormData {
+class FormDataWrapper {
+    constructor() {
+        this.fd = new FormData();
+    }
     setup() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.fd = new (yield Promise.resolve().then(() => __importStar(require("formdata-node")))).FormData();
+            // noop
         });
     }
     append(key, value) {
-        var _a;
-        (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
+        this.fd.append(key, String(value));
     }
     getFileName(value, filename) {
         if (filename != null) {
@@ -99,130 +158,51 @@ class Node18FormData {
         }
         return undefined;
     }
-    appendFile(key, value, fileName) {
+    convertToBlob(value) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            fileName = this.getFileName(value, fileName);
+            if (isStreamLike(value) || isReadableStream(value)) {
+                const buffer = yield streamToBuffer(value);
+                return new Blob([buffer]);
+            }
             if (value instanceof Blob) {
-                (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value, fileName);
+                return value;
             }
-            else {
-                (_b = this.fd) === null || _b === void 0 ? void 0 : _b.append(key, {
-                    type: undefined,
-                    name: fileName,
-                    [Symbol.toStringTag]: "File",
-                    stream() {
-                        return value;
-                    },
-                });
+            if (isBuffer(value)) {
+                return new Blob([value]);
             }
-        });
-    }
-    getRequest() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const encoder = new (yield Promise.resolve().then(() => __importStar(require("form-data-encoder")))).FormDataEncoder(this.fd);
-            return {
-                body: yield (0, toReadableStream_js_1.toReadableStream)(encoder),
-                headers: encoder.headers,
-                duplex: "half",
-            };
-        });
-    }
-}
-exports.Node18FormData = Node18FormData;
-/**
- * Form Data Implementation for Node.js 16-18
- */
-class Node16FormData {
-    setup() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.fd = new (yield Promise.resolve().then(() => __importStar(require("form-data")))).default();
-        });
-    }
-    append(key, value) {
-        var _a;
-        (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
-    }
-    getFileName(value, filename) {
-        if (filename != null) {
-            return filename;
-        }
-        if (isNamedValue(value)) {
-            return value.name;
-        }
-        if (isPathedValue(value) && value.path) {
-            return getLastPathSegment(value.path.toString());
-        }
-        return undefined;
-    }
-    appendFile(key, value, fileName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            fileName = this.getFileName(value, fileName);
-            let bufferedValue;
-            if (value instanceof Blob) {
-                bufferedValue = Buffer.from(yield value.arrayBuffer());
+            if (value instanceof ArrayBuffer) {
+                return new Blob([value]);
             }
-            else {
-                bufferedValue = value;
+            if (isArrayBufferView(value)) {
+                return new Blob([value]);
             }
-            if (fileName == null) {
-                (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, bufferedValue);
+            if (typeof value === "string") {
+                return new Blob([value]);
             }
-            else {
-                (_b = this.fd) === null || _b === void 0 ? void 0 : _b.append(key, bufferedValue, { filename: fileName });
+            if (typeof value === "object" && value !== null) {
+                return new Blob([(0, json_js_1.toJson)(value)], { type: "application/json" });
             }
+            return new Blob([String(value)]);
         });
     }
-    getRequest() {
-        return {
-            body: this.fd,
-            headers: this.fd ? this.fd.getHeaders() : {},
-        };
-    }
-}
-exports.Node16FormData = Node16FormData;
-/**
- * Form Data Implementation for Web
- */
-class WebFormData {
-    setup() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.fd = new FormData();
-        });
-    }
-    append(key, value) {
-        var _a;
-        (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
-    }
-    getFileName(value, filename) {
-        if (filename != null) {
-            return filename;
-        }
-        if (isNamedValue(value)) {
-            return value.name;
-        }
-        if (isPathedValue(value) && value.path) {
-            return getLastPathSegment(value.path.toString());
-        }
-        return undefined;
-    }
     appendFile(key, value, fileName) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
             fileName = this.getFileName(value, fileName);
-            if (value instanceof Blob) {
-                (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value, fileName);
-                return;
+            const blob = yield this.convertToBlob(value);
+            if (fileName) {
+                this.fd.append(key, blob, fileName);
+            }
+            else {
+                this.fd.append(key, blob);
             }
-            (_b = this.fd) === null || _b === void 0 ? void 0 : _b.append(key, new Blob([value]), fileName);
         });
     }
     getRequest() {
         return {
             body: this.fd,
             headers: {},
+            duplex: "half",
         };
     }
 }
-exports.WebFormData = WebFormData;
+exports.FormDataWrapper = FormDataWrapper;

package/core/index.d.ts

@@ -5,5 +5,6 @@ export * from "./stream";
 export * from "./utils";
 export * from "./pagination";
 export * from "./form-data-utils";
+export * from "./file";
 export * as serialization from "./schemas";
 export * from "./websocket";

package/core/index.js

@@ -44,6 +44,7 @@ __exportStar(require("./stream"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./pagination"), exports);
 __exportStar(require("./form-data-utils"), exports);
+__exportStar(require("./file"), exports);
 exports.serialization = __importStar(require("./schemas"));
 // This one is manually added
 __exportStar(require("./websocket"), exports);

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts

@@ -37,7 +37,11 @@ import * as Hume from "../../../../../../index";
  *     }
  */
 export interface PostedConfig {
-    /** Specifies the EVI version to use. Use `"1"` for version 1, or `"2"` for the latest enhanced version. For a detailed comparison of the two versions, refer to our [guide](/docs/speech-to-speech-evi/configuration/evi-version). */
+    /**
+     * Specifies the EVI version to use. See our [EVI Version  Guide](/docs/speech-to-speech-evi/configuration/evi-version) for differences between versions.
+     *
+     * **We're officially sunsetting EVI versions 1 and 2 on August 30, 2025**. To keep things running smoothly, be sure to [migrate to EVI 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3) before then.
+     */
     eviVersion: string;
     /** Name applied to all versions of a particular Config. */
     name: string;

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

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

@@ -5,12 +5,12 @@
  * When provided, the output is an assistant end message.
  */
 export interface AssistantEnd {
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
     /**
      * The type of message sent through the socket; for an Assistant End message, this must be `assistant_end`.
      *
      * This message indicates the conclusion of the assistant’s response, signaling that the assistant has finished speaking for the current conversational turn.
      */
     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/empathicVoice/types/AssistantInput.d.ts

@@ -5,6 +5,8 @@
  * When provided, the input is spoken by EVI.
  */
 export interface AssistantInput {
+    /** The type of message sent through the socket; must be `assistant_input` for our server to correctly identify and process it as an Assistant Input message. */
+    type: "assistant_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /**
@@ -13,6 +15,4 @@ export interface AssistantInput {
      * EVI uses this text to generate spoken audio using our proprietary expressive text-to-speech model. Our model adds appropriate emotional inflections and tones to the text based on the user’s expressions and the context of the conversation. The synthesized audio is streamed back to the user as an [Assistant Message](/reference/empathic-voice-interface-evi/chat/chat#receive.AssistantMessage.type).
      */
     text: string;
-    /** The type of message sent through the socket; must be `assistant_input` for our server to correctly identify and process it as an Assistant Input message. */
-    type: "assistant_input";
 }

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

@@ -6,20 +6,20 @@ import * as Hume from "../../../index";
  * When provided, the output is an assistant message.
  */
 export interface AssistantMessage {
+    /**
+     * The type of message sent through the socket; for an Assistant Message, this must be `assistant_message`.
+     *
+     * This message contains both a transcript of the assistant’s response and the expression measurement predictions of the assistant’s audio output.
+     */
+    type: "assistant_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/empathic-voice-interface-evi/chat/chat#send.AssistantInput.text). */
-    fromText: boolean;
     /** ID of the assistant message. Allows the Assistant Message to be tracked and referenced. */
     id?: string;
     /** Transcript of the message. */
     message: Hume.empathicVoice.ChatMessage;
     /** Inference model results. */
     models: Hume.empathicVoice.Inference;
-    /**
-     * The type of message sent through the socket; for an Assistant Message, this must be `assistant_message`.
-     *
-     * This message contains both a transcript of the assistant’s response and the expression measurement predictions of the assistant’s audio output.
-     */
-    type: "assistant_message";
+    /** Indicates if this message was inserted into the conversation as text from an [Assistant Input message](/reference/empathic-voice-interface-evi/chat/chat#send.AssistantInput.text). */
+    fromText: boolean;
 }

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

@@ -6,16 +6,16 @@ import * as Hume from "../../../index";
  * When provided, the output is an Assistant Prosody message.
  */
 export interface AssistantProsody {
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
-    /** Unique identifier for the segment. */
-    id?: string;
-    /** Inference model results. */
-    models: Hume.empathicVoice.Inference;
     /**
      * The type of message sent through the socket; for an Assistant Prosody message, this must be `assistant_PROSODY`.
      *
      * This message the expression measurement predictions of the assistant's audio output.
      */
     type: "assistant_prosody";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
+    /** Inference model results. */
+    models: Hume.empathicVoice.Inference;
+    /** Unique identifier for the segment. */
+    id?: string;
 }

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

@@ -3,10 +3,10 @@
  */
 import * as Hume from "../../../index";
 export interface AudioConfiguration {
-    /** Number of audio channels. */
-    channels: number;
     /** Encoding format of the audio input, such as `linear16`. */
     encoding: Hume.empathicVoice.Encoding;
+    /** Number of audio channels. */
+    channels: number;
     /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */
     sampleRate: number;
 }

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

@@ -5,6 +5,12 @@
  * When provided, the input is audio.
  */
 export interface AudioInput {
+    /**
+     * The type of message sent through the socket; must be `audio_input` for our server to correctly identify and process it as an Audio Input message.
+     *
+     * This message is used for sending audio input data to EVI for processing and expression measurement. Audio data should be sent as a continuous stream, encoded in Base64.
+     */
+    type: "audio_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /**
@@ -17,10 +23,4 @@ export interface AudioInput {
      * Hume recommends streaming audio with a buffer window of 20 milliseconds (ms), or 100 milliseconds (ms) for web applications.
      */
     data: string;
-    /**
-     * The type of message sent through the socket; must be `audio_input` for our server to correctly identify and process it as an Audio Input message.
-     *
-     * This message is used for sending audio input data to EVI for processing and expression measurement. Audio data should be sent as a continuous stream, encoded in Base64.
-     */
-    type: "audio_input";
 }

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

@@ -5,14 +5,14 @@
  * The type of message sent through the socket; for an Audio Output message, this must be `audio_output`.
  */
 export interface AudioOutput {
+    /** The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */
+    type: "audio_output";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Base64 encoded audio output. This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction. */
-    data: string;
     /** ID of the audio output. Allows the Audio Output message to be tracked and referenced. */
     id: string;
     /** Index of the chunk of audio relative to the whole audio segment. */
     index: number;
-    /** The type of message sent through the socket; for an Audio Output message, this must be `audio_output`. */
-    type: "audio_output";
+    /** Base64 encoded audio output. This encoded audio is transmitted to the client, where it can be decoded and played back as part of the user interaction. */
+    data: string;
 }

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

@@ -3,7 +3,7 @@
  */
 import * as Hume from "../../../index";
 export interface BuiltinToolConfig {
+    name: Hume.empathicVoice.BuiltInTool;
     /** Optional text passed to the supplemental LLM if the tool call fails. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation. */
     fallbackContent?: string;
-    name: Hume.empathicVoice.BuiltInTool;
 }

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

@@ -3,10 +3,10 @@
  */
 import * as Hume from "../../../index";
 export interface ChatMessage {
-    /** Transcript of the message. */
-    content?: string;
     /** Role of who is providing the message. */
     role: Hume.empathicVoice.Role;
+    /** Transcript of the message. */
+    content?: string;
     /** Function call name and arguments. */
     toolCall?: Hume.empathicVoice.ToolCallMessage;
     /** Function call response from client. */

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

@@ -5,6 +5,14 @@
  * When provided, the output is a chat metadata message.
  */
 export interface ChatMetadata {
+    /**
+     * The type of message sent through the socket; for a Chat Metadata message, this must be `chat_metadata`.
+     *
+     * The Chat Metadata message is the first message you receive after establishing a connection with EVI and contains important identifiers for the current Chat session.
+     */
+    type: "chat_metadata";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
     /**
      * ID of the Chat Group.
      *
@@ -15,14 +23,6 @@ export interface ChatMetadata {
     chatGroupId: string;
     /** ID of the Chat session. Allows the Chat session to be tracked and referenced. */
     chatId: string;
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
     /** ID of the initiating request. */
     requestId?: string;
-    /**
-     * The type of message sent through the socket; for a Chat Metadata message, this must be `chat_metadata`.
-     *
-     * The Chat Metadata message is the first message you receive after establishing a connection with EVI and contains important identifiers for the current Chat session.
-     */
-    type: "chat_metadata";
 }

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

@@ -3,24 +3,18 @@
  */
 import * as Hume from "../../../index";
 export interface Context {
-    /**
-     * 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}`.
-     */
-    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:
-     *
-     * - **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.
+     * - **Temporary**: Context that is only applied to the following assistant response.
      *
-     *  - **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;
+    /**
+     * 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}`.
+     */
+    text: string;
 }

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

@@ -1,9 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ContextType = "editable" | "persistent" | "temporary";
+export type ContextType = "temporary" | "persistent";
 export declare const ContextType: {
-    readonly Editable: "editable";
-    readonly Persistent: "persistent";
     readonly Temporary: "temporary";
+    readonly Persistent: "persistent";
 };

package/dist/api/resources/empathicVoice/types/ContextType.js

@@ -5,7 +5,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextType = void 0;
 exports.ContextType = {
-    Editable: "editable",
-    Persistent: "persistent",
     Temporary: "temporary",
+    Persistent: "persistent",
 };