🌿 Fern Regeneration -- February 26, 2025 (#236)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: twitchard <[email protected]>

Author: fern-api[bot]

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

@@ -1,5 +1,6 @@
 channel:
   path: /v0/evi/chat
+  url: prod
   auth: false
   query-parameters:
     config_id:
@@ -11,7 +12,7 @@ channel:
         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).
+        settings](/docs/empathic-voice-interface-evi/configuration/build-a-configuration#default-configuration).
 
 
         For help obtaining this ID, see our [Configuration
@@ -76,6 +77,7 @@ channel:
         list of all available chat groups.
     verbose_transcription:
       type: optional<boolean>
+      default: false
       docs: >-
         A flag to enable verbose transcription. Set this query parameter to
         `true` to have unfinalized user transcripts be sent to the client as
@@ -86,6 +88,7 @@ channel:
         denotes whether the message is "interim" or "final."
     access_token:
       type: optional<string>
+      default: ''
       docs: >-
         Access token used for authenticating the client. If not provided, an
         `api_key` must be provided to authenticate.
@@ -100,6 +103,7 @@ channel:
         Guide](/docs/introduction/api-key#authentication-strategies).
     api_key:
       type: optional<string>
+      default: ''
       docs: >-
         API key used for authenticating the client. If not provided, an
         `access_token` must be provided to authenticate.

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

@@ -57,6 +57,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedChatGroups
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -127,6 +128,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedChats
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -153,6 +155,8 @@ service:
                   start_timestamp: 1712334213647
                   end_timestamp: 1712334332571
                   event_count: 0
+                  metadata: null
+                  config: null
               active: false
     list-chat-group-events:
       path: /v0/evi/chat_groups/{id}/events
@@ -203,6 +207,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedEvents
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -580,6 +585,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatGroupPagedAudioReconstructions
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:

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

@@ -1,21 +1,32 @@
 imports:
   root: __package__.yml
 webhooks:
-  chatWebhook:
+  chatEnded:
     method: POST
-    display-name: Chat Webhook
+    display-name: Chat Ended
     headers: {}
-    payload: root.WebhookEvent
+    payload: root.WebhookEventChatEnded
     examples:
       - payload:
-          chat_group_id: chat_group_id
-          chat_id: chat_id
-          start_time: 1
+          chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
+          chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
+          config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
+          event_name: chat_ended
+          end_time: 1716244958546
+          duration_seconds: 180
+          end_reason: USER_ENDED
+    docs: Sent when an EVI chat ends.
+  chatStarted:
+    method: POST
+    display-name: Chat Started
+    headers: {}
+    payload: root.WebhookEventChatStarted
+    examples:
+      - payload:
+          chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
+          chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
+          config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
+          event_name: chat_started
+          start_time: 1716244940648
           chat_start_type: new_chat_group
-    docs: >-
-      Webhook events are JSON payloads to your server during an EVI chat. You
-      can subscribe to specific events, and set which URLs should be notified in
-      the
-      [Config](/reference/empathic-voice-interface-evi/configs/create-config#request.body.webhooks)
-      resource. Read the [Webhook
-      Guide](/docs/empathic-voice-interface-evi/webhooks) for more information.
+    docs: Sent when an EVI chat is started.

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

@@ -55,6 +55,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedChats
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -129,6 +130,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatPagedEvents
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -482,6 +484,7 @@ service:
       response:
         docs: Success
         type: root.ReturnChatAudioReconstruction
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:

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

@@ -54,6 +54,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedConfigs
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -159,7 +160,7 @@ service:
                 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).
+                [guide](/docs/empathic-voice-interface-evi/configuration/evi-version).
             name:
               type: string
               docs: Name applied to all versions of a particular Config.
@@ -205,6 +206,7 @@ service:
       response:
         docs: Created
         type: root.ReturnConfig
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -353,6 +355,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedConfigs
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -501,6 +504,7 @@ service:
       response:
         docs: Created
         type: root.ReturnConfig
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -697,6 +701,7 @@ service:
       response:
         docs: Success
         type: root.ReturnConfig
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -857,6 +862,7 @@ service:
       response:
         docs: Success
         type: root.ReturnConfig
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:

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

@@ -12,8 +12,9 @@ service:
         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.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       display-name: List custom voices
@@ -47,6 +48,7 @@ service:
       response:
         docs: Success
         type: root.ReturnPagedCustomVoices
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -73,8 +75,9 @@ service:
         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.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       display-name: Create custom voice
@@ -84,6 +87,7 @@ service:
       response:
         docs: Created
         type: root.ReturnCustomVoice
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -119,8 +123,9 @@ service:
         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.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       path-parameters:
@@ -131,6 +136,7 @@ service:
       response:
         docs: Success
         type: root.ReturnCustomVoice
+        status-code: 200
       errors:
         - root.BadRequestError
       examples:
@@ -165,8 +171,9 @@ service:
         Voice**.
 
 
-        Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices)
-        for details on creating a custom voice.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       path-parameters:
@@ -180,6 +187,7 @@ service:
       response:
         docs: Created
         type: root.ReturnCustomVoice
+        status-code: 201
       errors:
         - root.BadRequestError
       examples:
@@ -217,8 +225,9 @@ service:
         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.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       path-parameters:
@@ -239,8 +248,9 @@ service:
         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.
+        Refer to our [voices
+        guide](/docs/empathic-voice-interface-evi/configuration/voices) for
+        details on creating a custom voice.
       source:
         openapi: stenographer-openapi.json
       path-parameters:
@@ -262,6 +272,7 @@ service:
       response:
         docs: Success
         type: text
+        status-code: 200
       errors:
         - root.BadRequestError
   source: