🌿 Fern Regeneration -- September 19, 2024

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

@@ -119,28 +119,46 @@ 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
+      - display-name: AssistantEnd
+        type: root.AssistantEnd
+      - display-name: AssistantMessage
+        type: root.AssistantMessage
+      - display-name: AudioOutput
+        type: root.AudioOutput
+      - display-name: ChatMetadata
+        type: root.ChatMetadata
+      - display-name: Error
+        type: root.WebSocketError
+      - display-name: UserInterruption
+        type: root.UserInterruption
+      - display-name: UserMessage
+        type: root.UserMessage
+      - display-name: ToolCallMessage
+        type: root.ToolCallMessage
+      - display-name: ToolResponseMessage
+        type: root.ToolResponseMessage
+      - display-name: ToolErrorMessage
+        type: root.ToolErrorMessage
     source:
       openapi: assistant-asyncapi.json
   PublishEvent:
     discriminated: false
     union:
-      - root.AudioInput
-      - root.SessionSettings
-      - root.UserInput
-      - root.AssistantInput
-      - root.ToolResponseMessage
-      - root.ToolErrorMessage
-      - root.PauseAssistantMessage
-      - root.ResumeAssistantMessage
+      - display-name: AudioInput
+        type: root.AudioInput
+      - display-name: SessionSettings
+        type: root.SessionSettings
+      - display-name: UserInput
+        type: root.UserInput
+      - display-name: AssistantInput
+        type: root.AssistantInput
+      - display-name: ToolResponseMessage
+        type: root.ToolResponseMessage
+      - display-name: ToolErrorMessage
+        type: root.ToolErrorMessage
+      - display-name: PauseAssistantMessage
+        type: root.PauseAssistantMessage
+      - display-name: ResumeAssistantMessage
+        type: root.ResumeAssistantMessage
     source:
       openapi: assistant-asyncapi.json

.mock/definition/empathic-voice/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
@@ -77,6 +78,9 @@ service:
       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

.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
@@ -75,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

.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
@@ -124,6 +131,13 @@ 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
@@ -272,6 +286,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
@@ -388,6 +409,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
@@ -538,6 +566,13 @@ 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
@@ -552,6 +587,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
@@ -578,6 +620,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
@@ -676,6 +725,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
@@ -706,6 +762,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

.mock/definition/empathic-voice/customVoices.yml

@@ -4,13 +4,19 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    getReturnCustomVoicesForUser:
+    list-custom-voices:
       path: /v0/evi/custom_voices
       method: GET
       auth: true
+      docs: >-
+        Fetches a paginated list of **Custom Voices**.
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       display-name: List custom voices
       request:
-        name: GetReturnCustomVoicesForUserRequest
+        name: CustomVoicesListCustomVoicesRequest
         query-parameters:
           page_number:
             type: optional<integer>
@@ -56,10 +62,17 @@ service:
                   base_voice: ITO
                   parameter_model: 20240715-4parameter
                   parameters: {}
-    createNewCustomVoice:
+    create-custom-voice:
       path: /v0/evi/custom_voices
       method: POST
       auth: true
+      docs: >-
+        Creates a **Custom Voice** that can be added to an [EVI
+        configuration](/reference/empathic-voice-interface-evi/configs/create-config).
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       display-name: Create custom voice
       request:
         body: root.PostedCustomVoice
@@ -87,10 +100,16 @@ service:
                 huskiness: 1
                 nasality: 1
                 pitch: 1
-    getReturnCustomVoiceByCustomVoiceId:
+    get-custom-voice:
       path: /v0/evi/custom_voices/{id}
       method: GET
       auth: true
+      docs: >-
+        Fetches a specific **Custom Voice** by ID.
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       path-parameters:
         id:
           type: string
@@ -118,10 +137,17 @@ service:
                 huskiness: 1
                 nasality: 1
                 pitch: 1
-    addNewCustomVoiceVersion:
+    create-custom-voice-version:
       path: /v0/evi/custom_voices/{id}
       method: POST
       auth: true
+      docs: >-
+        Updates a **Custom Voice** by creating a new version of the **Custom
+        Voice**.
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       path-parameters:
         id:
           type: string
@@ -155,10 +181,16 @@ service:
                 huskiness: 1
                 nasality: 1
                 pitch: 1
-    deleteCustomVoice:
+    delete-custom-voice:
       path: /v0/evi/custom_voices/{id}
       method: DELETE
       auth: true
+      docs: >-
+        Deletes a **Custom Voice** and its versions.
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       path-parameters:
         id:
           type: string
@@ -169,10 +201,16 @@ service:
       examples:
         - path-parameters:
             id: id
-    updateCustomVoiceName:
+    update-custom-voice-name:
       path: /v0/evi/custom_voices/{id}
       method: PATCH
       auth: true
+      docs: >-
+        Updates the name of a **Custom Voice**.
+
+
+        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
+        for details on creating a custom voice.
       path-parameters:
         id:
           type: string