hume 0.5.9 → 0.5.13

package/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
+ *         versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
+ *         fallbackContent: "Unable to fetch current weather.",
+ *         description: "This tool is for getting the current weather."
+ *     }
+ */
+export interface PostedUserDefinedToolVersion {
+    /** 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;
+    /** Text to use if the tool fails to generate content. */
+    fallbackContent?: string;
+}

package/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
+ *     }
+ */
+export interface PostedUserDefinedToolVersionDescription {
+    /** Description that is appended to a specific version of a Tool. */
+    versionDescription?: string;
+}

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

@@ -0,0 +1,6 @@
+export { type GetReturnToolsForUserRequest } from "./GetReturnToolsForUserRequest";
+export { type PostedUserDefinedTool } from "./PostedUserDefinedTool";
+export { type GetReturnToolByToolIdRequest } from "./GetReturnToolByToolIdRequest";
+export { type PostedUserDefinedToolVersion } from "./PostedUserDefinedToolVersion";
+export { type PostedUserDefinedToolName } from "./PostedUserDefinedToolName";
+export { type PostedUserDefinedToolVersionDescription } from "./PostedUserDefinedToolVersionDescription";

package/api/resources/empathicVoice/resources/tools/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/api/resources/empathicVoice/resources/tools/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);

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

