hume 0.15.2 → 0.15.3-beta.1

package/dist/esm/api/resources/empathicVoice/resources/chat/index.d.mts

@@ -1,2 +1,7 @@
 export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+/**
+ * @deprecated Use `Hume.empathicVoice.SubscribeEvent` instead.
+ * This type alias will be removed in a future version.
+ */
+export type { SubscribeEvent } from "./types/SubscribeEvent.mjs";

package/dist/esm/api/resources/empathicVoice/resources/chat/types/SubscribeEvent.d.mts

@@ -1,5 +1,12 @@
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * This file was manually added to provide backward compatibility.
+ *
+ * @deprecated Use `Hume.empathicVoice.SubscribeEvent` instead.
+ * This type alias will be removed in a future version.
  */
-import * as Hume from "../../../../../index.mjs";
-export type SubscribeEvent = Hume.empathicVoice.AssistantEnd | Hume.empathicVoice.AssistantMessage | Hume.empathicVoice.AssistantProsody | Hume.empathicVoice.AudioOutput | Hume.empathicVoice.ChatMetadata | Hume.empathicVoice.WebSocketError | Hume.empathicVoice.UserInterruption | Hume.empathicVoice.UserMessage | Hume.empathicVoice.ToolCallMessage | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage;
+import type { SubscribeEvent as NewSubscribeEvent } from "../../../types/SubscribeEvent.mjs";
+/**
+ * @deprecated Use `Hume.empathicVoice.SubscribeEvent` instead.
+ * This type alias will be removed in a future version.
+ */
+export type SubscribeEvent = NewSubscribeEvent;

package/dist/esm/api/resources/empathicVoice/resources/chat/types/SubscribeEvent.mjs

@@ -1,4 +1,7 @@
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * This file was manually added to provide backward compatibility.
+ *
+ * @deprecated Use `Hume.empathicVoice.SubscribeEvent` instead.
+ * This type alias will be removed in a future version.
  */
 export {};

package/dist/esm/api/resources/empathicVoice/resources/chat/types/index.d.mts

@@ -1,2 +1 @@
 export * from "./PublishEvent.mjs";
-export * from "./SubscribeEvent.mjs";

package/dist/esm/api/resources/empathicVoice/resources/chat/types/index.mjs

@@ -1,2 +1 @@
 export * from "./PublishEvent.mjs";
-export * from "./SubscribeEvent.mjs";

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts

@@ -0,0 +1,73 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Hume from "../../../../../index.mjs";
+import { ControlPlaneSocket } from "./Socket.mjs";
+export declare namespace ControlPlane {
+    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>;
+    }
+    interface ConnectArgs {
+        accessToken?: string | undefined;
+        /** Arbitrary headers to send with the websocket connect request. */
+        headers?: Record<string, string>;
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
+    }
+}
+export declare class ControlPlane {
+    protected readonly _options: ControlPlane.Options;
+    constructor(_options?: ControlPlane.Options);
+    /**
+     * Send a message to a specific chat.
+     *
+     * @param {string} chatId
+     * @param {Hume.empathicVoice.ControlPlanePublishEvent} request
+     * @param {ControlPlane.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.empathicVoice.controlPlane.send("chat_id", {
+     *         audio: undefined,
+     *         builtinTools: undefined,
+     *         context: undefined,
+     *         customSessionId: undefined,
+     *         languageModelApiKey: undefined,
+     *         metadata: undefined,
+     *         systemPrompt: undefined,
+     *         tools: undefined,
+     *         type: "session_settings",
+     *         variables: undefined,
+     *         voiceId: undefined
+     *     })
+     */
+    send(chatId: string, request: Hume.empathicVoice.ControlPlanePublishEvent, requestOptions?: ControlPlane.RequestOptions): core.HttpResponsePromise<void>;
+    private __send;
+    connect(args?: ControlPlane.ConnectArgs): Promise<ControlPlaneSocket>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-Hume-Api-Key": string | undefined;
+    }>;
+}

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs

