hume 0.5.5 → 0.5.6

package/api/resources/empathicVoice/{types → resources/prompts/client/requests}/PostedPrompt.d.ts

@@ -2,13 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * A prompt to be posted to the server
+ * @example
+ *     {
+ *         name: "name",
+ *         text: "text"
+ *     }
  */
 export interface PostedPrompt {
     /** Name applied to all versions of a particular Prompt. */
-    name?: string;
+    name: string;
     /** Description that is appended to a specific version of a Prompt. */
     versionDescription?: string;
     /** Text used for this version of the Prompt. */
-    text?: string;
+    text: string;
 }

package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptName.d.ts

@@ -3,9 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         name: "name"
+ *     }
  */
 export interface PostedPromptName {
     /** Name applied to all versions of a particular Prompt. */
-    name?: string;
+    name: string;
 }

package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         text: "text"
+ *     }
+ */
+export interface PostedPromptVersion {
+    /** Description that is appended to a specific version of a Prompt. */
+    versionDescription?: string;
+    /** Text used for this version of the Prompt. */
+    text: string;
+}

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

@@ -1,4 +1,6 @@
 export { GetReturnPromptsForUserRequest } from "./GetReturnPromptsForUserRequest";
+export { PostedPrompt } from "./PostedPrompt";
 export { GetReturnPromptByPromptIdRequest } from "./GetReturnPromptByPromptIdRequest";
