hume 0.8.10 → 0.9.0

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

@@ -119,28 +119,28 @@ types:
     SubscribeEvent:
         discriminated: false
         union:
-            - root.AssistantEnd
-            - root.AssistantMessage
-            - root.AudioOutput
-            - root.ChatMetadata
-            - root.WebSocketError
-            - root.UserInterruption
-            - root.UserMessage
-            - root.ToolCallMessage
-            - root.ToolResponseMessage
-            - root.ToolErrorMessage
+            - type: root.AssistantEnd
+            - type: root.AssistantMessage
+            - type: root.AudioOutput
+            - type: root.ChatMetadata
+            - type: root.WebSocketError
+            - type: root.UserInterruption
+            - type: root.UserMessage
+            - type: root.ToolCallMessage
+            - type: root.ToolResponseMessage
+            - type: root.ToolErrorMessage
         source:
-            openapi: ../empathic-voice-interface/assistant-asyncapi.json
+            openapi: assistant-asyncapi.json
     PublishEvent:
         discriminated: false
         union:
-            - root.AudioInput
-            - root.SessionSettings
-            - root.UserInput
-            - root.AssistantInput
-            - root.ToolResponseMessage
-            - root.ToolErrorMessage
-            - root.PauseAssistantMessage
-            - root.ResumeAssistantMessage
+            - type: root.AudioInput
+            - type: root.SessionSettings
+            - type: root.UserInput
+            - type: root.AssistantInput
+            - type: root.ToolResponseMessage
+            - type: root.ToolErrorMessage
+            - type: root.PauseAssistantMessage
+            - type: root.ResumeAssistantMessage
         source:
-            openapi: ../empathic-voice-interface/assistant-asyncapi.json
+            openapi: assistant-asyncapi.json

package/.mock/definition/empathic-voice/{chat-groups.yml → chatGroups.yml}

@@ -8,6 +8,7 @@ service:
             path: /v0/evi/chat_groups
             method: GET
             auth: true
+            docs: Fetches a paginated list of **Chat Groups**.
             display-name: List chat_groups
             request:
                 name: ChatGroupsListChatGroupsRequest
@@ -52,6 +53,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedChatGroups
+            errors:
+                - root.BadRequestError
             examples:
                 - query-parameters:
                       page_number: 0
@@ -71,10 +74,87 @@ service:
                                 active: false
                                 most_recent_chat_id: dfdbdd4d-0ddf-418b-8fc4-80a266579d36
                                 num_chats: 5
+        get-chat-group:
+            path: /v0/evi/chat_groups/{id}
+            method: GET
+            auth: true
+            docs: >-
+                Fetches a **ChatGroup** by ID, including a paginated list of **Chats**
+                associated with the **ChatGroup**.
+            path-parameters:
+                id:
+                    type: string
+                    docs: Identifier for a Chat Group. Formatted as a UUID.
+            display-name: Get chat_group
+            request:
+                name: ChatGroupsGetChatGroupRequest
+                query-parameters:
+                    page_size:
+                        type: optional<integer>
+                        docs: >-
+                            Specifies the maximum number of results to include per page,
+                            enabling pagination. The value must be between 1 and 100,
+                            inclusive.
+
+
+                            For example, if `page_size` is set to 10, each page will include
+                            up to 10 items. Defaults to 10.
+                    page_number:
+                        type: optional<integer>
+                        docs: >-
+                            Specifies the page number to retrieve, enabling pagination.
+
+
+                            This parameter uses zero-based indexing. For example, setting
+                            `page_number` to 0 retrieves the first page of results (items 0-9
+                            if `page_size` is 10), setting `page_number` to 1 retrieves the
+                            second page (items 10-19), and so on. Defaults to 0, which
+                            retrieves the first page.
+                    ascending_order:
+                        type: optional<boolean>
+                        docs: >-
+                            Specifies the sorting order of the results based on their creation
+                            date. Set to true for ascending order (chronological, with the
+                            oldest records first) and false for descending order
+                            (reverse-chronological, with the newest records first). Defaults
+                            to true.
+            response:
+                docs: Success
+                type: root.ReturnChatGroupPagedChats
+            errors:
+                - root.BadRequestError
+            examples:
+                - path-parameters:
+                      id: 697056f0-6c7e-487d-9bd8-9c19df79f05f
+                  query-parameters:
+                      page_number: 0
+                      page_size: 1
+                      ascending_order: true
+                  response:
+                      body:
+                          id: 369846cf-6ad5-404d-905e-a8acb5cdfc78
+                          first_start_timestamp: 1712334213647
+                          most_recent_start_timestamp: 1712334213647
+                          num_chats: 1
+                          page_number: 0
+                          page_size: 1
+                          total_pages: 1
+                          pagination_direction: ASC
+                          chats_page:
+                              - id: 6375d4f8-cd3e-4d6b-b13b-ace66b7c8aaa
+                                chat_group_id: 369846cf-6ad5-404d-905e-a8acb5cdfc78
+                                status: USER_ENDED
+                                start_timestamp: 1712334213647
+                                end_timestamp: 1712334332571
+                                event_count: 0
+                          active: false
         list-chat-group-events:
             path: /v0/evi/chat_groups/{id}/events
             method: GET
             auth: true
+            docs: >-
+                Fetches a paginated list of **Chat** events associated with a **Chat
+                Group**.
             path-parameters:
                 id:
                     type: string
@@ -115,6 +195,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnChatGroupPagedEvents
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 697056f0-6c7e-487d-9bd8-9c19df79f05f
@@ -441,4 +523,4 @@ service:
                                     "Triumph": 0.04107666015625}
                                 metadata: ""
     source:
-        openapi: ../empathic-voice-interface/stenographer-openapi.json
+        openapi: stenographer-openapi.json

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

@@ -8,6 +8,7 @@ service:
             path: /v0/evi/chats
             method: GET
             auth: true
+            docs: Fetches a paginated list of **Chats**.
             pagination:
                 offset: $request.page_number
                 results: $response.chats_page
@@ -47,6 +48,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedChats
+            errors:
+                - root.BadRequestError
             examples:
                 - query-parameters:
                       page_number: 0
@@ -73,6 +76,7 @@ service:
             path: /v0/evi/chats/{id}
             method: GET
             auth: true
+            docs: Fetches a paginated list of **Chat** events.
             pagination:
                 offset: $request.page_number
                 results: $response.events_page
@@ -116,6 +120,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnChatPagedEvents
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
@@ -450,4 +456,4 @@ service:
                               id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
                               version: 0
     source:
-        openapi: ../empathic-voice-interface/stenographer-openapi.json
+        openapi: stenographer-openapi.json

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

@@ -8,6 +8,13 @@ service:
             path: /v0/evi/configs
             method: GET
             auth: true
+            docs: >-
+                Fetches a paginated list of **Configs**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             display-name: List configs
             request:
                 name: ConfigsListConfigsRequest
@@ -45,6 +52,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedConfigs
+            errors:
+                - root.BadRequestError
             examples:
                 - query-parameters:
                       page_number: 0
@@ -61,6 +70,7 @@ service:
                                 name: Weather Assistant Config
                                 created_on: 1715267200693
                                 modified_on: 1715267200693
+                                evi_version: "2"
                                 prompt:
                                     id: af699d45-2985-42cc-91b9-af9e5da3bac5
                                     version: 0
@@ -78,7 +88,20 @@ service:
                                         Include helpful tips if severe weather is expected.</role>
                                 voice:
                                     provider: HUME_AI
