hume 0.9.2 → 0.9.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/.mock/definition/api.yml +6 -6
  2. package/.mock/definition/empathic-voice/__package__.yml +2810 -2703
  3. package/.mock/definition/empathic-voice/chat.yml +143 -143
  4. package/.mock/definition/empathic-voice/chatGroups.yml +579 -508
  5. package/.mock/definition/empathic-voice/chats.yml +490 -449
  6. package/.mock/definition/empathic-voice/configs.yml +913 -871
  7. package/.mock/definition/empathic-voice/customVoices.yml +255 -234
  8. package/.mock/definition/empathic-voice/prompts.yml +523 -526
  9. package/.mock/definition/empathic-voice/tools.yml +588 -588
  10. package/.mock/definition/expression-measurement/batch/__package__.yml +1758 -1758
  11. package/.mock/definition/expression-measurement/stream/__package__.yml +486 -485
  12. package/.mock/fern.config.json +3 -3
  13. package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -0
  14. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +77 -3
  15. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +25 -0
  16. package/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
  17. package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +10 -0
  18. package/api/resources/empathicVoice/resources/chats/client/Client.js +63 -2
  19. package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  20. package/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
  21. package/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
  22. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
  23. package/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
  24. package/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
  25. package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  26. package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
  27. package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  28. package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
  29. package/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
  30. package/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
  31. package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
  32. package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
  33. package/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
  34. package/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
  35. package/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
  36. package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
  37. package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
  38. package/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
  39. package/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
  40. package/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
  41. package/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
  42. package/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  43. package/api/resources/empathicVoice/types/index.d.ts +0 -2
  44. package/api/resources/empathicVoice/types/index.js +0 -2
  45. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  46. package/api/resources/index.d.ts +1 -1
  47. package/api/resources/index.js +2 -2
  48. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -0
  49. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +77 -3
  50. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +25 -0
  51. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
  52. package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +10 -0
  53. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +63 -2
  54. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  55. package/dist/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
  56. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
  57. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
  58. package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
  59. package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
  60. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  61. package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
  62. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  63. package/dist/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
  64. package/dist/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
  65. package/dist/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
  66. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
  67. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
  68. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
  69. package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
  70. package/dist/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
  71. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
  72. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
  73. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
  74. package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
  75. package/dist/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
  76. package/dist/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
  77. package/dist/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  78. package/dist/api/resources/empathicVoice/types/index.d.ts +0 -2
  79. package/dist/api/resources/empathicVoice/types/index.js +0 -2
  80. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  81. package/dist/api/resources/index.d.ts +1 -1
  82. package/dist/api/resources/index.js +2 -2
  83. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
  84. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
  85. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
  86. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
  87. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
  88. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
  89. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
  90. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
  91. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
  92. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
  93. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
  94. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
  95. package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
  96. package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  97. package/dist/serialization/resources/empathicVoice/types/index.d.ts +0 -2
  98. package/dist/serialization/resources/empathicVoice/types/index.js +0 -2
  99. package/dist/serialization/resources/index.d.ts +1 -1
  100. package/dist/serialization/resources/index.js +2 -2
  101. package/dist/version.d.ts +1 -1
  102. package/dist/version.js +1 -1
  103. package/package.json +1 -1
  104. package/reference.md +573 -607
  105. package/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
  106. package/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
  107. package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
  108. package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
  109. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
  110. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
  111. package/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
  112. package/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
  113. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
  114. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
  115. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
  116. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
  117. package/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
  118. package/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  119. package/serialization/resources/empathicVoice/types/index.d.ts +0 -2
  120. package/serialization/resources/empathicVoice/types/index.js +0 -2
  121. package/serialization/resources/index.d.ts +1 -1
  122. package/serialization/resources/index.js +2 -2
  123. package/version.d.ts +1 -1
  124. package/version.js +1 -1
  125. package/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
  126. package/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
  127. package/dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
  128. package/dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -5
  129. package/dist/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
  130. package/dist/api/resources/empathicVoice/types/VoiceArgs.js +0 -5
  131. package/dist/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
  132. package/dist/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -36
  133. package/dist/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
  134. package/dist/serialization/resources/empathicVoice/types/VoiceArgs.js +0 -40
  135. package/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
  136. package/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.js +0 -36
  137. package/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
  138. package/serialization/resources/empathicVoice/types/VoiceArgs.js +0 -40
  139. /package/api/resources/empathicVoice/{types/ExtendedVoiceArgs.js → resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
  140. /package/{api/resources/empathicVoice/types/VoiceArgs.js → dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
@@ -1,146 +1,146 @@
1
1
  channel:
2
- path: /v0/evi/chat
3
- auth: false
4
- query-parameters:
5
- config_id:
6
- type: optional<string>
7
- docs: >-
8
- The unique identifier for an EVI configuration.
9
-
10
-
11
- Include this ID in your connection request to equip EVI with the Prompt,
12
- Language Model, Voice, and Tools associated with the specified
13
- configuration. If omitted, EVI will apply [default configuration
14
- settings](/docs/empathic-voice-interface-evi/configuration#default-configuration).
15
-
16
-
17
- For help obtaining this ID, see our [Configuration
18
- Guide](/docs/empathic-voice-interface-evi/configuration).
19
- config_version:
20
- type: optional<integer>
21
- docs: >-
22
- The version number of the EVI configuration specified by the
23
- `config_id`.
24
-
25
-
26
- Configs, as well as Prompts and Tools, are versioned. This versioning
27
- system supports iterative development, allowing you to progressively
28
- refine configurations and revert to previous versions if needed.
29
-
30
-
31
- Include this parameter to apply a specific version of an EVI
32
- configuration. If omitted, the latest version will be applied.
33
- resumed_chat_group_id:
34
- type: optional<string>
35
- docs: >-
36
- The unique identifier for a Chat Group. Use this field to preserve
37
- context from a previous Chat session.
38
-
39
-
40
- A Chat represents a single session from opening to closing a WebSocket
41
- connection. In contrast, a Chat Group is a series of resumed Chats that
42
- collectively represent a single conversation spanning multiple sessions.
43
- Each Chat includes a Chat Group ID, which is used to preserve the
44
- context of previous Chat sessions when starting a new one.
45
-
46
-
47
- Including the Chat Group ID in the `resumed_chat_group_id` query
48
- parameter is useful for seamlessly resuming a Chat after unexpected
49
- network disconnections and for picking up conversations exactly where
50
- you left off at a later time. This ensures preserved context across
51
- multiple sessions.
52
-
53
-
54
- There are three ways to obtain the Chat Group ID:
55
-
56
-
57
- - [Chat
58
- Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
59
- Upon establishing a WebSocket connection with EVI, the user receives a
60
- Chat Metadata message. This message contains a `chat_group_id`, which
61
- can be used to resume conversations within this chat group in future
62
- sessions.
63
-
64
-
65
- - [List Chats
66
- endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use
67
- the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of
68
- individual Chat sessions. This endpoint lists all available Chat
69
- sessions and their associated Chat Group ID.
70
-
71
-
72
- - [List Chat Groups
73
- endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups):
74
- Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
75
- of all Chat Groups associated with an API key. This endpoint returns a
76
- list of all available chat groups.
77
- access_token:
78
- type: optional<string>
79
- docs: >-
80
- Access token used for authenticating the client. If not provided, an
81
- `api_key` must be provided to authenticate.
82
-
83
-
84
- The access token is generated using both an API key and a Secret key,
85
- which provides an additional layer of security compared to using just an
86
- API key.
87
-
88
-
89
- For more details, refer to the [Authentication Strategies
90
- Guide](/docs/introduction/api-key#authentication-strategies).
91
- api_key:
92
- type: optional<string>
93
- docs: >-
94
- API key used for authenticating the client. If not provided, an
95
- `access_token` must be provided to authenticate.
96
-
97
-
98
- For more details, refer to the [Authentication Strategies
99
- Guide](/docs/introduction/api-key#authentication-strategies).
100
- messages:
101
- subscribe:
102
- origin: server
103
- body: SubscribeEvent
104
- publish:
105
- origin: client
106
- body: PublishEvent
107
- examples:
108
- - messages:
109
- - type: publish
110
- body:
111
- type: audio_input
112
- data: data
113
- - type: subscribe
114
- body:
115
- type: assistant_end
2
+ path: /v0/evi/chat
3
+ auth: false
4
+ query-parameters:
5
+ config_id:
6
+ type: optional<string>
7
+ docs: >-
8
+ The unique identifier for an EVI configuration.
9
+
10
+
11
+ Include this ID in your connection request to equip EVI with the Prompt,
12
+ Language Model, Voice, and Tools associated with the specified
13
+ configuration. If omitted, EVI will apply [default configuration
14
+ settings](/docs/empathic-voice-interface-evi/configuration#default-configuration).
15
+
16
+
17
+ For help obtaining this ID, see our [Configuration
18
+ Guide](/docs/empathic-voice-interface-evi/configuration).
19
+ config_version:
20
+ type: optional<integer>
21
+ docs: >-
22
+ The version number of the EVI configuration specified by the
23
+ `config_id`.
24
+
25
+
26
+ Configs, as well as Prompts and Tools, are versioned. This versioning
27
+ system supports iterative development, allowing you to progressively
28
+ refine configurations and revert to previous versions if needed.
29
+
30
+
31
+ Include this parameter to apply a specific version of an EVI
32
+ configuration. If omitted, the latest version will be applied.
33
+ resumed_chat_group_id:
34
+ type: optional<string>
35
+ docs: >-
36
+ The unique identifier for a Chat Group. Use this field to preserve
37
+ context from a previous Chat session.
38
+
39
+
40
+ A Chat represents a single session from opening to closing a WebSocket
41
+ connection. In contrast, a Chat Group is a series of resumed Chats that
42
+ collectively represent a single conversation spanning multiple sessions.
43
+ Each Chat includes a Chat Group ID, which is used to preserve the
44
+ context of previous Chat sessions when starting a new one.
45
+
46
+
47
+ Including the Chat Group ID in the `resumed_chat_group_id` query
48
+ parameter is useful for seamlessly resuming a Chat after unexpected
49
+ network disconnections and for picking up conversations exactly where
50
+ you left off at a later time. This ensures preserved context across
51
+ multiple sessions.
52
+
53
+
54
+ There are three ways to obtain the Chat Group ID:
55
+
56
+
57
+ - [Chat
58
+ Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
59
+ Upon establishing a WebSocket connection with EVI, the user receives a
60
+ Chat Metadata message. This message contains a `chat_group_id`, which
61
+ can be used to resume conversations within this chat group in future
62
+ sessions.
63
+
64
+
65
+ - [List Chats
66
+ endpoint](/reference/empathic-voice-interface-evi/chats/list-chats): Use
67
+ the GET `/v0/evi/chats` endpoint to obtain the Chat Group ID of
68
+ individual Chat sessions. This endpoint lists all available Chat
69
+ sessions and their associated Chat Group ID.
70
+
71
+
72
+ - [List Chat Groups
73
+ endpoint](/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups):
74
+ Use the GET `/v0/evi/chat_groups` endpoint to obtain the Chat Group IDs
75
+ of all Chat Groups associated with an API key. This endpoint returns a
76
+ list of all available chat groups.
77
+ access_token:
78
+ type: optional<string>
79
+ docs: >-
80
+ Access token used for authenticating the client. If not provided, an
81
+ `api_key` must be provided to authenticate.
82
+
83
+
84
+ The access token is generated using both an API key and a Secret key,
85
+ which provides an additional layer of security compared to using just an
86
+ API key.
87
+
88
+
89
+ For more details, refer to the [Authentication Strategies
90
+ Guide](/docs/introduction/api-key#authentication-strategies).
91
+ api_key:
92
+ type: optional<string>
93
+ docs: >-
94
+ API key used for authenticating the client. If not provided, an
95
+ `access_token` must be provided to authenticate.
96
+
97
+
98
+ For more details, refer to the [Authentication Strategies
99
+ Guide](/docs/introduction/api-key#authentication-strategies).
100
+ messages:
101
+ subscribe:
102
+ origin: server
103
+ body: SubscribeEvent
104
+ publish:
105
+ origin: client
106
+ body: PublishEvent
107
+ examples:
108
+ - messages:
109
+ - type: publish
110
+ body:
111
+ type: audio_input
112
+ data: data
113
+ - type: subscribe
114
+ body:
115
+ type: assistant_end
116
116
  imports:
117
- root: __package__.yml
117
+ root: __package__.yml
118
118
  types:
119
- SubscribeEvent:
120
- discriminated: false
121
- union:
122
- - type: root.AssistantEnd
123
- - type: root.AssistantMessage
124
- - type: root.AudioOutput
125
- - type: root.ChatMetadata
126
- - type: root.WebSocketError
127
- - type: root.UserInterruption
128
- - type: root.UserMessage
129
- - type: root.ToolCallMessage
130
- - type: root.ToolResponseMessage
131
- - type: root.ToolErrorMessage
132
- source:
133
- openapi: assistant-asyncapi.json
134
- PublishEvent:
135
- discriminated: false
136
- union:
137
- - type: root.AudioInput
138
- - type: root.SessionSettings
139
- - type: root.UserInput
140
- - type: root.AssistantInput
141
- - type: root.ToolResponseMessage
142
- - type: root.ToolErrorMessage
143
- - type: root.PauseAssistantMessage
144
- - type: root.ResumeAssistantMessage
145
- source:
146
- openapi: assistant-asyncapi.json
119
+ SubscribeEvent:
120
+ discriminated: false
121
+ union:
122
+ - type: root.AssistantEnd
123
+ - type: root.AssistantMessage
124
+ - type: root.AudioOutput
125
+ - type: root.ChatMetadata
126
+ - type: root.WebSocketError
127
+ - type: root.UserInterruption
128
+ - type: root.UserMessage
129
+ - type: root.ToolCallMessage
130
+ - type: root.ToolResponseMessage
131
+ - type: root.ToolErrorMessage
132
+ source:
133
+ openapi: assistant-asyncapi.json
134
+ PublishEvent:
135
+ discriminated: false
136
+ union:
137
+ - type: root.AudioInput
138
+ - type: root.SessionSettings
139
+ - type: root.UserInput
140
+ - type: root.AssistantInput
141
+ - type: root.ToolResponseMessage
142
+ - type: root.ToolErrorMessage
143
+ - type: root.PauseAssistantMessage
144
+ - type: root.ResumeAssistantMessage
145
+ source:
146
+ openapi: assistant-asyncapi.json