hume 0.6.3 → 0.7.0

package/.mock/definition/empathic-voice/__package__.yml

@@ -16,7 +16,7 @@ types:
       version_type:
         type: string
         docs: >-
-          Inidicates whether this tool is using a fixed version number or
+          Indicates whether this tool is using a fixed version number or
           auto-updating to the latest version. Values from the VersionType enum.
       version_description:
         type: optional<string>
@@ -55,7 +55,7 @@ types:
       version_type:
         type: string
         docs: >-
-          Inidicates whether this prompt is using a fixed version number or
+          Indicates whether this prompt is using a fixed version number or
           auto-updating to the latest version. Values from the VersionType enum.
       version_description:
         type: optional<string>
@@ -175,12 +175,8 @@ types:
       prompt: optional<ReturnPrompt>
       voice: optional<ReturnVoice>
       language_model: optional<ReturnLanguageModel>
-      tools:
-        type: optional<list<optional<ReturnUserDefinedTool>>>
-        docs: List of user-defined tools associated with this config.
-      builtin_tools:
-        type: optional<list<optional<ReturnBuiltinTool>>>
-        docs: List of built-in tools associated with this config
+      tools: optional<ReturnUserDefinedTool>
+      builtin_tools: optional<ReturnBuiltinTool>
   ReturnLanguageModel:
     docs: A specific LanguageModel
     properties:
@@ -510,7 +506,11 @@ types:
   AssistantEnd:
     docs: When provided, the output is an assistant end message.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       type:
         type: literal<"assistant_end">
         docs: >-
@@ -519,7 +519,11 @@ types:
   AssistantInput:
     docs: When provided, the input is spoken by EVI.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       text:
         type: string
         docs: Text to be synthesized.
@@ -531,7 +535,11 @@ types:
   AssistantMessage:
     docs: When provided, the output is an assistant message.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       from_text:
         type: boolean
         docs: Indicates if this message was constructed from a text input message.
@@ -563,7 +571,11 @@ types:
   AudioInput:
     docs: When provided, the input is audio.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       data:
         type: string
         docs: Base64 encoded audio input.
@@ -577,7 +589,11 @@ types:
   AudioOutput:
     docs: When provided, the output is audio.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       data:
         type: string
         docs: Base64 encoded audio output.
@@ -604,11 +620,15 @@ types:
       - ToolErrorMessage
   ChatMessage:
     properties:
-      content: optional<string>
+      content:
+        type: optional<string>
+        docs: Transcript of the message.
       role:
         type: Role
         docs: Role of who is providing the message.
-      tool_call: optional<ToolCallMessage>
+      tool_call:
+        type: optional<ToolCallMessage>
+        docs: Function call name and arguments.
       tool_result:
         type: optional<ChatMessageToolResult>
         docs: Function call response from client.
@@ -621,7 +641,11 @@ types:
       chat_id:
         type: string
         docs: ID of the chat.
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       type:
         type: literal<"chat_metadata">
         docs: >-
@@ -697,7 +721,11 @@ types:
       code:
         type: string
         docs: Error code.
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       message:
         type: string
         docs: Error message.
@@ -712,7 +740,9 @@ types:
   ErrorLevel: literal<"warn">
   Inference:
     properties:
-      prosody: optional<ProsodyInference>
+      prosody:
+        type: optional<ProsodyInference>
+        docs: Prosody model inference results.
   MillisecondInterval:
     properties:
       begin:
@@ -726,7 +756,11 @@ types:
       Pause responses from EVI. Chat history is still saved and sent after
       resuming. 
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       type:
         type: optional<literal<"pause_assistant_message">>
         docs: >-
@@ -740,7 +774,11 @@ types:
       Resume responses from EVI. Chat history sent while paused will now be
       sent. 
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       type:
         type: optional<literal<"resume_assistant_message">>
         docs: >-
@@ -756,12 +794,28 @@ types:
   SessionSettings:
     docs: Settings for this chat session.
     properties:
-      audio: optional<AudioConfiguration>
-      builtin_tools: optional<list<BuiltinToolConfig>>
-      custom_session_id: optional<string>
-      language_model_api_key: optional<string>
-      system_prompt: optional<string>
-      tools: optional<list<Tool>>
+      audio:
+        type: optional<AudioConfiguration>
+        docs: Audio configuration.
+      builtin_tools:
+        type: optional<list<BuiltinToolConfig>>
+        docs: List of builtin tools to enable.
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
+      language_model_api_key:
+        type: optional<string>
+        docs: Third party API key for the language model used for non-Hume models.
+      system_prompt:
+        type: optional<string>
+        docs: >-
+          Instructions for how the system should respond to the user. Set to
+          null to use the default system prompt.
+      tools:
+        type: optional<list<Tool>>
+        docs: List of tools to enable.
       type:
         type: literal<"session_settings">
         docs: >-
@@ -769,8 +823,14 @@ types:
           message, this must be 'session_settings'.
   Tool:
     properties:
-      description: optional<string>
-      fallback_content: optional<string>
+      description:
+        type: optional<string>
+        docs: Description of the function.
+      fallback_content:
+        type: optional<string>
+        docs: >-
+          Fallback content of the tool, passed to the LLM if the function call
+          response fails.
       name:
         type: string
         docs: Name of the tool.
@@ -783,7 +843,11 @@ types:
   ToolCallMessage:
     docs: When provided, the output is a tool call.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       name:
         type: string
         docs: Name of the tool called.
@@ -807,17 +871,29 @@ types:
   ToolErrorMessage:
     docs: When provided, the output is a function call error.
     properties:
-      code: optional<string>
-      content: optional<string>
-      custom_session_id: optional<string>
+      code:
+        type: optional<string>
+        docs: Error code.
+      content:
+        type: optional<string>
+        docs: The content passed to the LLM in place of the tool response.
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       error:
         type: string
         docs: Error message from the tool call, not exposed to the LLM or user.
-      level: optional<ErrorLevel>
+      level:
+        type: optional<ErrorLevel>
+        docs: Error level.
       tool_call_id:
         type: string
         docs: ID of the tool call.
-      tool_type: optional<ToolType>
+      tool_type:
+        type: optional<ToolType>
+        docs: Type of tool called, either 'builtin' or 'function'.
       type:
         type: optional<literal<"tool_error">>
         docs: >-
@@ -829,7 +905,11 @@ types:
       content:
         type: string
         docs: Return value of the tool call.
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       tool_call_id:
         type: string
         docs: ID of the tool call.
@@ -847,7 +927,11 @@ types:
   UserInput:
     docs: User text to insert into the conversation.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       text:
         type: string
         docs: User text to insert into the conversation.
@@ -859,7 +943,11 @@ types:
   UserInterruption:
     docs: When provided, the output is an interruption.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       time:
         type: integer
         docs: Unix timestamp of the detected user interruption.
@@ -871,7 +959,11 @@ types:
   UserMessage:
     docs: When provided, the output is a user message.
     properties:
-      custom_session_id: optional<string>
+      custom_session_id:
+        type: optional<string>
+        docs: >-
+          Used to manage conversational state, correlate frontend and backend
+          data, and persist conversations across EVI sessions.
       from_text:
         type: boolean
         docs: Indicates if this message was constructed from a text input message.

package/.mock/definition/empathic-voice/chat.yml

@@ -1,10 +1,17 @@
 channel:
-  path: /chat
+  path: /v0/evi/chat
   auth: false
   query-parameters:
     access_token:
       type: optional<string>
-      docs: Access token used for authenticating the client.
+      docs: >-
+        Access token used for authenticating the client. If not provided, an
+        `api_key` must be provided to authenticate.
+    api_key:
+      type: optional<string>
+      docs: >-
+        API key used for authenticating the client. If not provided, an
+        `access_token` must be provided to authenticate.
     config_id:
       type: optional<string>
       docs: The unique identifier for the EVI configuration to be used.

package/.mock/definition/empathic-voice/chatGroups.yml

@@ -7,7 +7,7 @@ service:
     list-chat-groups:
       path: /v0/evi/chat_groups
       method: GET
-      auth: false
+      auth: true
       display-name: List chat_groups
       request:
         name: ChatGroupsListChatGroupsRequest
@@ -36,7 +36,7 @@ service:
     list-chat-group-events:
       path: /v0/evi/chat_groups/{id}/events
       method: GET
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string

package/.mock/definition/empathic-voice/chats.yml

@@ -7,7 +7,7 @@ service:
     list-chats:
       path: /v0/evi/chats
       method: GET
-      auth: false
+      auth: true
       display-name: List chats
       request:
         name: ChatsListChatsRequest
@@ -18,6 +18,9 @@ service:
           page_size:
             type: optional<integer>
             docs: The maximum number of results to include per page.
+          ascending_order:
+            type: optional<boolean>
+            docs: List chats in ascending order.
       response:
         docs: Success
         type: root.ReturnPagedChats
@@ -40,7 +43,7 @@ service:
     list-chat-events:
       path: /v0/evi/chats/{id}
       method: GET
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string

package/.mock/definition/empathic-voice/configs.yml

@@ -7,7 +7,7 @@ service:
     list-configs:
       path: /v0/evi/configs
       method: GET
-      auth: false
+      auth: true
       display-name: List configs
       request:
         name: ConfigsListConfigsRequest
@@ -47,10 +47,22 @@ service:
                   voice:
                     provider: provider
                     name: name
+                  tools:
+                    tool_type: tool_type
+                    id: id
+                    version: 1
+                    version_type: version_type
+                    name: name
+                    created_on: 1
+                    modified_on: 1
+                    parameters: parameters
+                  builtin_tools:
+                    tool_type: tool_type
+                    name: name
     create-config:
       path: /v0/evi/configs
       method: POST
-      auth: false
+      auth: true
       display-name: Create config
       request:
         name: PostedConfig
@@ -65,12 +77,8 @@ service:
             prompt: optional<root.PostedPromptSpec>
             voice: optional<root.PostedVoice>
             language_model: optional<root.PostedLanguageModel>
-            tools:
-              type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
-              docs: Tool specification for a Config.
-            builtin_tools:
-              type: optional<list<optional<root.PostedBuiltinTool>>>
-              docs: Built-in tool specification for a Config.
+            tools: optional<root.PostedUserDefinedToolSpec>
+            builtin_tools: optional<root.PostedBuiltinTool>
       response:
         docs: Success
         type: root.ReturnConfig
@@ -102,25 +110,25 @@ service:
                 model_resource: model_resource
                 temperature: 1.1
               tools:
-                - tool_type: tool_type
-                  id: id
-                  version: 1
-                  version_type: version_type
-                  version_description: version_description
-                  name: name
-                  created_on: 1
-                  modified_on: 1
-                  fallback_content: fallback_content
-                  description: description
-                  parameters: parameters
+                tool_type: tool_type
+                id: id
+                version: 1
+                version_type: version_type
+                version_description: version_description
+                name: name
+                created_on: 1
+                modified_on: 1
+                fallback_content: fallback_content
+                description: description
+                parameters: parameters
               builtin_tools:
-                - tool_type: tool_type
-                  name: name
-                  fallback_content: fallback_content
+                tool_type: tool_type
+                name: name
+                fallback_content: fallback_content
     list-config-versions:
       path: /v0/evi/configs/{id}
       method: GET
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -166,10 +174,22 @@ service:
                   voice:
                     provider: provider
                     name: name