-                                    name: KORA
+                                    name: SAMPLE VOICE
+                                    custom_voice:
+                                        id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                        version: 1
+                                        name: SAMPLE VOICE
+                                        created_on: 1724704587367
+                                        modified_on: 1725489961583
+                                        base_voice: KORA
+                                        parameter_model: 20240715-4parameter
+                                        parameters:
+                                            gender: -7
+                                            huskiness: -2
+                                            nasality: -8
+                                            pitch: -9
                                 language_model:
                                     model_provider: ANTHROPIC
                                     model_resource: claude-3-5-sonnet-20240620
@@ -108,18 +131,32 @@ service:
             path: /v0/evi/configs
             method: POST
             auth: true
+            docs: >-
+                Creates a **Config** which can be applied to EVI.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             display-name: Create config
             request:
                 name: PostedConfig
                 body:
                     properties:
+                        evi_version:
+                            type: string
+                            docs: >-
+                                Specifies the EVI version to use. Use `"1"` for version 1, or
+                                `"2"` for the latest enhanced version. For a detailed comparison
+                                of the two versions, refer to our
+                                [guide](/docs/empathic-voice-interface-evi/evi-2).
                         name:
                             type: string
                             docs: Name applied to all versions of a particular Config.
                         version_description:
                             type: optional<string>
                             docs: An optional description of the Config version.
-                        prompt: optional<root.PostedPromptSpec>
+                        prompt: optional<root.PostedConfigPromptSpec>
                         voice:
                             type: optional<root.PostedVoice>
                             docs: A voice specification associated with this Config.
@@ -151,18 +188,22 @@ service:
                             docs: List of built-in tools associated with this Config.
                         event_messages: optional<root.PostedEventMessageSpecs>
                         timeouts: optional<root.PostedTimeoutSpecs>
+                content-type: application/json
             response:
                 docs: Created
                 type: root.ReturnConfig
+            errors:
+                - root.BadRequestError
             examples:
                 - request:
                       name: Weather Assistant Config
                       prompt:
                           id: af699d45-2985-42cc-91b9-af9e5da3bac5
                           version: 0
+                      evi_version: "2"
                       voice:
                           provider: HUME_AI
-                          name: KORA
+                          name: SAMPLE VOICE
                       language_model:
                           model_provider: ANTHROPIC
                           model_resource: claude-3-5-sonnet-20240620
@@ -185,6 +226,7 @@ service:
                           name: Weather Assistant Config
                           created_on: 1715275452390
                           modified_on: 1715275452390
+                          evi_version: "2"
                           prompt:
                               id: af699d45-2985-42cc-91b9-af9e5da3bac5
                               version: 0
@@ -202,7 +244,20 @@ service:
                                   severe weather is expected.</role>
                           voice:
                               provider: HUME_AI
-                              name: KORA
+                              name: SAMPLE VOICE
+                              custom_voice:
+                                  id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                  version: 1
+                                  name: SAMPLE VOICE
+                                  created_on: 1724704587367
+                                  modified_on: 1725489961583
+                                  base_voice: KORA
+                                  parameter_model: 20240715-4parameter
+                                  parameters:
+                                      gender: -7
+                                      huskiness: -2
+                                      nasality: -8
+                                      pitch: -9
                           language_model:
                               model_provider: ANTHROPIC
                               model_resource: claude-3-5-sonnet-20240620
@@ -232,6 +287,13 @@ service:
             path: /v0/evi/configs/{id}
             method: GET
             auth: true
+            docs: >-
+                Fetches a list of a **Config's** versions.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -270,6 +332,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnPagedConfigs
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -285,6 +349,7 @@ service:
                                 name: Weather Assistant Config
                                 created_on: 1715275452390
                                 modified_on: 1715275452390
+                                evi_version: "2"
                                 prompt:
                                     id: af699d45-2985-42cc-91b9-af9e5da3bac5
                                     version: 0
@@ -302,7 +367,20 @@ service:
                                         Include helpful tips if severe weather is expected.</role>
                                 voice:
                                     provider: HUME_AI
-                                    name: KORA
+                                    name: SAMPLE VOICE
+                                    custom_voice:
+                                        id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                        version: 1
+                                        name: SAMPLE VOICE
+                                        created_on: 1724704587367
+                                        modified_on: 1725489961583
+                                        base_voice: KORA
+                                        parameter_model: 20240715-4parameter
+                                        parameters:
+                                            gender: -7
+                                            huskiness: -2
+                                            nasality: -8
+                                            pitch: -9
                                 language_model:
                                     model_provider: ANTHROPIC
                                     model_resource: claude-3-5-sonnet-20240620
@@ -332,6 +410,13 @@ service:
             path: /v0/evi/configs/{id}
             method: POST
             auth: true
+            docs: >-
+                Updates a **Config** by creating a new version of the **Config**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -341,10 +426,13 @@ service:
                 name: PostedConfigVersion
                 body:
                     properties:
+                        evi_version:
+                            type: string
+                            docs: The version of the EVI used with this config.
                         version_description:
                             type: optional<string>
                             docs: An optional description of the Config version.
-                        prompt: optional<root.PostedPromptSpec>
+                        prompt: optional<root.PostedConfigPromptSpec>
                         voice:
                             type: optional<root.PostedVoice>
                             docs: A voice specification associated with this Config version.
@@ -377,14 +465,18 @@ service:
                             docs: List of built-in tools associated with this Config version.
                         event_messages: optional<root.PostedEventMessageSpecs>
                         timeouts: optional<root.PostedTimeoutSpecs>
+                content-type: application/json
             response:
                 docs: Created
                 type: root.ReturnConfig
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
                   request:
                       version_description: This is an updated version of the Weather Assistant Config.
+                      evi_version: "2"
                       prompt:
                           id: af699d45-2985-42cc-91b9-af9e5da3bac5
                           version: 0
@@ -415,6 +507,7 @@ service:
                           name: Weather Assistant Config
                           created_on: 1715275452390
                           modified_on: 1722642242998
+                          evi_version: "2"
                           prompt:
                               id: af699d45-2985-42cc-91b9-af9e5da3bac5
                               version: 0
@@ -433,6 +526,19 @@ service:
                           voice:
                               provider: HUME_AI
                               name: ITO
+                              custom_voice:
+                                  id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                  version: 1
+                                  name: SAMPLE VOICE
+                                  created_on: 1724704587367
+                                  modified_on: 1725489961583
+                                  base_voice: KORA
+                                  parameter_model: 20240715-4parameter
+                                  parameters:
+                                      gender: -7
+                                      huskiness: -2
+                                      nasality: -8
+                                      pitch: -9
                           language_model:
                               model_provider: ANTHROPIC
                               model_resource: claude-3-5-sonnet-20240620
@@ -462,11 +568,20 @@ service:
             path: /v0/evi/configs/{id}
             method: DELETE
             auth: true
+            docs: >-
+                Deletes a **Config** and its versions.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
                     docs: Identifier for a Config. Formatted as a UUID.
             display-name: Delete config
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -474,6 +589,13 @@ service:
             path: /v0/evi/configs/{id}
             method: PATCH
             auth: true
+            docs: >-
+                Updates the name of a **Config**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -486,9 +608,12 @@ service:
                         name:
                             type: string
                             docs: Name applied to all versions of a particular Config.
+                content-type: application/json
             response:
                 docs: Success
                 type: text
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -498,6 +623,13 @@ service:
             path: /v0/evi/configs/{id}/version/{version}
             method: GET
             auth: true
+            docs: >-
+                Fetches a specified version of a **Config**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -508,7 +640,7 @@ service:
                         Version number for a Config.
 
 
-                        Configs, as well as Prompts and Tools, are versioned. This
+                        Configs, Prompts, Custom Voices, and Tools are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine configurations and revert to previous versions
                         if needed.