@@ -5,6 +5,5 @@
  * When provided, the output is an assistant end message.
  */
 export interface AssistantEnd {
-    customSessionId?: string;
     type: "assistant_end";
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * When provided, the output is an assistant message.
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 export interface AudioConfiguration {
     /** Number of channels. */
     channels: number;

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

@@ -1,9 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 export interface ChatMessage {
     content?: string;
     /** Role of who is providing the message. */
     role: Hume.empathicVoice.Role;
+    toolCall?: Hume.empathicVoice.ToolCallMessage;
+    /** Function call response from client. */
+    toolResult?: Hume.empathicVoice.ChatMessageToolResult;
 }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * Function call response from client.
+ */
+export declare type ChatMessageToolResult = Hume.empathicVoice.ToolResponseMessage | Hume.empathicVoice.ToolErrorMessage;

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ErrorLevel = "warn";

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 export interface Inference {
     prosody?: Hume.empathicVoice.ProsodyInference;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A configuration of a built-in tool to be posted to the server
+ */
+export interface PostedBuiltinTool {
+    /** Name applied to all versions of a particular Tool. */
+    name: string;
+    /** Text to use if the tool fails to generate content. */
+    fallbackContent?: string;
+}

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A LanguageModel to be posted to the server
  */

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

@@ -8,5 +8,5 @@ export interface PostedPromptSpec {
     /** Identifier for a Prompt. Formatted as a UUID. */
     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/{dist/api/resources/empathicVoice/types/PostedToolSpec.d.ts → api/resources/empathicVoice/types/PostedUserDefinedToolSpec.d.ts}

@@ -4,9 +4,9 @@
 /**
  * A specific tool identifier to be posted to the server
  */
-export interface PostedToolSpec {
+export interface PostedUserDefinedToolSpec {
     /** Identifier for a Tool. Formatted as a UUID. */
     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/ProsodyInference.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 export interface ProsodyInference {
     scores: Hume.empathicVoice.EmotionScores;
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A description of current chat chat sessions for a user
  */

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A specific builtin tool version returned from the server
+ */
+export interface ReturnBuiltinTool {
+    /** Type of Tool. Values from the ToolType enum. */
+    toolType: string;
+    /** Name applied to all versions of a particular Tool. */
+    name: string;
+    /** Text to use if the tool fails to generate content. */
+    fallbackContent?: string;
+}

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

@@ -1,15 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A description of chat and its status
  */
 export interface ReturnChat {
     /** Identifier for a chat. Formatted as a UUID. */
     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. */

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

@@ -1,15 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A description of chat status with a paginated list of chat events returned from the server
  */
 export interface ReturnChatWithPagedEvents {
     /** Identifier for a chat. Formatted as a UUID. */
     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. */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A specific config version returned from the server
  */
@@ -20,4 +20,8 @@ export interface ReturnConfig {
     modifiedOn?: number;
     prompt?: Hume.empathicVoice.ReturnPrompt;
     languageModel?: Hume.empathicVoice.ReturnLanguageModel;
+    /** List of user-defined tools associated with this config. */
+    tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
+    /** List of built-in tools associated with this config */
+    builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A paginated list of chats returned from the server
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A paginated list of config versions returned from the server
  */

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * A paginated list of prompt versions returned from the server
  */

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

@@ -0,0 +1,15 @@
+/**
+ * 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 results. */
+    pageNumber: number;
+    /** The number of results returned per page. */
+    pageSize: number;
+    /** List of tools returned for the specified page number and page size. */
+    toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
+}

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

@@ -9,6 +9,8 @@ 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;
+    /** Inidicates 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;
     /** Name applied to all versions of a particular Prompt. */

package/api/resources/empathicVoice/types/{ReturnTool.d.ts → ReturnUserDefinedTool.d.ts}

@@ -4,11 +4,15 @@
 /**
  * A specific tool version returned from the server
  */
-export interface ReturnTool {
+export interface ReturnUserDefinedTool {
+    /** Type of Tool. Values from the ToolType enum. */
+    toolType: string;
     /** Identifier for a Tool. Formatted as a UUID. */
     id: string;
     /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
+    /** Inidicates whether this tool 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 Tool. */
     versionDescription?: string;
     /** Name applied to all versions of a particular Tool. */
@@ -17,6 +21,8 @@ export interface ReturnTool {
     createdOn: number;
     /** The timestamp when this version of the tool was created. */
     modifiedOn: number;
+    /** Text to use if the tool fails to generate content. */
+    fallbackContent?: string;
     /** Text describing what the tool does. */
     description?: string;
     /** Stringified JSON defining the parameters used by this version of the Tool. */

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

@@ -1,10 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Role = "assistant" | "system" | "user" | "all";
+export declare 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/api/resources/empathicVoice/types/Role.js

@@ -9,4 +9,5 @@ exports.Role = {
     System: "system",
     User: "user",
     All: "all",
+    Tool: "tool",
 };

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * Settings for this chat session.
  */
@@ -11,4 +11,5 @@ export interface SessionSettings {
     languageModelApiKey?: string;
     systemPrompt?: string;
     type: "session_settings";
+    tools?: Hume.empathicVoice.Tool[];
 }

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+export interface Tool {
+    /** Type of tool. */
+    type: Hume.empathicVoice.ToolType;
+    /** Name of the function. */
+    name: string;
+    /** Parameters of the function. Is a stringified JSON schema. */
+    parameters: string;
+    description?: string;
+    fallbackContent?: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * When provided, the output is a tool call.
+ */
+export interface ToolCallMessage {
+    /** Name of the tool called. */
+    name: string;
+    /** Parameters of the tool call. Is a stringified JSON schema. */
+    parameters: string;
+    /** ID of the tool call. */
+    toolCallId: string;
+    type?: "tool_call";
+    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/ToolCallMessage.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/ToolErrorMessage.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Hume from "../../../index";
+/**
+ * When provided, the output is a function call error.
+ */
+export interface ToolErrorMessage {
+    type: "tool_error";
+    customSessionId?: string;
+    /** 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;
+    code?: string;
+    level?: Hume.empathicVoice.ErrorLevel;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * When provided, the output is a function call response.
+ */
+export interface ToolResponseMessage {
+    type: "tool_response";
+    customSessionId?: string;
+    /** ID of the tool call. */
+    toolCallId: string;
+    /** Return value of the tool call. */
+    content: string;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ToolType = "builtin" | "function";
+export declare const ToolType: {
+    readonly Builtin: "builtin";
+    readonly Function: "function";
+};

package/api/resources/empathicVoice/types/ToolType.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.ToolType = void 0;
+exports.ToolType = {
+    Builtin: "builtin",
+    Function: "function",
+};

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Hume from "../../..";
+import * as Hume from "../../../index";
 /**
  * When provided, the output is a user message.
  */

package/api/resources/empathicVoice/types/{Error_.d.ts → WebSocketError.d.ts}

@@ -4,7 +4,7 @@
 /**
  * When provided, the output is an error message.
  */
-export interface Error_ {
+export interface WebSocketError {
     /** Error code. */
     code: string;
     customSessionId?: string;

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

@@ -1,17 +1,16 @@
-export * from "./PostedTool";
-export * from "./ReturnTool";
-export * from "./PostedToolVersion";
+export * from "./ReturnUserDefinedTool";
 export * from "./ReturnPrompt";
+export * from "./PostedBuiltinTool";
 export * from "./PostedLanguageModelModelProvider";
 export * from "./PostedLanguageModel";
 export * from "./PostedPromptSpec";
-export * from "./PostedToolSpec";
+export * from "./PostedUserDefinedToolSpec";
 export * from "./PostedVoice";
+export * from "./ReturnBuiltinTool";
 export * from "./ReturnConfig";
 export * from "./ReturnLanguageModel";
 export * from "./ReturnVoice";
-export * from "./PostedToolName";
-export * from "./PostedToolVersionDescription";
+export * from "./ReturnPagedUserDefinedTools";
 export * from "./ReturnPagedPrompts";
 export * from "./ReturnPagedConfigs";
 export * from "./ReturnChat";
@@ -27,16 +26,23 @@ export * from "./AssistantMessage";
 export * from "./AudioConfiguration";
 export * from "./AudioInput";
 export * from "./AudioOutput";
+export * from "./ChatMessageToolResult";
 export * from "./ChatMessage";
+export * from "./ErrorLevel";
+export * from "./Tool";
+export * from "./ToolErrorMessage";
+export * from "./ToolResponseMessage";
+export * from "./ToolType";
 export * from "./EmotionScores";
 export * from "./Encoding";
-export * from "./Error_";
+export * from "./WebSocketError";
 export * from "./Inference";
 export * from "./MillisecondInterval";
 export * from "./ProsodyInference";
 export * from "./Role";
 export * from "./SessionSettings";
 export * from "./UserInput";
+export * from "./ToolCallMessage";
 export * from "./UserInterruption";
 export * from "./UserMessage";
 export * from "./TtsInput";