🌿 Fern Regeneration -- September 27, 2024

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

@@ -1557,7 +1557,11 @@ types:
       num_chats:
         type: integer
         docs: The total number of Chats in this Chat Group.
-      active: optional<boolean>
+      active:
+        type: optional<boolean>
+        docs: >-
+          Denotes whether there is an active Chat associated with this Chat
+          Group.
     source:
       openapi: stenographer-openapi.json
   ReturnPagedChatGroupsPaginationDirection:
@@ -1615,6 +1619,21 @@ types:
         type: list<ReturnChatGroup>
     source:
       openapi: stenographer-openapi.json
+  ReturnChatGroupPagedChatsPaginationDirection:
+    enum:
+      - ASC
+      - DESC
+    docs: >-
+      Indicates the order in which the paginated results are presented, based on
+      their creation date.
+
+
+      It shows `ASC` for ascending order (chronological, with the oldest records
+      first) or `DESC` for descending order (reverse-chronological, with the
+      newest records first). This value corresponds to the `ascending_order`
+      query parameter used in the request.
+    source:
+      openapi: stenographer-openapi.json
   ReturnChatGroupPagedChats:
     docs: >-
       A description of chat_group and its status with a paginated list of each
@@ -1623,39 +1642,59 @@ types:
       id:
         type: string
         docs: >-
-          Identifier for the chat group. Any chat resumed from this chat will
-          have the same chat_group_id. Formatted as a UUID.
+          Identifier for the Chat Group. Any Chat resumed from this Chat Group
+          will have the same `chat_group_id`. Formatted as a UUID.
       first_start_timestamp:
         type: long
         docs: >-
-          The timestamp when the first chat in this chat group started,
-          formatted as a Unix epoch milliseconds.
+          Time at which the first Chat in this Chat Group was created. Measured
+          in seconds since the Unix epoch.
       most_recent_start_timestamp:
         type: long
         docs: >-
-          The timestamp when the most recent chat in this chat group started,
-          formatted as a Unix epoch milliseconds.
+          Time at which the most recent Chat in this Chat Group was created.
+          Measured in seconds since the Unix epoch.
       num_chats:
         type: integer
-        docs: The total number of chats in this chat group.
+        docs: The total number of Chats associated with this Chat Group.
       page_number:
         type: integer
-        docs: The page number of the returned results.
+        docs: >-
+          The page number of the returned list.
+
+
+          This value corresponds to the `page_number` parameter specified in the
+          request. Pagination uses zero-based indexing.
       page_size:
         type: integer
-        docs: The number of results returned per page.
+        docs: >-
+          The maximum number of items returned per page.
+
+
+          This value corresponds to the `page_size` parameter specified in the
+          request.
       total_pages:
         type: integer
-        docs: The total number of pages in the collection
+        docs: The total number of pages in the collection.
       pagination_direction:
-        type: string
-        docs: The direction of the pagination (ASC or DESC).
-      chats_page:
+        type: ReturnChatGroupPagedChatsPaginationDirection
         docs: >-
-          List of chats and their metadata returned for the specified page
-          number and page size.
+          Indicates the order in which the paginated results are presented,
+          based on their creation date.
+
+
+          It shows `ASC` for ascending order (chronological, with the oldest
+          records first) or `DESC` for descending order (reverse-chronological,
+          with the newest records first). This value corresponds to the
+          `ascending_order` query parameter used in the request.
+      chats_page:
+        docs: List of Chats for the specified `page_number` and `page_size`.
         type: list<ReturnChat>
-      active: optional<boolean>
+      active:
+        type: optional<boolean>
+        docs: >-
+          Denotes whether there is an active Chat associated with this Chat
+          Group.
     source:
       openapi: stenographer-openapi.json
   ReturnChatGroupPagedEventsPaginationDirection:
@@ -1813,7 +1852,8 @@ types:
       built-in Web Search tool.
   BuiltinToolConfig:
     properties:
-      name: BuiltInTool
+      name:
+        type: BuiltInTool
       fallback_content:
         type: optional<string>
         docs: >-
@@ -1866,8 +1906,10 @@ types:
       - temporary
     source:
       openapi: assistant-asyncapi.json
-  Encoding: literal<"linear16">
-  ErrorLevel: literal<"warn">
+  Encoding:
+    type: literal<"linear16">
+  ErrorLevel:
+    type: literal<"warn">
   PauseAssistantMessage:
     docs: >-
       Pause responses from EVI. Chat history is still saved and sent after
@@ -2042,7 +2084,8 @@ types:
           Currently, the only built-in tool Hume provides is **Web Search**.
           When enabled, Web Search equips EVI with the ability to search the web
           for up-to-date information.
-      metadata: optional<map<string, unknown>>
+      metadata:
+        type: optional<map<string, unknown>>
       variables:
         type: optional<map<string, string>>
         docs: Dynamic values that can be used to populate EVI prompts.
@@ -2305,8 +2348,8 @@ types:
     discriminated: false
     docs: Function call response from client.
     union:
-      - ToolResponseMessage
-      - ToolErrorMessage
+      - type: ToolResponseMessage
+      - type: ToolErrorMessage
     source:
       openapi: assistant-asyncapi.json
   ChatMessage:
@@ -2625,15 +2668,15 @@ types:
   JsonMessage:
     discriminated: false
     union:
-      - AssistantEnd
-      - AssistantMessage
-      - ChatMetadata
-      - WebSocketError
-      - UserInterruption
-      - UserMessage
-      - ToolCallMessage
-      - ToolResponseMessage
-      - ToolErrorMessage
+      - type: AssistantEnd
+      - type: AssistantMessage
+      - type: ChatMetadata
+      - type: WebSocketError
+      - type: UserInterruption
+      - type: UserMessage
+      - type: ToolCallMessage
+      - type: ToolResponseMessage
+      - type: ToolErrorMessage
     source:
       openapi: assistant-asyncapi.json
   TtsInput:
@@ -2654,12 +2697,14 @@ types:
   ExtendedVoiceArgs:
     properties:
       text: string
-      voice_args: VoiceArgs
+      voice_args:
+        type: VoiceArgs
     source:
       openapi: assistant-openapi.json
   HTTPValidationError:
     properties:
-      detail: optional<list<ValidationError>>
+      detail:
+        type: optional<list<ValidationError>>
     source:
       openapi: assistant-openapi.json
   ValidationErrorLocItem:
@@ -2671,14 +2716,16 @@ types:
       openapi: assistant-openapi.json
   ValidationError:
     properties:
-      loc: list<ValidationErrorLocItem>
+      loc:
+        type: list<ValidationErrorLocItem>
       msg: string
       type: string
     source:
       openapi: assistant-openapi.json
   VoiceArgs:
     properties:
-      voice: optional<VoiceNameEnum>
+      voice:
+        type: optional<VoiceNameEnum>
       baseline:
         type: optional<boolean>
         default: false

.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: 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: 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
@@ -73,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

.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