@@ -521,6 +653,8 @@ service:
             response:
                 docs: Success
                 type: root.ReturnConfig
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -533,6 +667,7 @@ service:
                           name: Weather Assistant Config
                           created_on: 1715275452390
                           modified_on: 1715275452390
+                          evi_version: "2"
                           prompt:
                               id: af699d45-2985-42cc-91b9-af9e5da3bac5
                               version: 0
@@ -550,7 +685,20 @@ service:
                                   severe weather is expected.</role>
                           voice:
                               provider: HUME_AI
-                              name: KORA
+                              name: SAMPLE VOICE
+                              custom_voice:
+                                  id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                  version: 1
+                                  name: SAMPLE VOICE
+                                  created_on: 1724704587367
+                                  modified_on: 1725489961583
+                                  base_voice: KORA
+                                  parameter_model: 20240715-4parameter
+                                  parameters:
+                                      gender: -7
+                                      huskiness: -2
+                                      nasality: -8
+                                      pitch: -9
                           language_model:
                               model_provider: ANTHROPIC
                               model_resource: claude-3-5-sonnet-20240620
@@ -580,6 +728,13 @@ service:
             path: /v0/evi/configs/{id}/version/{version}
             method: DELETE
             auth: true
+            docs: >-
+                Deletes a specified version of a **Config**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -590,7 +745,7 @@ service:
                         Version number for a Config.
 
 
-                        Configs, as well as Prompts and Tools, are versioned. This
+                        Configs, Prompts, Custom Voices, and Tools are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine configurations and revert to previous versions
                         if needed.
@@ -600,6 +755,8 @@ service:
                         of the Config. Each update to the Config increments its version
                         number.
             display-name: Delete config version
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -608,6 +765,13 @@ service:
             path: /v0/evi/configs/{id}/version/{version}
             method: PATCH
             auth: true
+            docs: >-
+                Updates the description of a **Config**.
+
+
+                For more details on configuration options and how to configure EVI, see
+                our [configuration
+                guide](/docs/empathic-voice-interface-evi/configuration).
             path-parameters:
                 id:
                     type: string
@@ -618,7 +782,7 @@ service:
                         Version number for a Config.
 
 
-                        Configs, as well as Prompts and Tools, are versioned. This
+                        Configs, Prompts, Custom Voices, and Tools are versioned. This
                         versioning system supports iterative development, allowing you to
                         progressively refine configurations and revert to previous versions
                         if needed.
@@ -635,9 +799,12 @@ service:
                         version_description:
                             type: optional<string>
                             docs: An optional description of the Config version.
+                content-type: application/json
             response:
                 docs: Success
                 type: root.ReturnConfig
+            errors:
+                - root.BadRequestError
             examples:
                 - path-parameters:
                       id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
@@ -652,6 +819,7 @@ service:
                           name: Weather Assistant Config
                           created_on: 1715275452390
                           modified_on: 1715275452390
+                          evi_version: "2"
                           prompt:
                               id: af699d45-2985-42cc-91b9-af9e5da3bac5
                               version: 0
@@ -669,7 +837,20 @@ service:
                                   severe weather is expected.</role>
                           voice:
                               provider: HUME_AI
-                              name: KORA
+                              name: SAMPLE VOICE
+                              custom_voice:
+                                  id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
+                                  version: 1
+                                  name: SAMPLE VOICE
+                                  created_on: 1724704587367
+                                  modified_on: 1725489961583
+                                  base_voice: KORA
+                                  parameter_model: 20240715-4parameter
+                                  parameters:
+                                      gender: -7
+                                      huskiness: -2
+                                      nasality: -8
+                                      pitch: -9
                           language_model:
                               model_provider: ANTHROPIC
                               model_resource: claude-3-5-sonnet-20240620
@@ -696,4 +877,4 @@ service:
                                   enabled: true
                                   duration_secs: 1800
     source:
-        openapi: ../empathic-voice-interface/stenographer-openapi.json
+        openapi: stenographer-openapi.json