hume 0.15.2 → 0.15.3-beta.2

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A paginated list of chats returned from the server
+ */
+export interface ReturnPagedChats {
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
+    pageNumber: number;
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
+    pageSize: number;
+    /** The total number of pages in the collection. */
+    totalPages: number;
+    /**
+     * Indicates the order in which the paginated results are presented, based on their creation date.
+     *
+     * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
+     */
+    paginationDirection: Hume.empathicVoice.ReturnPagedChatsPaginationDirection;
+    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
+    chatsPage: Hume.empathicVoice.ReturnChat[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Indicates the order in which the paginated results are presented, based on their creation date.
+ *
+ * It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
+ */
+export type ReturnPagedChatsPaginationDirection = "ASC" | "DESC";
+export declare const ReturnPagedChatsPaginationDirection: {
+    readonly Asc: "ASC";
+    readonly Desc: "DESC";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnPagedChatsPaginationDirection = void 0;
+exports.ReturnPagedChatsPaginationDirection = {
+    Asc: "ASC",
+    Desc: "DESC",
+};

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A paginated list of config versions returned from the server
+ */
+export interface ReturnPagedConfigs {
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
+    pageNumber?: number;
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
+    pageSize?: number;
+    /** The total number of pages in the collection. */
+    totalPages: number;
+    /** List of configs returned for the specified `page_number` and `page_size`. */
+    configsPage?: Hume.empathicVoice.ReturnConfig[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A paginated list of prompt versions returned from the server
+ */
+export interface ReturnPagedPrompts {
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
+    pageNumber: number;
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
+    pageSize: number;
+    /** The total number of pages in the collection. */
+    totalPages: number;
+    /** List of prompts returned for the specified `page_number` and `page_size`. */
+    promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A paginated list of user defined tool versions returned from the server
+ */
+export interface ReturnPagedUserDefinedTools {
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
+    pageNumber: number;
+    /**
+     * The maximum number of items returned per page.
+     *
+     * This value corresponds to the `page_size` parameter specified in the request.
+     */
+    pageSize: number;
+    /** The total number of pages in the collection. */
+    totalPages: number;
+    /** List of tools returned for the specified `page_number` and `page_size`. */
+    toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A Prompt associated with this Config.
+ */
+export interface ReturnPrompt {
+    /** Name applied to all versions of a particular Prompt. */
+    name: string;
+    /** Identifier for a Prompt. Formatted as a UUID. */
+    id: string;
+    /**
+     * Instructions used to shape EVI's behavior, responses, and style.
+     *
+     * 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/speech-to-speech-evi/guides/prompting).
+     */
+    text: string;
+    /**
+     * Version number for a Prompt.
+     *
+     * Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
+     *
+     * Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
+     */
+    version: number;
+    /** Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
+    versionType: Hume.empathicVoice.ReturnPromptVersionType;
+    /** Time at which the Prompt was created. Measured in seconds since the Unix epoch. */
+    createdOn: number;
+    /** Time at which the Prompt was last modified. Measured in seconds since the Unix epoch. */
+    modifiedOn: number;
+    /** An optional description of the Prompt version. */
+    versionDescription?: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Versioning method for a Prompt. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version.
+ */
+export type ReturnPromptVersionType = "FIXED" | "LATEST";
+export declare const ReturnPromptVersionType: {
+    readonly Fixed: "FIXED";
+    readonly Latest: "LATEST";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnPromptVersionType = void 0;
+exports.ReturnPromptVersionType = {
+    Fixed: "FIXED",
+    Latest: "LATEST",
+};

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A specific timeout configuration to be returned from the server
+ */
+export interface ReturnTimeoutSpec {
+    /**
+     * Boolean indicating if this timeout is enabled.
+     *
+     * If set to false, EVI will not timeout due to a specified duration being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
+     */
+    enabled: boolean;
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
+    durationSecs?: number;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of timeout specifications returned by the server.
+ *
+ * Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.
+ */
+export interface ReturnTimeoutSpecs {
+    /**
+     * Specifies the duration of user inactivity (in seconds) after which the EVI WebSocket connection will be automatically disconnected. Default is 600 seconds (10 minutes).
+     *
+     * Accepts a minimum value of 30 seconds and a maximum value of 1,800 seconds.
+     */
+    inactivity: Hume.empathicVoice.ReturnTimeoutSpec;
+    /**
+     * Specifies the maximum allowed duration (in seconds) for an EVI WebSocket connection before it is automatically disconnected. Default is 1,800 seconds (30 minutes).
+     *
+     * Accepts a minimum value of 30 seconds and a maximum value of 1,800 seconds.
+     */
+    maxDuration: Hume.empathicVoice.ReturnTimeoutSpec;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A specific tool version returned from the server
+ */
+export interface ReturnUserDefinedTool {
+    /** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
+    toolType: Hume.empathicVoice.ReturnUserDefinedToolToolType;
+    /** Identifier for a Tool. Formatted as a UUID. */
+    id: string;
+    /**
+     * Version number for a Tool.
+     *
+     * Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
+     *
+     * Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
+     */
+    version: number;
+    /** Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version. */
+    versionType: Hume.empathicVoice.ReturnUserDefinedToolVersionType;
+    /** An optional description of the Tool version. */
+    versionDescription?: string;
+    /** Name applied to all versions of a particular Tool. */
+    name: string;
+    /** Time at which the Tool was created. Measured in seconds since the Unix epoch. */
+    createdOn: number;
+    /** Time at which the Tool was last modified. Measured in seconds since the Unix epoch. */
+    modifiedOn: number;
+    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
+    fallbackContent?: string;
+    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
+    description?: string;
+    /**
+     * Stringified JSON defining the parameters used by this version of the Tool.
+     *
+     * These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the tool receives data in the expected format.
+     */
+    parameters: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools.
+ */
+export type ReturnUserDefinedToolToolType = "BUILTIN" | "FUNCTION";
+export declare const ReturnUserDefinedToolToolType: {
+    readonly Builtin: "BUILTIN";
+    readonly Function: "FUNCTION";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnUserDefinedToolToolType = void 0;
+exports.ReturnUserDefinedToolToolType = {
+    Builtin: "BUILTIN",
+    Function: "FUNCTION",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Versioning method for a Tool. Either `FIXED` for using a fixed version number or `LATEST` for auto-updating to the latest version.
+ */
+export type ReturnUserDefinedToolVersionType = "FIXED" | "LATEST";
+export declare const ReturnUserDefinedToolVersionType: {
+    readonly Fixed: "FIXED";
+    readonly Latest: "LATEST";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnUserDefinedToolVersionType = void 0;
+exports.ReturnUserDefinedToolVersionType = {
+    Fixed: "FIXED",
+    Latest: "LATEST",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * An Octave voice available for text-to-speech
+ */
+export interface ReturnVoice {
+    id?: string;
+    name?: string;
+    provider?: Hume.empathicVoice.VoiceProvider;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Events this URL is subscribed to
+ */
+export type ReturnWebhookEventType = "chat_started" | "chat_ended";
+export declare const ReturnWebhookEventType: {
+    readonly ChatStarted: "chat_started";
+    readonly ChatEnded: "chat_ended";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnWebhookEventType = void 0;
+exports.ReturnWebhookEventType = {
+    ChatStarted: "chat_started",
+    ChatEnded: "chat_ended",
+};

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of webhook URL endpoints to be returned from the server
+ */
+export interface ReturnWebhookSpec {
+    /** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
+    url: string;
+    /**
+     * The list of events the specified URL is subscribed to.
+     *
+     * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
+     */
+    events: Hume.empathicVoice.ReturnWebhookEventType[];
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type Role = "assistant" | "system" | "user" | "all" | "tool";
+export declare const Role: {
+    readonly Assistant: "assistant";
+    readonly System: "system";
+    readonly User: "user";
+    readonly All: "all";
+    readonly Tool: "tool";
+};

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

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Role = void 0;
+exports.Role = {
+    Assistant: "assistant",
+    System: "system",
+    User: "user",
+    All: "all",
+    Tool: "tool",
+};

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

@@ -0,0 +1,80 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Settings for this chat session.
+ */
+export interface SessionSettings {
+    /**
+     * 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 guide](/docs/speech-to-speech-evi/configuration/session-settings).
+     */
+    audio?: Hume.empathicVoice.AudioConfiguration;
+    /**
+     * List of built-in tools to enable for the session.
+     *
+     * Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use).
+     *
+     * Currently, the only built-in tool Hume provides is **Web Search**. When enabled, Web Search equips EVI with the ability to search the web for up-to-date information.
+     */
+    builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
+    /**
+     * Field for injecting 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 clear injected context.
+     */
+    context?: Hume.empathicVoice.Context;
+    /**
+     * 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/speech-to-speech-evi/guides/custom-language-model) with EVI to learn more.
+     */
+    customSessionId?: string;
+    /**
+     * 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;
+    metadata?: Record<string, unknown>;
+    /**
+     * 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/speech-to-speech-evi/guides/prompting).
+     */
+    systemPrompt?: string;
+    /**
+     * List of user-defined tools to enable for the session.
+     *
+     * Tools are resources used by EVI to perform various tasks, such as searching the web or calling external APIs. Built-in tools, like web search, are natively integrated, while user-defined tools are created and invoked by the user. To learn more, see our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use).
+     */
+    tools?: Hume.empathicVoice.Tool[];
+    /**
+     * The type of message sent through the socket; must be `session_settings` for our server to correctly identify and process it as a Session Settings message.
+     *
+     * Session settings are temporary and apply only to the current Chat session. These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience.
+     *
+     * For more information, please refer to the [Session Settings guide](/docs/speech-to-speech-evi/configuration/session-settings).
+     */
+    type: "session_settings";
+    /**
+     * This field allows you to assign values to dynamic variables referenced in your system prompt.
+     *
+     * Each key represents the variable name, and the corresponding value is the specific content you wish to assign to that variable within the session. While the values for variables can be strings, numbers, or booleans, the value will ultimately be converted to a string when injected into your system prompt.
+     *
+     * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/speech-to-speech-evi/features/dynamic-variables).
+     */
+    variables?: Record<string, Hume.empathicVoice.SessionSettingsVariablesValue>;
+    /** Allows you to change the voice during an active chat. Updating the voice does not affect chat context or conversation history. */
+    voiceId?: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SessionSettingsVariablesValue = string | number | boolean;

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface Tool {
+    /** An optional description of what the tool does, used by the supplemental LLM to choose when and how to call the function. */
+    description?: string;
+    /** 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 of the user-defined tool to be enabled. */
+    name: string;
+    /**
+     * Parameters of the tool. Is a stringified JSON schema.
+     *
+     * These parameters define the inputs needed for the tool's execution, including the expected data type and description for each input field. Structured as a JSON schema, this format ensures the tool receives data in the expected format.
+     */
+    parameters: string;
+    /** Type of tool. Set to `function` for user-defined tools. */
+    type: Hume.empathicVoice.ToolType;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });