🌿 Fern Regeneration -- September 26, 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
@@ -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

.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