@@ -0,0 +1,133 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Hume from "../../../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as serializers from "../../../../../../serialization/index.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+import { ControlPlaneSocket } from "./Socket.mjs";
+export class ControlPlane {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Send a message to a specific chat.
+     *
+     * @param {string} chatId
+     * @param {Hume.empathicVoice.ControlPlanePublishEvent} request
+     * @param {ControlPlane.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Hume.empathicVoice.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.empathicVoice.controlPlane.send("chat_id", {
+     *         audio: undefined,
+     *         builtinTools: undefined,
+     *         context: undefined,
+     *         customSessionId: undefined,
+     *         languageModelApiKey: undefined,
+     *         metadata: undefined,
+     *         systemPrompt: undefined,
+     *         tools: undefined,
+     *         type: "session_settings",
+     *         variables: undefined,
+     *         voiceId: undefined
+     *     })
+     */
+    send(chatId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__send(chatId, request, requestOptions));
+    }
+    __send(chatId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.HumeEnvironment.Prod).base, `v0/evi/chat/${encodeURIComponent(chatId)}/send`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.empathicVoice.ControlPlanePublishEvent.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Hume.empathicVoice.UnprocessableEntityError(serializers.empathicVoice.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.HumeError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.HumeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.HumeTimeoutError("Timeout exceeded when calling POST /v0/evi/chat/{chat_id}/send.");
+                case "unknown":
+                    throw new errors.HumeError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    connect() {
+        return __awaiter(this, arguments, void 0, function* (args = {}) {
+            var _a, _b;
+            const { accessToken, headers, debug, reconnectAttempts } = args;
+            const _queryParams = {};
+            if (accessToken != null) {
+                _queryParams["access_token"] = accessToken;
+            }
+            let _headers = mergeHeaders(mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), headers);
+            const socket = new core.ReconnectingWebSocket({
+                url: core.url.join((_a = (yield core.Supplier.get(this._options["baseUrl"]))) !== null && _a !== void 0 ? _a : ((_b = (yield 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 ControlPlaneSocket({ socket });
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "X-Hume-Api-Key": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Socket.d.mts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../../core/index.mjs";
+import * as Hume from "../../../../../index.mjs";
+export declare namespace ControlPlaneSocket {
+    interface Args {
+        socket: core.ReconnectingWebSocket;
+    }
+    type Response = Hume.empathicVoice.SubscribeEvent;
+    type EventHandlers = {
+        open?: () => void;
+        message?: (message: Response) => void;
+        close?: (event: core.CloseEvent) => void;
+        error?: (error: Error) => void;
+    };
+}
+export declare class ControlPlaneSocket {
+    readonly socket: core.ReconnectingWebSocket;
+    protected readonly eventHandlers: ControlPlaneSocket.EventHandlers;
+    private handleOpen;
+    private handleMessage;
+    private handleClose;
+    private handleError;
+    constructor(args: ControlPlaneSocket.Args);
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState(): number;
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on<T extends keyof ControlPlaneSocket.EventHandlers>(event: T, callback: ControlPlaneSocket.EventHandlers[T]): void;
+    sendPublish(message: Hume.empathicVoice.ControlPlanePublishEvent): void;
+    /** Connect to the websocket and register event handlers. */
+    connect(): ControlPlaneSocket;
+    /** Close the websocket and unregister event handlers. */
+    close(): void;
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen(): Promise<core.ReconnectingWebSocket>;
+    /** Asserts that the websocket is open. */
+    private assertSocketIsOpen;
+    /** Send a binary payload to the websocket. */
+    protected sendBinary(payload: ArrayBufferLike | Blob | ArrayBufferView): void;
+}

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Socket.mjs

@@ -0,0 +1,131 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as core from "../../../../../../core/index.mjs";
+import { ControlPlanePublishEvent } from "../../../../../../serialization/resources/empathicVoice/types/ControlPlanePublishEvent.mjs";
+import { fromJson } from "../../../../../../core/json.mjs";
+import * as serializers from "../../../../../../serialization/index.mjs";
+export class ControlPlaneSocket {
+    constructor(args) {
+        this.eventHandlers = {};
+        this.handleOpen = () => {
+            var _a, _b;
+            (_b = (_a = this.eventHandlers).open) === null || _b === void 0 ? void 0 : _b.call(_a);
+        };
+        this.handleMessage = (event) => {
+            var _a, _b, _c, _d;
+            const data = fromJson(event.data);
+            const parsedResponse = serializers.empathicVoice.ControlPlaneSocketResponse.parse(data, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+                skipValidation: true,
+                omitUndefined: true,
+            });
+            if (parsedResponse.ok) {
+                (_b = (_a = this.eventHandlers).message) === null || _b === void 0 ? void 0 : _b.call(_a, parsedResponse.value);
+            }
+            else {
+                (_d = (_c = this.eventHandlers).error) === null || _d === void 0 ? void 0 : _d.call(_c, new Error("Received unknown message type"));
+            }
+        };
+        this.handleClose = (event) => {
+            var _a, _b;
+            (_b = (_a = this.eventHandlers).close) === null || _b === void 0 ? void 0 : _b.call(_a, event);
+        };
+        this.handleError = (event) => {
+            var _a, _b;
+            const message = event.message;
+            (_b = (_a = this.eventHandlers).error) === null || _b === void 0 ? void 0 : _b.call(_a, new Error(message));
+        };
+        this.socket = args.socket;
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+    }
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState() {
+        return this.socket.readyState;
+    }
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on(event, callback) {
+        this.eventHandlers[event] = callback;
+    }
+    sendPublish(message) {
+        this.assertSocketIsOpen();
+        const jsonPayload = ControlPlanePublishEvent.jsonOrThrow(message, {
+            unrecognizedObjectKeys: "passthrough",
+            allowUnrecognizedUnionMembers: true,
+            allowUnrecognizedEnumValues: true,
+            skipValidation: true,
+            omitUndefined: true,
+        });
+        this.socket.send(JSON.stringify(jsonPayload));
+    }
+    /** Connect to the websocket and register event handlers. */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+        return this;
+    }
+    /** Close the websocket and unregister event handlers. */
+    close() {
+        this.socket.close();
+        this.handleClose({ code: 1000 });
+        this.socket.removeEventListener("open", this.handleOpen);
+        this.socket.removeEventListener("message", this.handleMessage);
+        this.socket.removeEventListener("close", this.handleClose);
+        this.socket.removeEventListener("error", this.handleError);
+    }
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+                return this.socket;
+            }
+            return new Promise((resolve, reject) => {
+                this.socket.addEventListener("open", () => {
+                    resolve(this.socket);
+                });
+                this.socket.addEventListener("error", (event) => {
+                    reject(event);
+                });
+            });
+        });
+    }
+    /** Asserts that the websocket is open. */
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new Error("Socket is not connected.");
+        }
+        if (this.socket.readyState !== core.ReconnectingWebSocket.OPEN) {
+            throw new Error("Socket is not open.");
+        }
+    }
+    /** Send a binary payload to the websocket. */
+    sendBinary(payload) {
+        this.socket.send(payload);
+    }
+}

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/index.d.mts

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

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/index.mjs

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

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/empathicVoice/resources/controlPlane/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/empathicVoice/resources/index.d.mts

@@ -1,5 +1,6 @@
 export * as chat from "./chat/index.mjs";
 export * from "./chat/types/index.mjs";
+export * as controlPlane from "./controlPlane/index.mjs";
 export * as tools from "./tools/index.mjs";
 export * as prompts from "./prompts/index.mjs";
 export * as configs from "./configs/index.mjs";

package/dist/esm/api/resources/empathicVoice/resources/index.mjs

@@ -1,5 +1,6 @@
 export * as chat from "./chat/index.mjs";
 export * from "./chat/types/index.mjs";
+export * as controlPlane from "./controlPlane/index.mjs";
 export * as tools from "./tools/index.mjs";
 export * as prompts from "./prompts/index.mjs";
 export * as configs from "./configs/index.mjs";

package/dist/esm/api/resources/empathicVoice/types/AudioConfiguration.d.mts

@@ -5,6 +5,8 @@ import * as Hume from "../../../index.mjs";
 export interface AudioConfiguration {
     /** Number of audio channels. */
     channels: number;
+    /** Optional codec information. */
+    codec?: string;
     /** Encoding format of the audio input, such as `linear16`. */
     encoding: Hume.empathicVoice.Encoding;
     /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */

package/dist/esm/api/resources/empathicVoice/types/BuiltInTool.d.mts

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * Name of the built-in tool. Set to `web_search` to equip EVI with the built-in Web Search tool.
- */
 export type BuiltInTool = "web_search" | "hang_up";
 export declare const BuiltInTool: {
     readonly WebSearch: "web_search";

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettings.d.mts

@@ -3,11 +3,44 @@
  */
 import * as Hume from "../../../index.mjs";
 export interface ConnectSessionSettings {
+    /**
+     * Configuration details for the audio input used during the session. Ensures the audio is being correctly set up for processing.
+     *
+     * This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
+     */
     audio?: Hume.empathicVoice.ConnectSessionSettingsAudio;
+    /**
+     * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+     *
+     * When included in a Session Settings message, the provided context can be used to remind the LLM of its role in every user message, prevent it from forgetting important details, or add new relevant information to the conversation.
+     *
+     * Set to `null` to disable context injection.
+     */
     context?: Hume.empathicVoice.ConnectSessionSettingsContext;
+    /**
+     * Unique identifier for the session. Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions.
+     *
+     * If included, the response sent from Hume to your backend will include this ID. This allows you to correlate frontend users with their incoming messages.
+     *
+     * It is recommended to pass a `custom_session_id` if you are using a Custom Language Model. Please see our guide to [using a custom language model](/docs/empathic-voice-interface-evi/custom-language-model) with EVI to learn more.
+     */
     customSessionId?: string;
     eventLimit?: number;
+    /**
+     * 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.
+     */
     languageModelApiKey?: string;
+    /**
+     * 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/empathic-voice-interface-evi/prompting).
+     */
     systemPrompt?: string;
     /**
      * This field allows you to assign values to dynamic variables referenced in your system prompt.

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.mts

@@ -1,8 +1,17 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from "../../../index.mjs";
+/**
+ * Configuration details for the audio input used during the session. Ensures the audio is being correctly set up for processing.
+ *
+ * This optional field is only required when the audio input is encoded in PCM Linear 16 (16-bit, little-endian, signed PCM WAV data). For detailed instructions on how to configure session settings for PCM Linear 16 audio, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
+ */
 export interface ConnectSessionSettingsAudio {
+    /** Number of audio channels. */
     channels?: number;
-    encoding?: string;
+    /** Encoding format of the audio input, such as `linear16`. */
+    encoding?: Hume.empathicVoice.Encoding;
+    /** Audio sample rate. Number of samples per second in the audio input, measured in Hertz. */
     sampleRate?: number;
 }

package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.mts

@@ -1,7 +1,33 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Hume from "../../../index.mjs";
+/**
+ * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+ *
+ * When included in a Session Settings message, the provided context can be used to remind the LLM of its role in every user message, prevent it from forgetting important details, or add new relevant information to the conversation.
+ *
+ * Set to `null` to disable context injection.
+ */
 export interface ConnectSessionSettingsContext {
+    /**
+     * 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;
-    type?: 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.
+     *
+     *  - **Editable**: The original context is updated to reflect the new context.
+     *
+     *  If the type is not specified, it will default to `temporary`.
+     */
+    type?: Hume.empathicVoice.ContextType;
 }

package/dist/esm/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.mts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index.mjs";
+export type ControlPlanePublishEvent = Hume.empathicVoice.SessionSettings | Hume.empathicVoice.UserInput | Hume.empathicVoice.AssistantInput | Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage | Hume.empathicVoice.PauseAssistantMessage | Hume.empathicVoice.ResumeAssistantMessage;

package/dist/esm/api/resources/empathicVoice/types/ControlPlanePublishEvent.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/empathicVoice/types/LanguageModelType.d.mts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type LanguageModelType = "claude-3-7-sonnet-latest" | "claude-3-5-sonnet-latest" | "claude-3-5-haiku-latest" | "claude-3-5-sonnet-20240620" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307" | "claude-sonnet-4-20250514" | "claude-sonnet-4-5-20250929" | "us.anthropic.claude-3-5-haiku-20241022-v1:0" | "us.anthropic.claude-3-5-sonnet-20240620-v1:0" | "us.anthropic.claude-3-haiku-20240307-v1:0" | "gpt-oss-120b" | "qwen-3-235b-a22b" | "qwen-3-235b-a22b-instruct-2507" | "qwen-3-235b-a22b-thinking-2507" | "gemini-1.5-pro" | "gemini-1.5-flash" | "gemini-1.5-pro-002" | "gemini-1.5-flash-002" | "gemini-2.0-flash" | "gemini-2.5-flash" | "gemini-2.5-flash-preview-04-17" | "gpt-4-turbo" | "gpt-4-turbo-preview" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo" | "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4o-priority" | "gpt-4o-mini-priority" | "gpt-4.1-priority" | "gpt-5-priority" | "gpt-5-mini-priority" | "gpt-5-nano-priority" | "gemma-7b-it" | "llama3-8b-8192" | "llama3-70b-8192" | "llama-3.1-70b-versatile" | "llama-3.3-70b-versatile" | "llama-3.1-8b-instant" | "moonshotai/kimi-k2-instruct" | "accounts/fireworks/models/mixtral-8x7b-instruct" | "accounts/fireworks/models/llama-v3p1-405b-instruct" | "accounts/fireworks/models/llama-v3p1-70b-instruct" | "accounts/fireworks/models/llama-v3p1-8b-instruct" | "sonar" | "sonar-pro" | "sambanova" | "DeepSeek-R1-Distill-Llama-70B" | "Llama-4-Maverick-17B-128E-Instruct" | "Qwen3-32B" | "grok-4-fast-non-reasoning-latest" | "ellm" | "custom-language-model" | "hume-evi-3-web-search";
+export type LanguageModelType = "claude-3-7-sonnet-latest" | "claude-3-5-sonnet-latest" | "claude-3-5-haiku-latest" | "claude-3-5-sonnet-20240620" | "claude-3-opus-20240229" | "claude-3-sonnet-20240229" | "claude-3-haiku-20240307" | "claude-sonnet-4-20250514" | "claude-sonnet-4-5-20250929" | "claude-haiku-4-5-20251001" | "us.anthropic.claude-3-5-haiku-20241022-v1:0" | "us.anthropic.claude-3-5-sonnet-20240620-v1:0" | "us.anthropic.claude-3-haiku-20240307-v1:0" | "gpt-oss-120b" | "qwen-3-235b-a22b" | "qwen-3-235b-a22b-instruct-2507" | "qwen-3-235b-a22b-thinking-2507" | "gemini-1.5-pro" | "gemini-1.5-flash" | "gemini-1.5-pro-002" | "gemini-1.5-flash-002" | "gemini-2.0-flash" | "gemini-2.5-flash" | "gemini-2.5-flash-preview-04-17" | "gpt-4-turbo" | "gpt-4-turbo-preview" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo" | "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4o-priority" | "gpt-4o-mini-priority" | "gpt-4.1-priority" | "gpt-5-priority" | "gpt-5-mini-priority" | "gpt-5-nano-priority" | "gemma-7b-it" | "llama3-8b-8192" | "llama3-70b-8192" | "llama-3.1-70b-versatile" | "llama-3.3-70b-versatile" | "llama-3.1-8b-instant" | "moonshotai/kimi-k2-instruct" | "accounts/fireworks/models/mixtral-8x7b-instruct" | "accounts/fireworks/models/llama-v3p1-405b-instruct" | "accounts/fireworks/models/llama-v3p1-70b-instruct" | "accounts/fireworks/models/llama-v3p1-8b-instruct" | "sonar" | "sonar-pro" | "sambanova" | "DeepSeek-R1-Distill-Llama-70B" | "Llama-4-Maverick-17B-128E-Instruct" | "Qwen3-32B" | "grok-4-fast-non-reasoning-latest" | "ellm" | "custom-language-model" | "hume-evi-3-web-search";
 export declare const LanguageModelType: {
     readonly Claude37SonnetLatest: "claude-3-7-sonnet-latest";
     readonly Claude35SonnetLatest: "claude-3-5-sonnet-latest";
@@ -12,6 +12,7 @@ export declare const LanguageModelType: {
     readonly Claude3Haiku20240307: "claude-3-haiku-20240307";
     readonly ClaudeSonnet420250514: "claude-sonnet-4-20250514";
     readonly ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929";
+    readonly ClaudeHaiku4520251001: "claude-haiku-4-5-20251001";
     readonly UsAnthropicClaude35Haiku20241022V10: "us.anthropic.claude-3-5-haiku-20241022-v1:0";
     readonly UsAnthropicClaude35Sonnet20240620V10: "us.anthropic.claude-3-5-sonnet-20240620-v1:0";
     readonly UsAnthropicClaude3Haiku20240307V10: "us.anthropic.claude-3-haiku-20240307-v1:0";

package/dist/esm/api/resources/empathicVoice/types/LanguageModelType.mjs

@@ -11,6 +11,7 @@ export const LanguageModelType = {
     Claude3Haiku20240307: "claude-3-haiku-20240307",
     ClaudeSonnet420250514: "claude-sonnet-4-20250514",
     ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929",
+    ClaudeHaiku4520251001: "claude-haiku-4-5-20251001",
     UsAnthropicClaude35Haiku20241022V10: "us.anthropic.claude-3-5-haiku-20241022-v1:0",
     UsAnthropicClaude35Sonnet20240620V10: "us.anthropic.claude-3-5-sonnet-20240620-v1:0",
     UsAnthropicClaude3Haiku20240307V10: "us.anthropic.claude-3-haiku-20240307-v1:0",

package/dist/esm/api/resources/empathicVoice/types/ReturnChatEvent.d.mts

@@ -45,4 +45,6 @@ export interface ReturnChatEvent {
     emotionFeatures?: string;
     /** Stringified JSON with additional metadata about the chat event. */
     metadata?: string;
+    /** Identifier for a related chat event. Currently only seen on ASSISTANT_PROSODY events, to point back to the ASSISTANT_MESSAGE that generated these prosody scores */
+    relatedEventId?: string;
 }