hume 0.11.0 → 0.11.2

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 (242) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +39 -36
  2. package/.mock/definition/empathic-voice/chat.yml +18 -3
  3. package/.mock/definition/empathic-voice/chatGroups.yml +14 -10
  4. package/.mock/definition/empathic-voice/chatWebhooks.yml +2 -0
  5. package/.mock/definition/empathic-voice/chats.yml +2 -0
  6. package/.mock/definition/empathic-voice/configs.yml +4 -0
  7. package/.mock/definition/empathic-voice/customVoices.yml +1 -0
  8. package/.mock/definition/empathic-voice/prompts.yml +2 -0
  9. package/.mock/definition/empathic-voice/tools.yml +2 -0
  10. package/.mock/definition/expression-measurement/batch/__package__.yml +10 -10
  11. package/.mock/definition/expression-measurement/stream/stream.yml +1 -1
  12. package/.mock/definition/tts/__package__.yml +98 -55
  13. package/.mock/definition/tts/voices.yml +20 -9
  14. package/.mock/fern.config.json +1 -1
  15. package/Client.d.ts +11 -7
  16. package/Client.js +54 -6
  17. package/api/resources/empathicVoice/errors/BadRequestError.d.ts +2 -1
  18. package/api/resources/empathicVoice/errors/BadRequestError.js +2 -1
  19. package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +4 -2
  20. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +76 -42
  21. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +4 -4
  22. package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +2 -1
  23. package/api/resources/empathicVoice/resources/chats/client/Client.js +57 -32
  24. package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +14 -7
  25. package/api/resources/empathicVoice/resources/configs/client/Client.js +136 -66
  26. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -0
  27. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +1 -0
  28. package/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +10 -5
  29. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +89 -42
  30. package/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +16 -8
  31. package/api/resources/empathicVoice/resources/prompts/client/Client.js +134 -63
  32. package/api/resources/empathicVoice/resources/tools/client/Client.d.ts +14 -7
  33. package/api/resources/empathicVoice/resources/tools/client/Client.js +136 -66
  34. package/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  35. package/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  36. package/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  37. package/api/resources/empathicVoice/types/PostedNudgeSpec.d.ts +12 -0
  38. package/api/resources/empathicVoice/types/ReturnConfig.d.ts +1 -0
  39. package/api/resources/empathicVoice/types/ReturnNudgeSpec.d.ts +12 -0
  40. package/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  41. package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  42. package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  43. package/api/resources/empathicVoice/types/UserInput.d.ts +1 -1
  44. package/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  45. package/api/resources/empathicVoice/types/WebhookEventChatStatus.d.ts +2 -1
  46. package/api/resources/empathicVoice/types/WebhookEventChatStatus.js +1 -0
  47. package/api/resources/empathicVoice/types/index.d.ts +2 -4
  48. package/api/resources/empathicVoice/types/index.js +2 -4
  49. package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +12 -6
  50. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +89 -38
  51. package/api/resources/tts/client/Client.d.ts +28 -22
  52. package/api/resources/tts/client/Client.js +88 -50
  53. package/api/resources/tts/client/index.d.ts +1 -1
  54. package/api/resources/tts/client/index.js +15 -0
  55. package/api/resources/tts/client/requests/SynthesizeJsonRequest.d.ts +36 -0
  56. package/api/resources/tts/client/requests/index.d.ts +1 -0
  57. package/api/resources/tts/client/requests/index.js +2 -0
  58. package/api/resources/tts/errors/BadRequestError.d.ts +2 -1
  59. package/api/resources/tts/errors/BadRequestError.js +2 -1
  60. package/api/resources/tts/errors/UnprocessableEntityError.d.ts +2 -1
  61. package/api/resources/tts/errors/UnprocessableEntityError.js +2 -1
  62. package/api/resources/tts/resources/voices/client/Client.d.ts +9 -5
  63. package/api/resources/tts/resources/voices/client/Client.js +51 -26
  64. package/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +4 -1
  65. package/api/resources/tts/types/PostedTts.d.ts +6 -6
  66. package/api/resources/tts/types/PostedUtterance.d.ts +5 -5
  67. package/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +6 -7
  68. package/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +6 -7
  69. package/api/resources/tts/types/ReturnGeneration.d.ts +1 -1
  70. package/api/resources/tts/types/ReturnTts.d.ts +1 -1
  71. package/api/resources/tts/types/ReturnVoice.d.ts +2 -8
  72. package/api/resources/tts/types/Snippet.d.ts +2 -0
  73. package/api/resources/tts/types/SnippetAudioChunk.d.ts +2 -0
  74. package/core/fetcher/APIResponse.d.ts +10 -0
  75. package/core/fetcher/Fetcher.js +7 -0
  76. package/core/fetcher/Headers.d.ts +2 -0
  77. package/core/fetcher/Headers.js +84 -0
  78. package/core/fetcher/HttpResponsePromise.d.ts +58 -0
  79. package/core/fetcher/HttpResponsePromise.js +103 -0
  80. package/core/fetcher/RawResponse.d.ts +29 -0
  81. package/core/fetcher/RawResponse.js +44 -0
  82. package/core/fetcher/index.d.ts +3 -0
  83. package/core/fetcher/index.js +7 -1
  84. package/core/form-data-utils/FormDataWrapper.d.ts +3 -0
  85. package/core/form-data-utils/FormDataWrapper.js +48 -9
  86. package/core/pagination/Page.d.ts +5 -2
  87. package/core/pagination/Page.js +5 -2
  88. package/core/pagination/Pageable.d.ts +2 -0
  89. package/dist/Client.d.ts +11 -7
  90. package/dist/Client.js +54 -6
  91. package/dist/api/resources/empathicVoice/errors/BadRequestError.d.ts +2 -1
  92. package/dist/api/resources/empathicVoice/errors/BadRequestError.js +2 -1
  93. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +4 -2
  94. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +76 -42
  95. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +4 -4
  96. package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +2 -1
  97. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +57 -32
  98. package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +14 -7
  99. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +136 -66
  100. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -0
  101. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +1 -0
  102. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +10 -5
  103. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +89 -42
  104. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +16 -8
  105. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +134 -63
  106. package/dist/api/resources/empathicVoice/resources/tools/client/Client.d.ts +14 -7
  107. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +136 -66
  108. package/dist/api/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
  109. package/dist/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  110. package/dist/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
  111. package/dist/api/resources/empathicVoice/types/PostedNudgeSpec.d.ts +12 -0
  112. package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +1 -0
  113. package/dist/api/resources/empathicVoice/types/ReturnNudgeSpec.d.ts +12 -0
  114. package/dist/api/resources/empathicVoice/types/ToolCallMessage.d.ts +1 -1
  115. package/dist/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +2 -2
  116. package/dist/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -3
  117. package/dist/api/resources/empathicVoice/types/UserInput.d.ts +1 -1
  118. package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +3 -3
  119. package/dist/api/resources/empathicVoice/types/WebhookEventChatStatus.d.ts +2 -1
  120. package/dist/api/resources/empathicVoice/types/WebhookEventChatStatus.js +1 -0
  121. package/dist/api/resources/empathicVoice/types/index.d.ts +2 -4
  122. package/dist/api/resources/empathicVoice/types/index.js +2 -4
  123. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +12 -6
  124. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +89 -38
  125. package/dist/api/resources/tts/client/Client.d.ts +28 -22
  126. package/dist/api/resources/tts/client/Client.js +88 -50
  127. package/dist/api/resources/tts/client/index.d.ts +1 -1
  128. package/dist/api/resources/tts/client/index.js +15 -0
  129. package/dist/api/resources/tts/client/requests/SynthesizeJsonRequest.d.ts +36 -0
  130. package/dist/api/resources/tts/client/requests/index.d.ts +1 -0
  131. package/dist/api/resources/tts/client/requests/index.js +2 -0
  132. package/dist/api/resources/tts/errors/BadRequestError.d.ts +2 -1
  133. package/dist/api/resources/tts/errors/BadRequestError.js +2 -1
  134. package/dist/api/resources/tts/errors/UnprocessableEntityError.d.ts +2 -1
  135. package/dist/api/resources/tts/errors/UnprocessableEntityError.js +2 -1
  136. package/dist/api/resources/tts/resources/voices/client/Client.d.ts +9 -5
  137. package/dist/api/resources/tts/resources/voices/client/Client.js +51 -26
  138. package/dist/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +4 -1
  139. package/dist/api/resources/tts/types/PostedTts.d.ts +6 -6
  140. package/dist/api/resources/tts/types/PostedUtterance.d.ts +5 -5
  141. package/dist/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +6 -7
  142. package/dist/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +6 -7
  143. package/dist/api/resources/tts/types/ReturnGeneration.d.ts +1 -1
  144. package/dist/api/resources/tts/types/ReturnTts.d.ts +1 -1
  145. package/dist/api/resources/tts/types/ReturnVoice.d.ts +2 -8
  146. package/dist/api/resources/tts/types/Snippet.d.ts +2 -0
  147. package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +2 -0
  148. package/dist/core/fetcher/APIResponse.d.ts +10 -0
  149. package/dist/core/fetcher/Fetcher.js +7 -0
  150. package/dist/core/fetcher/Headers.d.ts +2 -0
  151. package/dist/core/fetcher/Headers.js +84 -0
  152. package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
  153. package/dist/core/fetcher/HttpResponsePromise.js +103 -0
  154. package/dist/core/fetcher/RawResponse.d.ts +29 -0
  155. package/dist/core/fetcher/RawResponse.js +44 -0
  156. package/dist/core/fetcher/index.d.ts +3 -0
  157. package/dist/core/fetcher/index.js +7 -1
  158. package/dist/core/form-data-utils/FormDataWrapper.d.ts +3 -0
  159. package/dist/core/form-data-utils/FormDataWrapper.js +48 -9
  160. package/dist/core/pagination/Page.d.ts +5 -2
  161. package/dist/core/pagination/Page.js +5 -2
  162. package/dist/core/pagination/Pageable.d.ts +2 -0
  163. package/dist/errors/HumeError.d.ts +7 -2
  164. package/dist/errors/HumeError.js +10 -10
  165. package/dist/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -0
  166. package/dist/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.js +2 -0
  167. package/dist/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -0
  168. package/dist/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.js +2 -0
  169. package/dist/serialization/resources/empathicVoice/types/PostedNudgeSpec.d.ts +13 -0
  170. package/dist/serialization/resources/empathicVoice/types/{TextInput.js → PostedNudgeSpec.js} +4 -3
  171. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +2 -0
  172. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.js +2 -0
  173. package/dist/serialization/resources/empathicVoice/types/ReturnNudgeSpec.d.ts +13 -0
  174. package/dist/serialization/resources/empathicVoice/types/{FunctionCallResponseInput.js → ReturnNudgeSpec.js} +4 -3
  175. package/dist/serialization/resources/empathicVoice/types/WebhookEventChatStatus.d.ts +1 -1
  176. package/dist/serialization/resources/empathicVoice/types/WebhookEventChatStatus.js +1 -0
  177. package/dist/serialization/resources/empathicVoice/types/index.d.ts +2 -4
  178. package/dist/serialization/resources/empathicVoice/types/index.js +2 -4
  179. package/dist/serialization/resources/tts/types/Snippet.d.ts +1 -0
  180. package/dist/serialization/resources/tts/types/Snippet.js +1 -0
  181. package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +1 -0
  182. package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +1 -0
  183. package/dist/version.d.ts +1 -1
  184. package/dist/version.js +1 -1
  185. package/dist/wrapper/expressionMeasurement/ExpressionMeasurementClient.js +2 -0
  186. package/dist/wrapper/expressionMeasurement/batch/BatchClient.d.ts +2 -1
  187. package/dist/wrapper/expressionMeasurement/batch/BatchClient.js +43 -17
  188. package/errors/HumeError.d.ts +7 -2
  189. package/errors/HumeError.js +10 -10
  190. package/package.json +3 -2
  191. package/reference.md +26 -22
  192. package/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -0
  193. package/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.js +2 -0
  194. package/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -0
  195. package/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.js +2 -0
  196. package/serialization/resources/empathicVoice/types/PostedNudgeSpec.d.ts +13 -0
  197. package/{dist/serialization/resources/empathicVoice/types/TtsInput.js → serialization/resources/empathicVoice/types/PostedNudgeSpec.js} +4 -3
  198. package/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +2 -0
  199. package/serialization/resources/empathicVoice/types/ReturnConfig.js +2 -0
  200. package/serialization/resources/empathicVoice/types/ReturnNudgeSpec.d.ts +13 -0
  201. package/{dist/serialization/resources/empathicVoice/types/PostedPromptSpec.js → serialization/resources/empathicVoice/types/ReturnNudgeSpec.js} +4 -3
  202. package/serialization/resources/empathicVoice/types/WebhookEventChatStatus.d.ts +1 -1
  203. package/serialization/resources/empathicVoice/types/WebhookEventChatStatus.js +1 -0
  204. package/serialization/resources/empathicVoice/types/index.d.ts +2 -4
  205. package/serialization/resources/empathicVoice/types/index.js +2 -4
  206. package/serialization/resources/tts/types/Snippet.d.ts +1 -0
  207. package/serialization/resources/tts/types/Snippet.js +1 -0
  208. package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +1 -0
  209. package/serialization/resources/tts/types/SnippetAudioChunk.js +1 -0
  210. package/version.d.ts +1 -1
  211. package/version.js +1 -1
  212. package/wrapper/expressionMeasurement/ExpressionMeasurementClient.js +2 -0
  213. package/wrapper/expressionMeasurement/batch/BatchClient.d.ts +2 -1
  214. package/wrapper/expressionMeasurement/batch/BatchClient.js +43 -17
  215. package/api/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -6
  216. package/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -9
  217. package/api/resources/empathicVoice/types/TextInput.d.ts +0 -6
  218. package/api/resources/empathicVoice/types/TtsInput.d.ts +0 -6
  219. package/dist/api/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -6
  220. package/dist/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -9
  221. package/dist/api/resources/empathicVoice/types/TextInput.d.ts +0 -6
  222. package/dist/api/resources/empathicVoice/types/TextInput.js +0 -5
  223. package/dist/api/resources/empathicVoice/types/TtsInput.d.ts +0 -6
  224. package/dist/api/resources/empathicVoice/types/TtsInput.js +0 -5
  225. package/dist/serialization/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -12
  226. package/dist/serialization/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -12
  227. package/dist/serialization/resources/empathicVoice/types/TextInput.d.ts +0 -12
  228. package/dist/serialization/resources/empathicVoice/types/TtsInput.d.ts +0 -12
  229. package/serialization/resources/empathicVoice/types/FunctionCallResponseInput.d.ts +0 -12
  230. package/serialization/resources/empathicVoice/types/FunctionCallResponseInput.js +0 -43
  231. package/serialization/resources/empathicVoice/types/PostedPromptSpec.d.ts +0 -12
  232. package/serialization/resources/empathicVoice/types/PostedPromptSpec.js +0 -43
  233. package/serialization/resources/empathicVoice/types/TextInput.d.ts +0 -12
  234. package/serialization/resources/empathicVoice/types/TextInput.js +0 -43
  235. package/serialization/resources/empathicVoice/types/TtsInput.d.ts +0 -12
  236. package/serialization/resources/empathicVoice/types/TtsInput.js +0 -43
  237. /package/api/resources/empathicVoice/types/{FunctionCallResponseInput.js → PostedNudgeSpec.js} +0 -0
  238. /package/api/resources/empathicVoice/types/{PostedPromptSpec.js → ReturnNudgeSpec.js} +0 -0
  239. /package/api/resources/{empathicVoice/types/TextInput.js → tts/client/requests/SynthesizeJsonRequest.js} +0 -0
  240. /package/{api/resources/empathicVoice/types/TtsInput.js → dist/api/resources/empathicVoice/types/PostedNudgeSpec.js} +0 -0
  241. /package/dist/api/resources/empathicVoice/types/{FunctionCallResponseInput.js → ReturnNudgeSpec.js} +0 -0
  242. /package/dist/api/resources/{empathicVoice/types/PostedPromptSpec.js → tts/client/requests/SynthesizeJsonRequest.js} +0 -0
