hume 0.8.6 → 0.8.8

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

@@ -1,142 +1,146 @@
 channel:
-  path: /v0/evi/chat
-  auth: false
-  query-parameters:
-    config_id:
-      type: optional<string>
-      docs: >-
-        The unique identifier for an EVI configuration.
-
-
-        Include this ID in your connection request to equip EVI with the Prompt,
-        Language Model, Voice, and Tools associated with the specified
-        configuration. If omitted, EVI will apply [default configuration
-        settings](/docs/empathic-voice-interface-evi/configuration#default-configuration).
-
-
-        For help obtaining this ID, see our [Configuration
-        Guide](/docs/empathic-voice-interface-evi/configuration).
-    config_version:
-      type: optional<integer>
-      docs: >-
-        The version number of the EVI configuration specified by the
-        `config_id`.
-
-
-        Configs, as well as Prompts and Tools, are versioned. This versioning
-        system supports iterative development, allowing you to progressively
-        refine configurations and revert to previous versions if needed.
-
-
-        Include this parameter to apply a specific version of an EVI
-        configuration. If omitted, the latest version will be applied.
-    resumed_chat_group_id:
-      type: optional<string>
-      docs: >-
-        The unique identifier for a Chat Group. Use this field to preserve
-        context from a previous Chat session.
-
-
-        A Chat represents a single session from opening to closing a WebSocket
-        connection. In contrast, a Chat Group is a series of resumed Chats that
-        collectively represent a single conversation spanning multiple sessions.
-        Each Chat includes a Chat Group ID, which is used to preserve the
-        context of previous Chat sessions when starting a new one.
-
-
-        Including the Chat Group ID in the `resumed_chat_group_id` query
-        parameter is useful for seamlessly resuming a Chat after unexpected
-        network disconnections and for picking up conversations exactly where
-        you left off at a later time. This ensures preserved context across
-        multiple sessions.
-
-
-        There are three ways to obtain the Chat Group ID:
-
-
-        - [Chat
-        Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
-        Upon establishing a WebSocket connection with EVI, the user receives a
-        Chat Metadata message. This message contains a `chat_group_id`, which
-        can be used to resume conversations within this chat group in future
-        sessions.
-
-
-        - [List Chats
-        endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use
-        the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of
-        individual Chat sessions. This endpoint lists all available Chat
-        sessions and their associated Chat Group ID.
-
-
-        - [List Chat Groups
-        endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups):
-        Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
-        of all Chat Groups associated with an API key. This endpoint returns a
-        list of all available chat groups.
-    access_token:
-      type: optional<string>
-      docs: >-
-        Access token used for authenticating the client. If not provided, an
-        `api_key` must be provided to authenticate.
-
-
-        The access token is generated using both an API key and a Secret key,
-        which provides an additional layer of security compared to using just an
-        API key.
-
-
-        For more details, refer to the [Authentication Strategies
-        Guide](/docs/introduction/api-key#authentication-strategies).
-    api_key:
-      type: optional<string>
-      docs: >-
-        API key used for authenticating the client. If not provided, an
-        `access_token` must be provided to authenticate.
-
-
-        For more details, refer to the [Authentication Strategies
-        Guide](/docs/introduction/api-key#authentication-strategies).
-  messages:
-    subscribe:
-      origin: server
-      body: SubscribeEvent
-    publish:
-      origin: client
-      body: PublishEvent
-  examples:
-    - messages:
-        - type: publish
-          body:
-            type: audio_input
-            data: data
-        - type: subscribe
-          body:
-            type: assistant_end
+    path: /v0/evi/chat
+    auth: false
+    query-parameters:
+        config_id:
+            type: optional<string>
+            docs: >-
+                The unique identifier for an EVI configuration.
+
+
+                Include this ID in your connection request to equip EVI with the Prompt,
+                Language Model, Voice, and Tools associated with the specified
+                configuration. If omitted, EVI will apply [default configuration
+                settings](/docs/empathic-voice-interface-evi/configuration#default-configuration).
+
+
+                For help obtaining this ID, see our [Configuration
+                Guide](/docs/empathic-voice-interface-evi/configuration).
+        config_version:
+            type: optional<integer>
+            docs: >-
+                The version number of the EVI configuration specified by the
+                `config_id`.
+
+
+                Configs, as well as Prompts and Tools, are versioned. This versioning
+                system supports iterative development, allowing you to progressively
+                refine configurations and revert to previous versions if needed.
+
+
+                Include this parameter to apply a specific version of an EVI
+                configuration. If omitted, the latest version will be applied.
+        resumed_chat_group_id:
+            type: optional<string>
+            docs: >-
+                The unique identifier for a Chat Group. Use this field to preserve
+                context from a previous Chat session.
+
+
+                A Chat represents a single session from opening to closing a WebSocket
+                connection. In contrast, a Chat Group is a series of resumed Chats that
+                collectively represent a single conversation spanning multiple sessions.
+                Each Chat includes a Chat Group ID, which is used to preserve the
+                context of previous Chat sessions when starting a new one.
+
+
+                Including the Chat Group ID in the `resumed_chat_group_id` query
+                parameter is useful for seamlessly resuming a Chat after unexpected
+                network disconnections and for picking up conversations exactly where
+                you left off at a later time. This ensures preserved context across
+                multiple sessions.
+
+
+                There are three ways to obtain the Chat Group ID:
+
+
+                - [Chat
+                Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
+                Upon establishing a WebSocket connection with EVI, the user receives a
+                Chat Metadata message. This message contains a `chat_group_id`, which
+                can be used to resume conversations within this chat group in future
+                sessions.
+
+
+                - [List Chats
+                endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use
+                the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of
+                individual Chat sessions. This endpoint lists all available Chat
+                sessions and their associated Chat Group ID.
+
+
+                - [List Chat Groups
+                endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups):
+                Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
+                of all Chat Groups associated with an API key. This endpoint returns a
+                list of all available chat groups.
+        access_token:
+            type: optional<string>
+            docs: >-
+                Access token used for authenticating the client. If not provided, an
+                `api_key` must be provided to authenticate.
+
+
+                The access token is generated using both an API key and a Secret key,
+                which provides an additional layer of security compared to using just an
+                API key.
+
+
+                For more details, refer to the [Authentication Strategies
+                Guide](/docs/introduction/api-key#authentication-strategies).
+        api_key:
+            type: optional<string>
+            docs: >-
+                API key used for authenticating the client. If not provided, an
+                `access_token` must be provided to authenticate.
+
+
+                For more details, refer to the [Authentication Strategies
+                Guide](/docs/introduction/api-key#authentication-strategies).
+    messages:
+        subscribe:
+            origin: server
+            body: SubscribeEvent
+        publish:
+            origin: client
+            body: PublishEvent
+    examples:
+        - messages:
+              - type: publish
+                body:
+                    type: audio_input
+                    data: data
+              - type: subscribe
+                body:
+                    type: assistant_end
 imports:
-  root: __package__.yml
+    root: __package__.yml
 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
-  PublishEvent:
-    discriminated: false
-    union:
-      - root.AudioInput
-      - root.SessionSettings
-      - root.UserInput
-      - root.AssistantInput
-      - root.ToolResponseMessage
-      - root.ToolErrorMessage
-      - root.PauseAssistantMessage
-      - root.ResumeAssistantMessage
+    SubscribeEvent:
+        discriminated: false
+        union:
+            - root.AssistantEnd
+            - root.AssistantMessage
+            - root.AudioOutput
+            - root.ChatMetadata
+            - root.WebSocketError
+            - root.UserInterruption
+            - root.UserMessage
+            - root.ToolCallMessage
+            - root.ToolResponseMessage
+            - root.ToolErrorMessage
+        source:
+            openapi: ../empathic-voice-interface/assistant-asyncapi.json
+    PublishEvent:
+        discriminated: false
+        union:
+            - root.AudioInput
+            - root.SessionSettings
+            - root.UserInput
+            - root.AssistantInput
+            - root.ToolResponseMessage
+            - root.ToolErrorMessage
+            - root.PauseAssistantMessage
+            - root.ResumeAssistantMessage
+        source:
+            openapi: ../empathic-voice-interface/assistant-asyncapi.json