+export { PostedPromptVersion } from "./PostedPromptVersion";
 export { PostedPromptName } from "./PostedPromptName";
 export { PostedPromptVersionDescription } from "./PostedPromptVersionDescription";

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

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * When provided, the output is an assistant end message.
+ */
 export interface AssistantEnd {
+    customSessionId?: string;
     type: "assistant_end";
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * When provided, the input is spoken by EVI.
+ */
+export interface AssistantInput {
+    customSessionId?: string;
+    /** Text to be synthesized. */
+    text: string;
+    type: "assistant_input";
+}

package/api/resources/empathicVoice/types/AssistantInput.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/api/resources/empathicVoice/types/AssistantMessage.d.ts

@@ -2,9 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../../..";
+/**
+ * When provided, the output is an assistant message.
+ */
 export interface AssistantMessage {
-    /** Indicates if this message was constructed from a TtsInput message. */
-    fromTts: boolean;
+    customSessionId?: string;
+    /** Indicates if this message was constructed from a text input message. */
+    fromText: boolean;
     /** ID of the assistant message. */
     id?: string;
     /** Transcript of the message. */

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

@@ -1,7 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * When provided, the input is audio.
+ */
 export interface AudioInput {
+    customSessionId?: string;
     /** Base64 encoded audio input. */
     data: string;
     type: "audio_input";

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

@@ -1,8 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * When provided, the output is audio.
+ */
 export interface AudioOutput {
-    /** Base64 encoded Linear16 PCM output. */
+    customSessionId?: string;
+    /** Base64 encoded audio output. */
     data: string;
     /** ID of the audio output. */
     id: string;

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

@@ -1,9 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * When provided, the output is an error message.
+ */
 export interface Error_ {
     /** Error code. */
     code: string;
+    customSessionId?: string;
     /** Error message. */
     message: string;
     /** Error slug. */

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

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

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

@@ -7,6 +7,7 @@ exports.PostedLanguageModelModelProvider = void 0;
 exports.PostedLanguageModelModelProvider = {
     OpenAi: "OPEN_AI",
     ByoText: "BYO_TEXT",
+    CustomLanguageModel: "CUSTOM_LANGUAGE_MODEL",
     Anthropic: "ANTHROPIC",
     Fireworks: "FIREWORKS",
 };

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

@@ -6,7 +6,7 @@
  */
 export interface PostedPromptSpec {
     /** Identifier for a Prompt. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
-    version?: number;
+    version: number;
 }

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

@@ -6,11 +6,11 @@
  */
 export interface PostedTool {
     /** Name applied to all versions of a particular Tool. */
-    name?: string;
+    name: string;
     /** Description that is appended to a specific version of a Tool. */
     versionDescription?: string;
     /** Text describing what the tool does. */
-    docstring?: string;
-    /** Stringified JSON defining the schema for this version of the Tool. */
-    schema?: string;
+    description?: string;
+    /** Stringified JSON defining the parameters used by this version of the Tool. */
+    parameters: string;
 }

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

@@ -6,5 +6,5 @@
  */
 export interface PostedToolName {
     /** Name applied to all versions of a particular Tool. */
-    name?: string;
+    name: string;
 }

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

@@ -6,7 +6,7 @@
  */
 export interface PostedToolSpec {
     /** Identifier for a Tool. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
-    version?: number;
+    version: number;
 }

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A new version of an existing tool to be posted to the server
+ */
+export interface PostedToolVersion {
+    /** Description that is appended to a specific version of a Tool. */
+    versionDescription?: string;
+    /** Text describing what the tool does. */
+    description?: string;
+    /** Stringified JSON defining the parameters used by this version of the Tool. */
+    parameters: string;
+}

package/api/resources/empathicVoice/types/PostedToolVersion.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/api/resources/empathicVoice/types/PostedVoice.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A Voice specification posted to the server
+ */
+export interface PostedVoice {
+    /** 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;
+}

package/api/resources/empathicVoice/types/PostedVoice.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/api/resources/empathicVoice/types/ReturnActiveChatCount.d.ts

@@ -7,13 +7,13 @@ import * as Hume from "../../..";
  */
 export interface ReturnActiveChatCount {
     /** The timestamp for when chat status was measured. Formatted as a Unix epoch milliseconds. */
-    timestamp?: number;
+    timestamp: number;
     /** The total number of active chats for this user. */
-    totalUserActiveChats?: number;
+    totalUserActiveChats: number;
     /** The maximum number of concurrent active chats for this user. */
     maxAllowedActiveChats?: number;
     /** Boolean indicating if the user is allowed to start more chats. */
-    moreActiveChatsAllowed?: boolean;
+    moreActiveChatsAllowed: boolean;
     /** Optional List of chat counts per tag. */
-    perTag?: Hume.empathicVoice.ReturnActiveChatCountPerTag[];
+    perTag?: (Hume.empathicVoice.ReturnActiveChatCountPerTag | undefined)[];
 }

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

@@ -6,7 +6,7 @@
  */
 export interface ReturnActiveChatCountPerTag {
     /** User tag applied to a chat. */
-    tag?: string;
+    tag: string;
     /** The total number of active chats for this user with the specified tag. */
-    totalTagActiveChats?: number;
+    totalTagActiveChats: number;
 }

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

@@ -7,15 +7,15 @@ import * as Hume from "../../..";
  */
 export interface ReturnChat {
     /** Identifier for a chat. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Optional Identifier for the chatId that this chat was resumed from. Formatted as a UUID. */
     resumedFromId?: string;
     /** Optional tag applied to this chat used to group chats by user, application, etc. */
     tag?: string;
     /** The status of the chat. Values from the ChatStatus enum. */
-    status?: string;
+    status: string;
     /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
-    startTimestamp?: number;
+    startTimestamp: number;
     /** The timestamp when the chat ended, formatted as a Unix epoch milliseconds. */
     endTimestamp?: number;
     /** Stringified JSON with additional metadata about the chat. */

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

@@ -6,13 +6,13 @@
  */
 export interface ReturnChatEvent {
     /** Identifier for a chat event. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** The timestamp when the chat event occurred, formatted as a Unix epoch milliseconds. */
-    timestamp?: number;
+    timestamp: number;
     /** The role of the user who generated the chat event. Values from the Role enum. */
-    role?: string;
+    role: string;
     /** The type of chat event. Values from the ChatEventType enum. */
-    type?: string;
+    type: string;
     /** The text of the chat message, either transcribed from speaker audio or generated by the agent. */
     messageText?: string;
     /** Stringified JSON with data about emotional content/prosody of the event. */

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

@@ -7,24 +7,24 @@ import * as Hume from "../../..";
  */
 export interface ReturnChatWithPagedEvents {
     /** Identifier for a chat. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Optional Identifier for the chatId that this chat was resumed from. Formatted as a UUID. */
     resumedFromId?: string;
     /** Optional tag applied to this chat used to group chats by user, application, etc. */
     tag?: string;
     /** The status of the chat. Values from the ChatStatus enum. */
-    status?: string;
+    status: string;
     /** The timestamp when the chat started, formatted as a Unix epoch milliseconds. */
-    startTimestamp?: number;
+    startTimestamp: number;
     /** The timestamp when the chat ended, formatted as a Unix epoch milliseconds. */
     endTimestamp?: number;
     /** List of chat events with the specified page number and page size. */
-    eventsPage?: Hume.empathicVoice.ReturnChatEvent[];
+    eventsPage: Hume.empathicVoice.ReturnChatEvent[];
     /** Stringified JSON with additional metadata about the chat. */
     metadata?: string;
     /** The page number of the returned results. */
-    pageNumber?: number;
+    pageNumber: number;
     /** The number of results returned per page. */
-    pageSize?: number;
+    pageSize: number;
     config?: Hume.empathicVoice.ReturnConfigSpec;
 }

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

@@ -6,7 +6,7 @@
  */
 export interface ReturnConfigSpec {
     /** Identifier for a Config. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique. */
     version?: number;
 }

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

@@ -7,9 +7,9 @@ import * as Hume from "../../..";
  */
 export interface ReturnPagedChats {
     /** The page number of the returned results. */
-    pageNumber?: number;
+    pageNumber: number;
     /** The number of results returned per page. */
-    pageSize?: number;
+    pageSize: number;
     /** List of chats and their metadata returned for the specified page number and page size. */
-    chatsPage?: Hume.empathicVoice.ReturnChat[];
+    chatsPage: Hume.empathicVoice.ReturnChat[];
 }

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

@@ -7,9 +7,9 @@ import * as Hume from "../../..";
  */
 export interface ReturnPagedPrompts {
     /** The page number of the returned results. */
-    pageNumber?: number;
+    pageNumber: number;
     /** The number of results returned per page. */
-    pageSize?: number;
+    pageSize: number;
     /** List of prompts returned for the specified page number and page size. */
-    promptsPage?: Hume.empathicVoice.ReturnPrompt[];
+    promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
 }

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

@@ -6,17 +6,17 @@
  */
 export interface ReturnPrompt {
     /** Identifier for a Prompt. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
-    version?: number;
+    version: number;
     /** Description that is appended to a specific version of a Prompt. */
     versionDescription?: string;
     /** Name applied to all versions of a particular Prompt. */
-    name?: string;
+    name: string;
     /** The timestamp when the first version of this prompt was created. */
-    createdOn?: number;
+    createdOn: number;
     /** The timestamp when this version of the prompt was created. */
-    modifiedOn?: number;
+    modifiedOn: number;
     /** Text used for this version of the Prompt. */
-    text?: string;
+    text: string;
 }

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

@@ -6,19 +6,19 @@
  */
 export interface ReturnTool {
     /** Identifier for a Tool. Formatted as a UUID. */
-    id?: string;
+    id: string;
     /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
-    version?: number;
+    version: number;
     /** Description that is appended to a specific version of a Tool. */
     versionDescription?: string;
     /** Name applied to all versions of a particular Tool. */
-    name?: string;
+    name: string;
     /** The timestamp when the first version of this tool was created. */
-    createdOn?: number;
+    createdOn: number;
     /** The timestamp when this version of the tool was created. */
-    modifiedOn?: number;
+    modifiedOn: number;
     /** Text describing what the tool does. */
-    docstring?: string;
-    /** Stringified JSON defining the schema for this version of the Tool. */
-    schema?: string;
+    description?: string;
+    /** Stringified JSON defining the parameters used by this version of the Tool. */
+    parameters: string;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A specific voice specification
+ */
+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;
+}

package/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/api/resources/empathicVoice/types/SessionSettings.d.ts

@@ -2,8 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../../..";
+/**
+ * Settings for this chat session.
+ */
 export interface SessionSettings {
+    customSessionId?: string;
     audio?: Hume.empathicVoice.AudioConfiguration;
     languageModelApiKey?: string;
-    type?: "session_settings";
+    systemPrompt?: string;
+    type: "session_settings";
 }

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

@@ -2,7 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface TextInput {
-    /** Text to insert into the conversation. */
-    text: string;
-    type: "user_input";
+    type?: "text_input";
 }

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

@@ -2,7 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface TtsInput {
-    /** Text to be synthesized. */
-    text: string;
-    type: "assistant_input";
+    type?: "tts";
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * User text to insert into the conversation.
+ */
+export interface UserInput {
+    customSessionId?: string;
+    /** User text to insert into the conversation. */
+    text: string;
+    type: "user_input";
+}

package/api/resources/empathicVoice/types/UserInput.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/api/resources/empathicVoice/types/UserInterruption.d.ts

@@ -1,7 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * When provided, the output is an interruption.
+ */
 export interface UserInterruption {
+    customSessionId?: string;
     time: number;
     type: "user_interruption";
 }

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

@@ -2,15 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Hume from "../../..";
+/**
+ * When provided, the output is a user message.
+ */
 export interface UserMessage {
+    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;
-    /** Segments of the user message. */
-    serializedSegments: Record<string, unknown>[];
     /** Start and End time of user message. */
     time: Hume.empathicVoice.MillisecondInterval;
     type: "user_message";

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

@@ -1,14 +1,15 @@
 export * from "./PostedTool";
 export * from "./ReturnTool";
-export * from "./PostedPrompt";
+export * from "./PostedToolVersion";
 export * from "./ReturnPrompt";
-export * from "./PostedConfig";
 export * from "./PostedLanguageModelModelProvider";
 export * from "./PostedLanguageModel";
 export * from "./PostedPromptSpec";
 export * from "./PostedToolSpec";
+export * from "./PostedVoice";
 export * from "./ReturnConfig";
 export * from "./ReturnLanguageModel";
+export * from "./ReturnVoice";
 export * from "./PostedToolName";
 export * from "./PostedToolVersionDescription";
 export * from "./ReturnPagedPrompts";
@@ -21,6 +22,7 @@ export * from "./ReturnChatWithPagedEvents";
 export * from "./ReturnActiveChatCount";
 export * from "./ReturnActiveChatCountPerTag";
 export * from "./AssistantEnd";
+export * from "./AssistantInput";
 export * from "./AssistantMessage";
 export * from "./AudioConfiguration";
 export * from "./AudioInput";
@@ -34,8 +36,9 @@ export * from "./MillisecondInterval";
 export * from "./ProsodyInference";
 export * from "./Role";
 export * from "./SessionSettings";
-export * from "./TextInput";
-export * from "./TtsInput";
+export * from "./UserInput";
 export * from "./UserInterruption";
 export * from "./UserMessage";
+export * from "./TtsInput";
+export * from "./TextInput";
 export * from "./FunctionCallResponseInput";