+                  tools:
+                    tool_type: tool_type
+                    id: id
+                    version: 1
+                    version_type: version_type
+                    name: name
+                    created_on: 1
+                    modified_on: 1
+                    parameters: parameters
+                  builtin_tools:
+                    tool_type: tool_type
+                    name: name
     create-config-version:
       path: /v0/evi/configs/{id}
       method: POST
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -185,12 +205,8 @@ service:
             prompt: optional<root.PostedPromptSpec>
             voice: optional<root.PostedVoice>
             language_model: optional<root.PostedLanguageModel>
-            tools:
-              type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
-              docs: Tool specification for a Config.
-            builtin_tools:
-              type: optional<list<optional<root.PostedBuiltinTool>>>
-              docs: Built-in tool specification for a Config.
+            tools: optional<root.PostedUserDefinedToolSpec>
+            builtin_tools: optional<root.PostedBuiltinTool>
       response:
         docs: Success
         type: root.ReturnConfig
@@ -223,25 +239,25 @@ service:
                 model_resource: model_resource
                 temperature: 1.1
               tools:
-                - tool_type: tool_type
-                  id: id
-                  version: 1
-                  version_type: version_type
-                  version_description: version_description
-                  name: name
-                  created_on: 1
-                  modified_on: 1
-                  fallback_content: fallback_content
-                  description: description
-                  parameters: parameters
+                tool_type: tool_type
+                id: id
+                version: 1
+                version_type: version_type
+                version_description: version_description
+                name: name
+                created_on: 1
+                modified_on: 1
+                fallback_content: fallback_content
+                description: description
+                parameters: parameters
               builtin_tools:
-                - tool_type: tool_type
-                  name: name
-                  fallback_content: fallback_content
+                tool_type: tool_type
+                name: name
+                fallback_content: fallback_content
     delete-config:
       path: /v0/evi/configs/{id}
       method: DELETE
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -253,7 +269,7 @@ service:
     update-config-name:
       path: /v0/evi/configs/{id}
       method: PATCH
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -272,7 +288,7 @@ service:
     get-config-version:
       path: /v0/evi/configs/{id}/version/{version}
       method: GET
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -313,25 +329,25 @@ service:
                 model_resource: model_resource
                 temperature: 1.1
               tools:
-                - tool_type: tool_type
-                  id: id
-                  version: 1
-                  version_type: version_type
-                  version_description: version_description
-                  name: name
-                  created_on: 1
-                  modified_on: 1
-                  fallback_content: fallback_content
-                  description: description
-                  parameters: parameters
+                tool_type: tool_type
+                id: id
+                version: 1
+                version_type: version_type
+                version_description: version_description
+                name: name
+                created_on: 1
+                modified_on: 1
+                fallback_content: fallback_content
+                description: description
+                parameters: parameters
               builtin_tools:
-                - tool_type: tool_type
-                  name: name
-                  fallback_content: fallback_content
+                tool_type: tool_type
+                name: name
+                fallback_content: fallback_content
     delete-config-version:
       path: /v0/evi/configs/{id}/version/{version}
       method: DELETE
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -347,7 +363,7 @@ service:
     update-config-description:
       path: /v0/evi/configs/{id}/version/{version}
       method: PATCH
-      auth: false
+      auth: true
       path-parameters:
         id:
           type: string
@@ -396,18 +412,18 @@ service:
                 model_resource: model_resource
                 temperature: 1.1
               tools:
-                - tool_type: tool_type
-                  id: id
-                  version: 1
-                  version_type: version_type
-                  version_description: version_description
-                  name: name
-                  created_on: 1
-                  modified_on: 1
-                  fallback_content: fallback_content
-                  description: description
-                  parameters: parameters
+                tool_type: tool_type
+                id: id
+                version: 1
+                version_type: version_type
+                version_description: version_description
+                name: name
+                created_on: 1
+                modified_on: 1
+                fallback_content: fallback_content
+                description: description
+                parameters: parameters
               builtin_tools:
-                - tool_type: tool_type
-                  name: name
-                  fallback_content: fallback_content
+                tool_type: tool_type
+                name: name
+                fallback_content: fallback_content