@@ -46,7 +46,7 @@ types:
46
46
  inflections and tones to the text based on the user’s expressions and
47
47
  the context of the conversation. The synthesized audio is streamed
48
48
  back to the user as an [Assistant
49
- Message](/reference/empathic-voice-interface-evi/chat/chat#receive.Assistant%20Message.type).
49
+ Message](/reference/empathic-voice-interface-evi/chat/chat#receive.AssistantMessage.type).
50
50
  type:
51
51
  type: literal<"assistant_input">
52
52
  docs: >-
@@ -68,7 +68,7 @@ types:
68
68
  docs: >-
69
69
  Indicates if this message was inserted into the conversation as text
70
70
  from an [Assistant Input
71
- message](/reference/empathic-voice-interface-evi/chat/chat#send.Assistant%20Input.text).
71
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.AssistantInput.text).
72
72
  id:
73
73
  type: optional<string>
74
74
  docs: >-
@@ -443,7 +443,7 @@ types:
443
443
 
444
444
  Once this message is sent, EVI will not respond until a [Resume
445
445
  Assistant
446
- message](/reference/empathic-voice-interface-evi/chat/chat#send.Resume%20Assistant%20Message.type)
446
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.ResumeAssistantMessage.type)
447
447
  is sent. When paused, EVI won’t respond, but transcriptions of your
448
448
  audio inputs will still be recorded.
449
449
  source:
@@ -710,9 +710,9 @@ types:
710
710
  docs: >-
711
711
  Indicates whether a response to the tool call is required from the
712
712
  developer, either in the form of a [Tool Response
713
- message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Response%20Message.type)
713
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolResponseMessage.type)
714
714
  or a [Tool Error
715
- message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Error%20Message.type).
715
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.ToolErrorMessage.type).
716
716
  tool_call_id:
717
717
  type: string
718
718
  docs: >-
@@ -773,7 +773,7 @@ types:
773
773
  invocation, ensuring that the Tool Error message is linked to the
774
774
  appropriate tool call request. The specified `tool_call_id` must match
775
775
  the one received in the [Tool Call
776
- message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type).
776
+ message](/reference/empathic-voice-interface-evi/chat/chat#receive.ToolCallMessage.type).
777
777
  tool_type:
778
778
  type: optional<ToolType>
779
779
  docs: >-
@@ -787,7 +787,7 @@ types:
787
787
 
788
788
 
789
789
  Upon receiving a [Tool Call
790
- message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type)
790
+ message](/reference/empathic-voice-interface-evi/chat/chat#receive.ToolCallMessage.type)
791
791
  and failing to invoke the function, this message is sent to notify EVI
792
792
  of the tool's failure.
793
793
  source:
@@ -815,7 +815,7 @@ types:
815
815
  invocation, ensuring that the correct response is linked to the
816
816
  appropriate request. The specified `tool_call_id` must match the one
817
817
  received in the [Tool Call
818
- message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.tool_call_id).
818
+ message](/reference/empathic-voice-interface-evi/chat/chat#receive.ToolCallMessage.tool_call_id).
819
819
  tool_name:
820
820
  type: optional<string>
821
821
  docs: >-
@@ -825,7 +825,7 @@ types:
825
825
  Include this optional field to help the supplemental LLM identify
826
826
  which tool generated the response. The specified `tool_name` must
827
827
  match the one received in the [Tool Call
828
- message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type).
828
+ message](/reference/empathic-voice-interface-evi/chat/chat#receive.ToolCallMessage.type).
829
829
  tool_type:
830
830
  type: optional<ToolType>
831
831
  docs: >-
@@ -839,7 +839,7 @@ types:
839
839
 
840
840
 
841
841
  Upon receiving a [Tool Call
842
- message](/reference/empathic-voice-interface-evi/chat/chat#receive.Tool%20Call%20Message.type)
842
+ message](/reference/empathic-voice-interface-evi/chat/chat#receive.ToolCallMessage.type)
843
843
  and successfully invoking the function, this message is sent to convey
844
844
  the result of the function call back to EVI.
845
845
  source:
@@ -853,7 +853,7 @@ types:
853
853
  UserInput:
854
854
  docs: >-
855
855
  User text to insert into the conversation. Text sent through a User Input
856
- message is treated as the users speech to EVI. EVI processes this input
856
+ message is treated as the user's speech to EVI. EVI processes this input
857
857
  and provides a corresponding response.
858
858
 
859
859
 
@@ -922,7 +922,7 @@ types:
922
922
  docs: >-
923
923
  Indicates if this message was inserted into the conversation as text
924
924
  from a [User
925
- Input](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.text)
925
+ Input](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.text)
926
926
  message.
927
927
  interim:
928
928
  type: boolean
@@ -934,7 +934,7 @@ types:
934
934
  context. Interim messages are useful to detect if the user is
935
935
  interrupting during audio playback on the client. Even without a
936
936
  finalized transcription, along with
937
- [UserInterrupt](/reference/empathic-voice-interface-evi/chat/chat#receive.User%20Interruption.type)
937
+ [UserInterrupt](/reference/empathic-voice-interface-evi/chat/chat#receive.UserInterruption.type)
938
938
  messages, interim `UserMessages` are useful for detecting if the user
939
939
  is interrupting during audio playback on the client, signaling to stop
940
940
  playback in your application. Interim `UserMessages` will only be
@@ -960,9 +960,9 @@ types:
960
960
  This message contains both a transcript of the user’s input and the
961
961
  expression measurement predictions if the input was sent as an [Audio
962
962
  Input
963
- message](/reference/empathic-voice-interface-evi/chat/chat#send.Audio%20Input.type).
963
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.AudioInput.type).
964
964
  Expression measurement predictions are not provided for a [User Input
965
- message](/reference/empathic-voice-interface-evi/chat/chat#send.User%20Input.type),
965
+ message](/reference/empathic-voice-interface-evi/chat/chat#send.UserInput.type),
966
966
  as the prosody model relies on audio input and cannot process text
967
967
  alone.
968
968
  source:
@@ -981,21 +981,6 @@ types:
981
981
  - type: ToolErrorMessage
982
982
  source:
983
983
  openapi: evi-asyncapi.json
984
- TtsInput:
985
- properties:
986
- type: optional<literal<"tts">>
987
- source:
988
- openapi: evi-asyncapi.json
989
- TextInput:
990
- properties:
991
- type: optional<literal<"text_input">>
992
- source:
993
- openapi: evi-asyncapi.json
994
- FunctionCallResponseInput:
995
- properties:
996
- type: optional<literal<"function_call_response">>
997
- source:
998
- openapi: evi-asyncapi.json
999
984
  HTTPValidationError:
1000
985
  properties:
1001
986
  detail:
@@ -1197,6 +1182,7 @@ types:
1197
1182
  - USER_TIMEOUT
1198
1183
  - INACTIVITY_TIMEOUT
1199
1184
  - MAX_DURATION_TIMEOUT
1185
+ - SILENCE_TIMEOUT
1200
1186
  - ERROR
1201
1187
  source:
1202
1188
  openapi: evi-openapi.json
@@ -1884,6 +1870,7 @@ types:
1884
1870
  docs: List of built-in tools associated with this Config.
1885
1871
  event_messages: optional<ReturnEventMessageSpecs>
1886
1872
  timeouts: optional<ReturnTimeoutSpecs>
1873
+ nudges: optional<ReturnNudgeSpec>
1887
1874
  webhooks:
1888
1875
  type: optional<list<optional<ReturnWebhookSpec>>>
1889
1876
  docs: Map of webhooks associated with this config.
@@ -2579,6 +2566,17 @@ types:
2579
2566
  the time limit for the chat has been reached.
2580
2567
  source:
2581
2568
  openapi: evi-openapi.json
2569
+ PostedNudgeSpec:
2570
+ docs: A nudge specification posted to the server
2571
+ properties:
2572
+ enabled:
2573
+ type: optional<boolean>
2574
+ docs: EVI will nudge user after inactivity
2575
+ interval_secs:
2576
+ type: optional<integer>
2577
+ docs: Time interval in seconds after which the nudge will be sent.
2578
+ source:
2579
+ openapi: evi-openapi.json
2582
2580
  PostedTimeoutSpecsInactivity:
2583
2581
  docs: >-
2584
2582
  Specifies the duration of user inactivity (in seconds) after which the EVI
@@ -2830,6 +2828,17 @@ types:
2830
2828
  seconds.
2831
2829
  source:
2832
2830
  openapi: evi-openapi.json
2831
+ ReturnNudgeSpec:
2832
+ docs: A specific nudge configuration returned from the server
2833
+ properties:
2834
+ enabled:
2835
+ type: boolean
2836
+ docs: EVI will nudge user after inactivity
2837
+ interval_secs:
2838
+ type: optional<integer>
2839
+ docs: Time interval in seconds after which the nudge will be sent.
2840
+ source:
2841
+ openapi: evi-openapi.json
2833
2842
  ReturnWebhookEventType:
2834
2843
  enum:
2835
2844
  - chat_started
@@ -3204,12 +3213,6 @@ types:
3204
3213
  minutes).
3205
3214
  source:
3206
3215
  openapi: evi-openapi.json
3207
- PostedPromptSpec:
3208
- docs: A Prompt associated with this Config.
3209
- properties:
3210
- version: optional<unknown>
3211
- source:
3212
- openapi: evi-openapi.json
3213
3216
  PostedVoiceProvider:
3214
3217
  enum:
3215
3218
  - HUME_AI
@@ -47,6 +47,21 @@ channel:
47
47
 
48
48
  Include this parameter to apply a specific version of an EVI
49
49
  configuration. If omitted, the latest version will be applied.
50
+ enable_context_injection:
51
+ type: optional<boolean>
52
+ default: true
53
+ docs: >-
54
+ A flag to enable context injection. Set this query parameter to true to
55
+ have EVI inject context into the conversation. This is useful for
56
+ scenarios where you want to provide additional information to EVI to
57
+ help it better understand the user's request.
58
+ event_limit:
59
+ type: optional<integer>
60
+ docs: >-
61
+ The maximum number of chat events to return from chat history. By
62
+ default, the system returns up to 300 events (100 events per page × 3
63
+ pages). Set this parameter to a smaller value to limit the number of
64
+ events returned.
50
65
  resumed_chat_group_id:
51
66
  type: optional<string>
52
67
  docs: >-
@@ -72,7 +87,7 @@ channel:
72
87
 
73
88
 
74
89
  - [Chat
75
- Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.Chat%20Metadata.type):
90
+ Metadata](/reference/empathic-voice-interface-evi/chat/chat#receive.ChatMetadata.type):
76
91
  Upon establishing a WebSocket connection with EVI, the user receives a
77
92
  Chat Metadata message. This message contains a `chat_group_id`, which
78
93
  can be used to resume conversations within this chat group in future
@@ -98,9 +113,9 @@ channel:
98
113
  A flag to enable verbose transcription. Set this query parameter to
99
114
  `true` to have unfinalized user transcripts be sent to the client as
100
115
  interim UserMessage messages. The
101
- [interim](/reference/empathic-voice-interface-evi/chat/chat#receive.User%20Message.interim)
116
+ [interim](/reference/empathic-voice-interface-evi/chat/chat#receive.UserMessage.interim)
102
117
  field on a
103
- [UserMessage](/reference/empathic-voice-interface-evi/chat/chat#receive.User%20Message.type)
118
+ [UserMessage](/reference/empathic-voice-interface-evi/chat/chat#receive.UserMessage.type)
104
119
  denotes whether the message is "interim" or "final."
105
120
  api_key:
106
121
  type: optional<string>
@@ -20,6 +20,7 @@ service:
20
20
  query-parameters:
21
21
  page_number:
22
22
  type: optional<integer>
23
+ default: 0
23
24
  docs: >-
24
25
  Specifies the page number to retrieve, enabling pagination.
25
26
 
@@ -111,6 +112,7 @@ service:
111
112
  up to 10 items. Defaults to 10.
112
113
  page_number:
113
114
  type: optional<integer>
115
+ default: 0
114
116
  docs: >-
115
117
  Specifies the page number to retrieve, enabling pagination.
116
118
 
@@ -193,6 +195,7 @@ service:
193
195
  up to 10 items. Defaults to 10.
194
196
  page_number:
195
197
  type: optional<integer>
198
+ default: 0
196
199
  docs: >-
197
200
  Specifies the page number to retrieve, enabling pagination.
198
201
 
@@ -561,16 +564,7 @@ service:
561
564
  query-parameters:
562
565
  page_number:
563
566
  type: optional<integer>
564
- docs: >-
565
- Specifies the maximum number of results to include per page,
566
- enabling pagination. The value must be between 1 and 100,
567
- inclusive.
568
-
569
-
570
- For example, if `page_size` is set to 10, each page will include
571
- up to 10 items. Defaults to 10.
572
- page_size:
573
- type: optional<integer>
567
+ default: 0
574
568
  docs: >-
575
569
  Specifies the page number to retrieve, enabling pagination.
576
570
 
@@ -580,6 +574,16 @@ service:
580
574
  if `page_size` is 10), setting `page_number` to 1 retrieves the
581
575
  second page (items 10-19), and so on. Defaults to 0, which
582
576
  retrieves the first page.
577
+ page_size:
578
+ type: optional<integer>
579
+ docs: >-
580
+ Specifies the maximum number of results to include per page,
581
+ enabling pagination. The value must be between 1 and 100,
582
+ inclusive.
583
+
584
+
585
+ For example, if `page_size` is set to 10, each page will include
586
+ up to 10 items. Defaults to 10.
583
587
  ascending_order:
584
588
  type: optional<boolean>
585
589
  docs: >-
@@ -2,6 +2,7 @@ imports:
2
2
  root: __package__.yml
3
3
  webhooks:
4
4
  chatEnded:
5
+ audiences: []
5
6
  method: POST
6
7
  display-name: Chat Ended
7
8
  headers: {}
@@ -17,6 +18,7 @@ webhooks:
17
18
  event_name: chat_ended
18
19
  docs: Sent when an EVI chat ends.
19
20
  chatStarted:
21
+ audiences: []
20
22
  method: POST
21
23
  display-name: Chat Started
22
24
  headers: {}
@@ -20,6 +20,7 @@ service:
20
20
  query-parameters:
21
21
  page_number:
22
22
  type: optional<integer>
23
+ default: 0
23
24
  docs: >-
24
25
  Specifies the page number to retrieve, enabling pagination.
25
26
 
@@ -110,6 +111,7 @@ service:
110
111
  up to 10 items. Defaults to 10.
111
112
  page_number:
112
113
  type: optional<integer>
114
+ default: 0
113
115
  docs: >-
114
116
  Specifies the page number to retrieve, enabling pagination.
115
117
 
@@ -26,6 +26,7 @@ service:
26
26
  query-parameters:
27
27
  page_number:
28
28
  type: optional<integer>
29
+ default: 0
29
30
  docs: >-
30
31
  Specifies the page number to retrieve, enabling pagination.
31
32
 
@@ -201,6 +202,7 @@ service:
201
202
  type: optional<list<optional<root.PostedBuiltinTool>>>
202
203
  docs: List of built-in tools associated with this Config.
203
204
  event_messages: optional<root.PostedEventMessageSpecs>
205
+ nudges: optional<root.PostedNudgeSpec>
204
206
  timeouts: optional<root.PostedTimeoutSpecs>
205
207
  webhooks:
206
208
  type: optional<list<optional<root.PostedWebhookSpec>>>
@@ -333,6 +335,7 @@ service:
333
335
  query-parameters:
334
336
  page_number:
335
337
  type: optional<integer>
338
+ default: 0
336
339
  docs: >-
337
340
  Specifies the page number to retrieve, enabling pagination.
338
341
 
@@ -503,6 +506,7 @@ service:
503
506
  docs: List of built-in tools associated with this Config version.
504
507
  event_messages: optional<root.PostedEventMessageSpecs>
505
508
  timeouts: optional<root.PostedTimeoutSpecs>
509
+ nudges: optional<root.PostedNudgeSpec>
506
510
  webhooks:
507
511
  type: optional<list<optional<root.PostedWebhookSpec>>>
508
512
  docs: Webhook config specifications for each subscriber.
@@ -26,6 +26,7 @@ service:
26
26
  query-parameters:
27
27
  page_number:
28
28
  type: optional<integer>
29
+ default: 0
29
30
  docs: >-
30
31
  Specifies the page number to retrieve, enabling pagination.
31
32
 
@@ -26,6 +26,7 @@ service:
26
26
  query-parameters:
27
27
  page_number:
28
28
  type: optional<integer>
29
+ default: 0
29
30
  docs: >-
30
31
  Specifies the page number to retrieve, enabling pagination.
31
32
 
@@ -194,6 +195,7 @@ service:
194
195
  query-parameters:
195
196
  page_number:
196
197
  type: optional<integer>
198
+ default: 0
197
199
  docs: >-
198
200
  Specifies the page number to retrieve, enabling pagination.
199
201
 
@@ -27,6 +27,7 @@ service:
27
27
  query-parameters:
28
28
  page_number:
29
29
  type: optional<integer>
30
+ default: 0
30
31
  docs: >-
31
32
  Specifies the page number to retrieve, enabling pagination.
32
33
 
@@ -225,6 +226,7 @@ service:
225
226
  query-parameters:
226
227
  page_number:
227
228
  type: optional<integer>
229
+ default: 0
228
230
  docs: >-
229
231
  Specifies the page number to retrieve, enabling pagination.
230
232
 
@@ -449,7 +449,7 @@ types:
449
449
  - tr
450
450
  - uk
451
451
  source:
452
- openapi: batch-openapi.json
452
+ openapi: batch-files-openapi.yml
453
453
  BoundingBox:
454
454
  docs: A bounding box around a face.
455
455
  properties:
@@ -677,7 +677,7 @@ types:
677
677
  created by each job.
678
678
  default: false
679
679
  source:
680
- openapi: batch-openapi.json
680
+ openapi: batch-files-openapi.yml
681
681
  FacePrediction:
682
682
  properties:
683
683
  frame:
@@ -785,7 +785,7 @@ types:
785
785
  turn-level granularity for our Emotional Language model will produce
786
786
  results for the entire passage.
787
787
  source:
788
- openapi: batch-openapi.json
788
+ openapi: batch-files-openapi.yml
789
789
  GroupedPredictionsBurstPrediction:
790
790
  properties:
791
791
  id:
@@ -900,7 +900,7 @@ types:
900
900
  completion/failure.
901
901
  default: false
902
902
  source:
903
- openapi: batch-openapi.json
903
+ openapi: batch-files-openapi.yml
904
904
  InferencePrediction:
905
905
  properties:
906
906
  file:
@@ -1045,7 +1045,7 @@ types:
1045
1045
  `unknown` ID.
1046
1046
  default: false
1047
1047
  source:
1048
- openapi: batch-openapi.json
1048
+ openapi: batch-files-openapi.yml
1049
1049
  LanguagePrediction:
1050
1050
  properties:
1051
1051
  text:
@@ -1099,7 +1099,7 @@ types:
1099
1099
  ner: optional<Ner>
1100
1100
  facemesh: optional<Unconfigurable>
1101
1101
  source:
1102
- openapi: batch-openapi.json
1102
+ openapi: batch-files-openapi.yml
1103
1103
  ModelsPredictions:
1104
1104
  properties:
1105
1105
  face: optional<PredictionsOptionalNullFacePrediction>
@@ -1128,7 +1128,7 @@ types:
1128
1128
  `unknown` ID.
1129
1129
  default: false
1130
1130
  source:
1131
- openapi: batch-openapi.json
1131
+ openapi: batch-files-openapi.yml
1132
1132
  NerPrediction:
1133
1133
  properties:
1134
1134
  entity:
@@ -1237,7 +1237,7 @@ types:
1237
1237
  `unknown` ID.
1238
1238
  default: false
1239
1239
  source:
1240
- openapi: batch-openapi.json
1240
+ openapi: batch-files-openapi.yml
1241
1241
  ProsodyPrediction:
1242
1242
  properties:
1243
1243
  text:
@@ -1704,7 +1704,7 @@ types:
1704
1704
  min: 0
1705
1705
  max: 1
1706
1706
  source:
1707
- openapi: batch-openapi.json
1707
+ openapi: batch-files-openapi.yml
1708
1708
  TranscriptionMetadata:
1709
1709
  docs: Transcription metadata for your media file.
1710
1710
  properties:
@@ -1800,4 +1800,4 @@ types:
1800
1800
  validation:
1801
1801
  min: 0.5
1802
1802
  source:
1803
- openapi: batch-openapi.json
1803
+ openapi: batch-files-openapi.yml
@@ -1,5 +1,5 @@
1
1
  channel:
2
- path: /v0/stream/models
2
+ path: /models
3
3
  url: prod
4
4
  auth: false
5
5
  headers: