hume 0.7.2 → 0.8.0

package/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface ExtendedVoiceArgs {
+    text: string;
+    voiceArgs: Hume.empathicVoice.VoiceArgs;
+}

package/api/resources/empathicVoice/types/Features.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Features {
+    /** Confidence (F->M) */
+    confidence?: number;
+    /** Enthusiasm (M->A) */
+    enthusiasm?: number;
+    /** Affirmative (F->A/M) */
+    affirmative?: number;
+    /** Articulate (A->M) */
+    articulate?: number;
+    /** Maturity (M->F) */
+    maturity?: number;
+    /** Defeated (N->M) */
+    defeated?: number;
+    /** Feminine (M->F) */
+    feminine?: number;
+    /** Nerdy (A->A) */
+    nerdy?: number;
+}

package/api/resources/empathicVoice/types/FunctionCallResponseInput.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FunctionCallResponseInput {
+    type?: "function_call_response";
+}

package/api/resources/empathicVoice/types/HttpValidationError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface HttpValidationError {
+    detail?: Hume.empathicVoice.ValidationError[];
+}

package/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts

@@ -5,8 +5,8 @@
  * Pause responses from EVI. Chat history is still saved and sent after resuming.
  */
 export interface PauseAssistantMessage {
-    /** 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 a Pause Assistant message, this must be `pause_assistant_message`. */
     type: "pause_assistant_message";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
 }

package/api/resources/empathicVoice/types/PostedCustomVoice.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A custom voice specifications posted to the server
+ */
+export interface PostedCustomVoice {
+    /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
+    name: string;
+    /** The voice the custom voice is based off of. */
+    baseVoice: string;
+    /** The speech rate multiplier for this custom voice. */
+    speechRateMultiplier?: number;
+    /** The name of the parameter model used to define which attributes are used by `parameters`. */
+    parameterModel: string;
+    /** Voice specification for a Config. */
+    parameters?: Record<string, number | undefined>;
+}

package/api/resources/empathicVoice/types/PostedCustomVoiceName.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A custom voice name change to be posted to the server
+ */
+export interface PostedCustomVoiceName {
+    /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
+    name: string;
+}

package/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of event_message specs to be posted to the server
+ */
+export interface PostedEventMessageSpecs {
+    /** Set `enabled` to have the LLM generate an initial message using the system prompt. Set `text` to a string to use verbatim as the initial message. */
+    onNewChat?: Hume.empathicVoice.PostedEventMessageSpec;
+}

package/api/resources/empathicVoice/types/PostedLanguageModelModelProvider.d.ts

@@ -4,11 +4,12 @@
 /**
  * The provider of this model. Based on the enum modelProvider.
  */
-export declare type PostedLanguageModelModelProvider = "OPEN_AI" | "CUSTOM_LANGUAGE_MODEL" | "ANTHROPIC" | "FIREWORKS" | "GROQ";
+export declare type PostedLanguageModelModelProvider = "OPEN_AI" | "CUSTOM_LANGUAGE_MODEL" | "ANTHROPIC" | "FIREWORKS" | "GROQ" | "GOOGLE";
 export declare const PostedLanguageModelModelProvider: {
     readonly OpenAi: "OPEN_AI";
     readonly CustomLanguageModel: "CUSTOM_LANGUAGE_MODEL";
     readonly Anthropic: "ANTHROPIC";
     readonly Fireworks: "FIREWORKS";
     readonly Groq: "GROQ";
+    readonly Google: "GOOGLE";
 };

package/api/resources/empathicVoice/types/PostedLanguageModelModelProvider.js

@@ -10,4 +10,5 @@ exports.PostedLanguageModelModelProvider = {
     Anthropic: "ANTHROPIC",
     Fireworks: "FIREWORKS",
     Groq: "GROQ",
+    Google: "GOOGLE",
 };

package/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of timeout specs to be posted to the server
+ */
+export interface PostedTimeoutSpecs {
+    inactivity?: Hume.empathicVoice.PostedTimeoutSpec;
+    maxDuration?: Hume.empathicVoice.PostedTimeoutSpec;
+}

package/api/resources/empathicVoice/types/PostedVoice.d.ts

@@ -7,7 +7,7 @@ import * as Hume from "../../../index";
  */
 export interface PostedVoice {
     /** The provider of the voice to use. Based on the enum VoiceProvider. */
-    provider?: "HUME_AI";
-    /** String with the name of the voice to use. */
-    name: Hume.empathicVoice.PostedVoiceName;
+    provider: "HUME_AI";
+    /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
+    name?: Hume.empathicVoice.PostedVoiceName;
 }

package/api/resources/empathicVoice/types/PostedVoiceName.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * String with the name of the voice to use.
+ * String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase.
  */
 export declare type PostedVoiceName = "ITO" | "DACHER" | "KORA";
 export declare const PostedVoiceName: {

package/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts

@@ -5,8 +5,8 @@
  * Resume responses from EVI. Chat history sent while paused will now be sent.
  */
 export interface ResumeAssistantMessage {
-    /** 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 a Resume Assistant message, this must be `resume_assistant_message`. */
     type: "resume_assistant_message";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
 }

package/api/resources/empathicVoice/types/ReturnConfig.d.ts

@@ -26,8 +26,5 @@ export interface ReturnConfig {
     tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
     /** List of built-in tools associated with this config */
     builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
-    /** Map of event messages associated with this config. */
-    eventMessages?: Record<string, Hume.empathicVoice.ReturnEventMessageSpec | undefined>;
-    /** Map of timeouts associated with this config. */
-    timeouts?: Record<string, Hume.empathicVoice.ReturnTimeoutSpec | undefined>;
+    eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
 }

package/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A custom voice specification returned from the server
+ */
+export interface ReturnCustomVoice {
+    /** Identifier for a Custom Voice. Formatted as a UUID. */
+    id: string;
+    /** Version number for a Custom Voice. Version numbers should be integers. The combination of custom_voice_id and version number is unique. */
+    version: number;
+    /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
+    name: string;
+    /** The timestamp when the first version of this prompt was created. */
+    createdOn: number;
+    /** The timestamp when this version of the prompt was created. */
+    modifiedOn: number;
+    /** The voice the custom voice is based off of. */
+    baseVoice: string;
+    /** The speech rate multiplier for this custom voice. */
+    speechRateMultiplier?: number;
+    /** The name of the parameter model used to define which attributes are used by `parameters`. */
+    parameterModel: string;
+    /** Voice specification for a Config. */
+    parameters: Record<string, number>;
+}

package/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of event_message specs to be returned from the server
+ */
+export interface ReturnEventMessageSpecs {
+    /** `enabled` causes the LLM to generate an initial message using the system prompt. `text` is the string to use verbatim as the initial message. */
+    onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
+}

package/api/resources/empathicVoice/types/ReturnPagedCustomVoices.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * A paginated list of custom voices returned from the server
+ */
+export interface ReturnPagedCustomVoices {
+    /** The page number of the returned results. */
+    pageNumber: number;
+    /** The number of results returned per page. */
+    pageSize: number;
+    /** The total number of pages in the collection */
+    totalPages: number;
+    /** List of custom voices returned for the specified page number and page size. */
+    customVoicesPage: Hume.empathicVoice.ReturnCustomVoice[];
+}

package/api/resources/empathicVoice/types/ReturnPrivacySettings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ReturnPrivacySettings {
+    id?: string;
+    doNotRetainData?: boolean;
+    doNotUseForTraining?: boolean;
+}

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

@@ -9,7 +9,7 @@ export interface ReturnPrompt {
     id: string;
     /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
-    /** Indicates whether this tool is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
+    /** Indicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
     versionType: string;
     /** Description that is appended to a specific version of a Prompt. */
     versionDescription?: string;

package/api/resources/empathicVoice/types/ReturnPurgeStats.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ReturnPurgeStats {
+    id?: string;
+    numChats?: number;
+    numChatEvents?: number;
+    numConfigs?: number;
+    numPrompts?: number;
+    numTools?: number;
+    numVoices?: number;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Collection of timeout specs to be returned from the server
+ */
+export interface ReturnTimeoutSpecs {
+    inactivity: Hume.empathicVoice.ReturnTimeoutSpec;
+    maxDuration: Hume.empathicVoice.ReturnTimeoutSpec;
+}

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

@@ -7,6 +7,6 @@
 export interface ReturnVoice {
     /** The provider of the voice to use. Based on the enum VoiceProvider. */
     provider: string;
-    /** String with the name of the voice to use. */
-    name: string;
+    /** String with the name of the voice to use. Maximum length of 75 characters. Will be converted to all-uppercase. */
+    name?: string;
 }

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

@@ -6,20 +6,21 @@ import * as Hume from "../../../index";
  * Settings for this chat session.
  */
 export interface SessionSettings {
-    /** Audio configuration. */
-    audio?: Hume.empathicVoice.AudioConfiguration;
-    /** List of builtin tools to enable. */
-    builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
-    /** User context to inject. Set to null to disable context injection. */
-    context?: Hume.empathicVoice.Context;
+    /** The type of message sent through the socket; for a Session Settings message, this must be `session_settings`. */
+    type: "session_settings";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Third party API key for the language model used for non-Hume models. */
-    languageModelApiKey?: string;
     /** Instructions for how the system should respond to the user. Set to null to use the default system prompt. */
     systemPrompt?: string;
+    /** User context to inject. Set to null to disable context injection. */
+    context?: Hume.empathicVoice.Context;
+    /** Audio configuration. */
+    audio?: Hume.empathicVoice.AudioConfiguration;
+    /** Third party API key for the language model used for non-Hume models. */
+    languageModelApiKey?: string;
     /** List of tools to enable. */
     tools?: Hume.empathicVoice.Tool[];
-    /** The type of message sent through the socket; for a Session Settings message, this must be `session_settings`. */
-    type: "session_settings";
+    /** List of builtin tools to enable. */
+    builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
+    metadata?: Record<string, unknown>;
 }

package/api/resources/empathicVoice/types/TextInput.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TextInput {
+    type?: "text_input";
+}

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

@@ -3,14 +3,14 @@
  */
 import * as Hume from "../../../index";
 export interface Tool {
-    /** Description of the function. */
-    description?: string;
-    /** Fallback content of the tool, passed to the LLM if the function call response fails. */
-    fallbackContent?: string;
+    /** Type of tool. */
+    type: Hume.empathicVoice.ToolType;
     /** Name of the tool. */
     name: string;
     /** Parameters of the tool. Is a stringified JSON schema. */
     parameters: string;
-    /** Type of tool. */
-    type: Hume.empathicVoice.ToolType;
+    /** Description of the function. */
+    description?: string;
+    /** Fallback content of the tool, passed to the LLM if the function call response fails. */
+    fallbackContent?: string;
 }

package/api/resources/empathicVoice/types/ToolCallMessage.d.ts

@@ -6,18 +6,18 @@ import * as Hume from "../../../index";
  * When provided, the output is a tool call.
  */
 export interface ToolCallMessage {
-    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
-    customSessionId?: string;
     /** Name of the tool called. */
     name: string;
     /** Parameters of the tool call. Is a stringified JSON schema. */
     parameters: string;
-    /** Whether a response is required from the developer. */
-    responseRequired: boolean;
     /** ID of the tool call. */
     toolCallId: string;
-    /** Type of tool called, either 'builtin' or 'function'. */
-    toolType?: Hume.empathicVoice.ToolType;
     /** The type of message sent through the socket; for a Tool Call message, this must be `tool_call`. */
     type: "tool_call";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
+    /** Type of tool called, either 'builtin' or 'function'. */
+    toolType?: Hume.empathicVoice.ToolType;
+    /** Whether a response is required from the developer. */
+    responseRequired: boolean;
 }

package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts

@@ -6,20 +6,20 @@ import * as Hume from "../../../index";
  * When provided, the output is a function call error.
  */
 export interface ToolErrorMessage {
-    /** Error code. */
-    code?: string;
-    /** The content passed to the LLM in place of the tool response. */
-    content?: string;
+    /** The type of message sent through the socket; for a Tool Error message, this must be `tool_error`. */
+    type: "tool_error";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
+    /** Type of tool called, either 'builtin' or 'function'. */
+    toolType?: Hume.empathicVoice.ToolType;
+    /** ID of the tool call. */
+    toolCallId: string;
+    /** The content passed to the LLM in place of the tool response. */
+    content?: string;
     /** Error message from the tool call, not exposed to the LLM or user. */
     error: string;
+    /** Error code. */
+    code?: string;
     /** Error level. */
     level?: Hume.empathicVoice.ErrorLevel;
-    /** ID of the tool call. */
-    toolCallId: string;
-    /** Type of tool called, either 'builtin' or 'function'. */
-    toolType?: Hume.empathicVoice.ToolType;
-    /** The type of message sent through the socket; for a Tool Error message, this must be `tool_error`. */
-    type: "tool_error";
 }

package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts

@@ -6,14 +6,14 @@ import * as Hume from "../../../index";
  * When provided, the output is a function call response.
  */
 export interface ToolResponseMessage {
-    /** Return value of the tool call. */
-    content: string;
+    /** The type of message sent through the socket; for a Tool Response message, this must be `tool_response`. */
+    type: "tool_response";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /** ID of the tool call. */
     toolCallId: string;
+    /** Return value of the tool call. */
+    content: string;
     toolName?: string;
     toolType?: Hume.empathicVoice.ToolType;
-    /** The type of message sent through the socket; for a Tool Response message, this must be `tool_response`. */
-    type: "tool_response";
 }

package/api/resources/empathicVoice/types/TtsInput.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TtsInput {
+    type?: "tts";
+}

package/api/resources/empathicVoice/types/UserInput.d.ts

@@ -5,10 +5,10 @@
  * User text to insert into the conversation.
  */
 export interface UserInput {
+    /** The type of message sent through the socket; for a User Input message, this must be `user_input`. */
+    type: "user_input";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /** User text to insert into the conversation. */
     text: string;
-    /** The type of message sent through the socket; for a User Input message, this must be `user_input`. */
-    type: "user_input";
 }

package/api/resources/empathicVoice/types/UserInterruption.d.ts

@@ -5,10 +5,10 @@
  * When provided, the output is an interruption.
  */
 export interface UserInterruption {
+    /** The type of message sent through the socket; for a User Interruption message, this must be `user_interruption`. */
+    type: "user_interruption";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /** Unix timestamp of the detected user interruption. */
     time: number;
-    /** The type of message sent through the socket; for a User Interruption message, this must be `user_interruption`. */
-    type: "user_interruption";
 }

package/api/resources/empathicVoice/types/UserMessage.d.ts

@@ -6,16 +6,16 @@ import * as Hume from "../../../index";
  * When provided, the output is a user message.
  */
 export interface UserMessage {
+    /** The type of message sent through the socket; for a User message, this must be `user_message`. */
+    type: "user_message";
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
-    /** Indicates if this message was constructed from a text input message. */
-    fromText: boolean;
     /** Transcript of the message. */
     message: Hume.empathicVoice.ChatMessage;
     /** Inference model results. */
     models: Hume.empathicVoice.Inference;
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
-    /** The type of message sent through the socket; for a User message, this must be `user_message`. */
-    type: "user_message";
+    /** Indicates if this message was constructed from a text input message. */
+    fromText: boolean;
 }

package/api/resources/empathicVoice/types/ValidationError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface ValidationError {
+    loc: Hume.empathicVoice.ValidationErrorLocItem[];
+    msg: string;
+    type: string;
+}

package/api/resources/empathicVoice/types/ValidationErrorLocItem.d.ts

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

package/api/resources/empathicVoice/types/VoiceArgs.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface VoiceArgs {
+    voice?: Hume.empathicVoice.VoiceNameEnum;
+    features?: Hume.empathicVoice.Features;
+    charactersPerSecondRatio?: number;
+    baseline?: boolean;
+    reconstruct?: boolean;
+}

package/api/resources/empathicVoice/types/VoiceNameEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type VoiceNameEnum = "ITO" | "KORA" | "DACHER";
+export declare const VoiceNameEnum: {
+    readonly Ito: "ITO";
+    readonly Kora: "KORA";
+    readonly Dacher: "DACHER";
+};

package/api/resources/empathicVoice/types/VoiceNameEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoiceNameEnum = void 0;
+exports.VoiceNameEnum = {
+    Ito: "ITO",
+    Kora: "KORA",
+    Dacher: "DACHER",
+};

package/api/resources/empathicVoice/types/WebSocketError.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * When provided, the output is an error message.
+ */
+export interface WebSocketError {
+    /** The type of message sent through the socket; for a Web Socket Error message, this must be `error`. */
+    type: "error";
+    /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
+    customSessionId?: string;
+    /** Error code. */
+    code: string;
+    /** Error slug. */
+    slug: string;
+    /** Error message. */
+    message: string;
+}