hume 0.15.8 → 0.15.10

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 (454) hide show
  1. package/dist/cjs/BaseClient.d.ts +13 -4
  2. package/dist/cjs/BaseClient.js +59 -0
  3. package/dist/cjs/Client.d.ts +13 -13
  4. package/dist/cjs/Client.js +8 -49
  5. package/dist/cjs/api/resources/empathicVoice/client/Client.d.ts +27 -27
  6. package/dist/cjs/api/resources/empathicVoice/client/Client.js +13 -12
  7. package/dist/cjs/api/resources/empathicVoice/errors/BadRequestError.js +5 -1
  8. package/dist/cjs/api/resources/empathicVoice/errors/UnprocessableEntityError.js +5 -1
  9. package/dist/cjs/api/resources/empathicVoice/resources/chat/client/Client.d.ts +5 -5
  10. package/dist/cjs/api/resources/empathicVoice/resources/chat/client/Client.js +3 -3
  11. package/dist/cjs/api/resources/empathicVoice/resources/chat/client/index.d.ts +1 -1
  12. package/dist/cjs/api/resources/empathicVoice/resources/chat/client/index.js +2 -2
  13. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +17 -26
  14. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.js +48 -136
  15. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +1 -1
  16. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.ts +1 -1
  17. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +1 -1
  18. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +2 -6
  19. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/Client.d.ts +13 -20
  20. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/Client.js +32 -95
  21. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.ts +1 -1
  22. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.ts +1 -1
  23. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/Client.d.ts +34 -83
  24. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/Client.js +64 -245
  25. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.ts +1 -1
  26. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +4 -16
  27. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +3 -14
  28. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts +1 -1
  29. package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.d.ts +7 -7
  30. package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.js +6 -19
  31. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +34 -83
  32. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.js +64 -245
  33. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +2 -8
  34. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +2 -8
  35. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts +1 -1
  36. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts +1 -1
  37. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/Client.d.ts +34 -83
  38. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/Client.js +64 -245
  39. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +4 -8
  40. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +4 -8
  41. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts +1 -1
  42. package/dist/cjs/api/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
  43. package/dist/cjs/api/resources/empathicVoice/types/AssistantInput.d.ts +2 -5
  44. package/dist/cjs/api/resources/empathicVoice/types/AssistantMessage.d.ts +2 -2
  45. package/dist/cjs/api/resources/empathicVoice/types/AssistantProsody.d.ts +1 -1
  46. package/dist/cjs/api/resources/empathicVoice/types/AudioInput.d.ts +6 -4
  47. package/dist/cjs/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -4
  48. package/dist/cjs/api/resources/empathicVoice/types/ChatMetadata.d.ts +3 -5
  49. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettings.d.ts +8 -4
  50. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.ts +3 -3
  51. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.ts +9 -3
  52. package/dist/cjs/api/resources/empathicVoice/types/Context.d.ts +9 -3
  53. package/dist/cjs/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.ts +1 -36
  54. package/dist/cjs/api/resources/empathicVoice/types/JsonMessage.d.ts +1 -50
  55. package/dist/cjs/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +2 -4
  56. package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -9
  57. package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinToolName.d.ts +0 -8
  58. package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinToolName.js +0 -8
  59. package/dist/cjs/api/resources/empathicVoice/types/PostedEllmModel.d.ts +1 -5
  60. package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpec.d.ts +2 -6
  61. package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +1 -14
  62. package/dist/cjs/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -7
  63. package/dist/cjs/api/resources/empathicVoice/types/PostedNudgeSpec.d.ts +2 -2
  64. package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +1 -13
  65. package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +0 -11
  66. package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +0 -11
  67. package/dist/cjs/api/resources/empathicVoice/types/PostedUserDefinedToolSpec.d.ts +1 -7
  68. package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +2 -6
  69. package/dist/cjs/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +1 -3
  70. package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +1 -2
  71. package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.ts +0 -1
  72. package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.js +0 -1
  73. package/dist/cjs/api/resources/empathicVoice/types/ReturnChat.d.ts +4 -19
  74. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +0 -13
  75. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +0 -13
  76. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +0 -13
  77. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +5 -30
  78. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +0 -7
  79. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEventRole.js +0 -7
  80. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +0 -14
  81. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEventType.js +0 -14
  82. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +5 -6
  83. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +1 -10
  84. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +0 -5
  85. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +0 -5
  86. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +6 -16
  87. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChatsPaginationDirection.d.ts +0 -5
  88. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChatsPaginationDirection.js +0 -5
  89. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +3 -12
  90. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.ts +0 -5
  91. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.js +0 -5
  92. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +6 -30
  93. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.ts +0 -5
  94. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.js +0 -5
  95. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.ts +0 -15
  96. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.js +0 -15
  97. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatStatus.d.ts +0 -15
  98. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatStatus.js +0 -15
  99. package/dist/cjs/api/resources/empathicVoice/types/ReturnConfigSpec.d.ts +2 -8
  100. package/dist/cjs/api/resources/empathicVoice/types/ReturnEllmModel.d.ts +1 -5
  101. package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts +2 -6
  102. package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +1 -14
  103. package/dist/cjs/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -7
  104. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +2 -11
  105. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.ts +0 -5
  106. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.js +0 -5
  107. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +2 -11
  108. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.ts +0 -5
  109. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js +0 -5
  110. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +2 -6
  111. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +2 -6
  112. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +2 -6
  113. package/dist/cjs/api/resources/empathicVoice/types/ReturnPromptVersionType.d.ts +0 -1
  114. package/dist/cjs/api/resources/empathicVoice/types/ReturnPromptVersionType.js +0 -1
  115. package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +2 -6
  116. package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +1 -13
  117. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +7 -19
  118. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.ts +0 -1
  119. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js +0 -1
  120. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts +0 -1
  121. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js +0 -1
  122. package/dist/cjs/api/resources/empathicVoice/types/ReturnVoice.d.ts +5 -3
  123. package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +2 -6
  124. package/dist/cjs/api/resources/empathicVoice/types/SessionSettings.d.ts +10 -19
  125. package/dist/cjs/api/resources/empathicVoice/types/SubscribeEvent.d.ts +1 -55
  126. package/dist/cjs/api/resources/empathicVoice/types/ToolCallMessage.d.ts +3 -9
  127. package/dist/cjs/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +3 -5
  128. package/dist/cjs/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -11
  129. package/dist/cjs/api/resources/empathicVoice/types/UserInput.d.ts +6 -2
  130. package/dist/cjs/api/resources/empathicVoice/types/UserInterruption.d.ts +1 -3
  131. package/dist/cjs/api/resources/empathicVoice/types/UserMessage.d.ts +3 -17
  132. package/dist/cjs/api/resources/empathicVoice/types/VoiceId.d.ts +11 -2
  133. package/dist/cjs/api/resources/empathicVoice/types/VoiceName.d.ts +11 -2
  134. package/dist/cjs/api/resources/empathicVoice/types/WebSocketError.d.ts +1 -3
  135. package/dist/cjs/api/resources/expressionMeasurement/client/Client.d.ts +9 -9
  136. package/dist/cjs/api/resources/expressionMeasurement/client/Client.js +7 -6
  137. package/dist/cjs/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +17 -18
  138. package/dist/cjs/api/resources/expressionMeasurement/resources/batch/client/Client.js +63 -151
  139. package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.d.ts +7 -8
  140. package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.js +7 -12
  141. package/dist/cjs/api/resources/tts/client/Client.d.ts +19 -20
  142. package/dist/cjs/api/resources/tts/client/Client.js +56 -138
  143. package/dist/cjs/api/resources/tts/errors/BadRequestError.js +5 -1
  144. package/dist/cjs/api/resources/tts/errors/UnprocessableEntityError.js +5 -1
  145. package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.d.ts +15 -14
  146. package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.js +10 -6
  147. package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts +13 -14
  148. package/dist/cjs/api/resources/tts/resources/voices/client/Client.js +33 -87
  149. package/dist/cjs/api/resources/tts/resources/voices/client/requests/PostedVoice.d.ts +1 -1
  150. package/dist/cjs/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +1 -1
  151. package/dist/cjs/api/resources/tts/types/OctaveVersion.d.ts +7 -3
  152. package/dist/cjs/api/resources/tts/types/OctaveVersion.js +7 -3
  153. package/dist/cjs/api/resources/tts/types/PostedTts.d.ts +0 -6
  154. package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +1 -1
  155. package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +1 -1
  156. package/dist/cjs/api/resources/tts/types/PublishTts.d.ts +14 -4
  157. package/dist/cjs/api/resources/tts/types/ReturnPagedVoices.d.ts +5 -9
  158. package/dist/cjs/api/resources/tts/types/ReturnVoice.d.ts +3 -3
  159. package/dist/cjs/auth/HeaderAuthProvider.d.ts +26 -0
  160. package/dist/cjs/auth/HeaderAuthProvider.js +91 -0
  161. package/dist/cjs/auth/index.d.ts +1 -0
  162. package/dist/cjs/auth/index.js +5 -0
  163. package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
  164. package/dist/cjs/core/auth/AuthProvider.js +2 -0
  165. package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
  166. package/dist/cjs/core/auth/AuthRequest.js +2 -0
  167. package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
  168. package/dist/cjs/core/auth/BasicAuth.js +27 -0
  169. package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
  170. package/dist/cjs/core/auth/BearerToken.js +16 -0
  171. package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
  172. package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
  173. package/dist/cjs/core/auth/index.d.ts +5 -0
  174. package/dist/cjs/core/auth/index.js +9 -0
  175. package/dist/cjs/core/base64.d.ts +2 -0
  176. package/dist/cjs/core/base64.js +26 -0
  177. package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
  178. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +2 -2
  179. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -3
  180. package/dist/cjs/core/fetcher/Fetcher.js +42 -24
  181. package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
  182. package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
  183. package/dist/cjs/core/fetcher/makeRequest.js +0 -2
  184. package/dist/cjs/core/fetcher/requestWithRetries.js +0 -9
  185. package/dist/cjs/core/fetcher/signals.d.ts +1 -7
  186. package/dist/cjs/core/fetcher/signals.js +0 -12
  187. package/dist/cjs/core/headers.d.ts +2 -2
  188. package/dist/cjs/core/index.d.ts +2 -0
  189. package/dist/cjs/core/index.js +2 -0
  190. package/dist/cjs/core/logging/logger.js +1 -1
  191. package/dist/cjs/core/pagination/CustomPager.d.ts +67 -0
  192. package/dist/cjs/core/pagination/CustomPager.js +194 -0
  193. package/dist/cjs/core/pagination/index.d.ts +1 -0
  194. package/dist/cjs/core/pagination/index.js +4 -1
  195. package/dist/cjs/core/runtime/runtime.js +11 -10
  196. package/dist/cjs/core/schemas/Schema.d.ts +1 -0
  197. package/dist/cjs/core/schemas/Schema.js +1 -0
  198. package/dist/cjs/core/schemas/builders/object/object.js +14 -1
  199. package/dist/cjs/core/schemas/builders/primitives/index.d.ts +1 -0
  200. package/dist/cjs/core/schemas/builders/primitives/index.js +3 -1
  201. package/dist/cjs/core/schemas/builders/primitives/never.d.ts +2 -0
  202. package/dist/cjs/core/schemas/builders/primitives/never.js +14 -0
  203. package/dist/cjs/core/url/join.js +0 -1
  204. package/dist/cjs/errors/HumeError.js +5 -1
  205. package/dist/cjs/errors/HumeTimeoutError.js +5 -1
  206. package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
  207. package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
  208. package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +3 -3
  209. package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.js +3 -3
  210. package/dist/cjs/serialization/resources/tts/types/ReturnPagedVoices.d.ts +4 -4
  211. package/dist/cjs/serialization/resources/tts/types/ReturnPagedVoices.js +4 -4
  212. package/dist/cjs/serialization/resources/tts/types/ReturnVoice.d.ts +3 -3
  213. package/dist/cjs/serialization/resources/tts/types/ReturnVoice.js +3 -3
  214. package/dist/cjs/version.d.ts +1 -1
  215. package/dist/cjs/version.js +1 -1
  216. package/dist/cjs/wrapper/SilenceFiller.d.ts +64 -10
  217. package/dist/cjs/wrapper/SilenceFiller.js +109 -26
  218. package/dist/cjs/wrapper/expressionMeasurement/ExpressionMeasurementClient.d.ts +1 -1
  219. package/dist/cjs/wrapper/expressionMeasurement/ExpressionMeasurementClient.js +1 -1
  220. package/dist/cjs/wrapper/expressionMeasurement/batch/BatchClient.d.ts +1 -1
  221. package/dist/cjs/wrapper/expressionMeasurement/batch/BatchClient.js +1 -1
  222. package/dist/cjs/wrapper/fetchAccessToken.js +3 -0
  223. package/dist/cjs/wrapper/index.d.ts +5 -0
  224. package/dist/cjs/wrapper/index.js +6 -6
  225. package/dist/esm/BaseClient.d.mts +13 -4
  226. package/dist/esm/BaseClient.mjs +24 -1
  227. package/dist/esm/Client.d.mts +13 -13
  228. package/dist/esm/Client.mjs +11 -19
  229. package/dist/esm/api/resources/empathicVoice/client/Client.d.mts +27 -27
  230. package/dist/esm/api/resources/empathicVoice/client/Client.mjs +18 -17
  231. package/dist/esm/api/resources/empathicVoice/errors/BadRequestError.mjs +5 -1
  232. package/dist/esm/api/resources/empathicVoice/errors/UnprocessableEntityError.mjs +5 -1
  233. package/dist/esm/api/resources/empathicVoice/resources/chat/client/Client.d.mts +5 -5
  234. package/dist/esm/api/resources/empathicVoice/resources/chat/client/Client.mjs +1 -1
  235. package/dist/esm/api/resources/empathicVoice/resources/chat/client/index.d.mts +1 -1
  236. package/dist/esm/api/resources/empathicVoice/resources/chat/client/index.mjs +1 -1
  237. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.d.mts +17 -26
  238. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.mjs +47 -135
  239. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.mts +1 -1
  240. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.mts +1 -1
  241. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.mts +1 -1
  242. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.mts +2 -6
  243. package/dist/esm/api/resources/empathicVoice/resources/chats/client/Client.d.mts +13 -20
  244. package/dist/esm/api/resources/empathicVoice/resources/chats/client/Client.mjs +31 -94
  245. package/dist/esm/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.mts +1 -1
  246. package/dist/esm/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.mts +1 -1
  247. package/dist/esm/api/resources/empathicVoice/resources/configs/client/Client.d.mts +34 -83
  248. package/dist/esm/api/resources/empathicVoice/resources/configs/client/Client.mjs +63 -244
  249. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.mts +1 -1
  250. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +4 -16
  251. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +3 -14
  252. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.mts +1 -1
  253. package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts +7 -7
  254. package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs +4 -17
  255. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/Client.d.mts +34 -83
  256. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/Client.mjs +63 -244
  257. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +2 -8
  258. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +2 -8
  259. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.mts +1 -1
  260. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.mts +1 -1
  261. package/dist/esm/api/resources/empathicVoice/resources/tools/client/Client.d.mts +34 -83
  262. package/dist/esm/api/resources/empathicVoice/resources/tools/client/Client.mjs +63 -244
  263. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +4 -8
  264. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +4 -8
  265. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.mts +1 -1
  266. package/dist/esm/api/resources/empathicVoice/types/AssistantEnd.d.mts +1 -1
  267. package/dist/esm/api/resources/empathicVoice/types/AssistantInput.d.mts +2 -5
  268. package/dist/esm/api/resources/empathicVoice/types/AssistantMessage.d.mts +2 -2
  269. package/dist/esm/api/resources/empathicVoice/types/AssistantProsody.d.mts +1 -1
  270. package/dist/esm/api/resources/empathicVoice/types/AudioInput.d.mts +6 -4
  271. package/dist/esm/api/resources/empathicVoice/types/AudioOutput.d.mts +1 -4
  272. package/dist/esm/api/resources/empathicVoice/types/ChatMetadata.d.mts +3 -5
  273. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettings.d.mts +8 -4
  274. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.mts +3 -3
  275. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.mts +9 -3
  276. package/dist/esm/api/resources/empathicVoice/types/Context.d.mts +9 -3
  277. package/dist/esm/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.mts +1 -36
  278. package/dist/esm/api/resources/empathicVoice/types/JsonMessage.d.mts +1 -50
  279. package/dist/esm/api/resources/empathicVoice/types/PauseAssistantMessage.d.mts +2 -4
  280. package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinTool.d.mts +1 -9
  281. package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinToolName.d.mts +0 -8
  282. package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinToolName.mjs +0 -8
  283. package/dist/esm/api/resources/empathicVoice/types/PostedEllmModel.d.mts +1 -5
  284. package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpec.d.mts +2 -6
  285. package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +1 -14
  286. package/dist/esm/api/resources/empathicVoice/types/PostedLanguageModel.d.mts +1 -7
  287. package/dist/esm/api/resources/empathicVoice/types/PostedNudgeSpec.d.mts +2 -2
  288. package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.mts +1 -13
  289. package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.mts +0 -11
  290. package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.mts +0 -11
  291. package/dist/esm/api/resources/empathicVoice/types/PostedUserDefinedToolSpec.d.mts +1 -7
  292. package/dist/esm/api/resources/empathicVoice/types/PostedWebhookSpec.d.mts +2 -6
  293. package/dist/esm/api/resources/empathicVoice/types/ResumeAssistantMessage.d.mts +1 -3
  294. package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +1 -2
  295. package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.mts +0 -1
  296. package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.mjs +0 -1
  297. package/dist/esm/api/resources/empathicVoice/types/ReturnChat.d.mts +4 -19
  298. package/dist/esm/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.mts +0 -13
  299. package/dist/esm/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.mts +0 -13
  300. package/dist/esm/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.mjs +0 -13
  301. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEvent.d.mts +5 -30
  302. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEventRole.d.mts +0 -7
  303. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEventRole.mjs +0 -7
  304. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEventType.d.mts +0 -14
  305. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEventType.mjs +0 -14
  306. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroup.d.mts +5 -6
  307. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +1 -10
  308. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.mts +0 -5
  309. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.mjs +0 -5
  310. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +6 -16
  311. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChatsPaginationDirection.d.mts +0 -5
  312. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChatsPaginationDirection.mjs +0 -5
  313. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +3 -12
  314. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.mts +0 -5
  315. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.mjs +0 -5
  316. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +6 -30
  317. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.mts +0 -5
  318. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.mjs +0 -5
  319. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.mts +0 -15
  320. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.mjs +0 -15
  321. package/dist/esm/api/resources/empathicVoice/types/ReturnChatStatus.d.mts +0 -15
  322. package/dist/esm/api/resources/empathicVoice/types/ReturnChatStatus.mjs +0 -15
  323. package/dist/esm/api/resources/empathicVoice/types/ReturnConfigSpec.d.mts +2 -8
  324. package/dist/esm/api/resources/empathicVoice/types/ReturnEllmModel.d.mts +1 -5
  325. package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.mts +2 -6
  326. package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +1 -14
  327. package/dist/esm/api/resources/empathicVoice/types/ReturnLanguageModel.d.mts +1 -7
  328. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +2 -11
  329. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.mts +0 -5
  330. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.mjs +0 -5
  331. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChats.d.mts +2 -11
  332. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.mts +0 -5
  333. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.mjs +0 -5
  334. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +2 -6
  335. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +2 -6
  336. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +2 -6
  337. package/dist/esm/api/resources/empathicVoice/types/ReturnPromptVersionType.d.mts +0 -1
  338. package/dist/esm/api/resources/empathicVoice/types/ReturnPromptVersionType.mjs +0 -1
  339. package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +2 -6
  340. package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.mts +1 -13
  341. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +7 -19
  342. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.mts +0 -1
  343. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.mjs +0 -1
  344. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.mts +0 -1
  345. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.mjs +0 -1
  346. package/dist/esm/api/resources/empathicVoice/types/ReturnVoice.d.mts +5 -3
  347. package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +2 -6
  348. package/dist/esm/api/resources/empathicVoice/types/SessionSettings.d.mts +10 -19
  349. package/dist/esm/api/resources/empathicVoice/types/SubscribeEvent.d.mts +1 -55
  350. package/dist/esm/api/resources/empathicVoice/types/ToolCallMessage.d.mts +3 -9
  351. package/dist/esm/api/resources/empathicVoice/types/ToolErrorMessage.d.mts +3 -5
  352. package/dist/esm/api/resources/empathicVoice/types/ToolResponseMessage.d.mts +3 -11
  353. package/dist/esm/api/resources/empathicVoice/types/UserInput.d.mts +6 -2
  354. package/dist/esm/api/resources/empathicVoice/types/UserInterruption.d.mts +1 -3
  355. package/dist/esm/api/resources/empathicVoice/types/UserMessage.d.mts +3 -17
  356. package/dist/esm/api/resources/empathicVoice/types/VoiceId.d.mts +11 -2
  357. package/dist/esm/api/resources/empathicVoice/types/VoiceName.d.mts +11 -2
  358. package/dist/esm/api/resources/empathicVoice/types/WebSocketError.d.mts +1 -3
  359. package/dist/esm/api/resources/expressionMeasurement/client/Client.d.mts +9 -9
  360. package/dist/esm/api/resources/expressionMeasurement/client/Client.mjs +6 -5
  361. package/dist/esm/api/resources/expressionMeasurement/resources/batch/client/Client.d.mts +17 -18
  362. package/dist/esm/api/resources/expressionMeasurement/resources/batch/client/Client.mjs +61 -149
  363. package/dist/esm/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.d.mts +7 -8
  364. package/dist/esm/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.mjs +5 -10
  365. package/dist/esm/api/resources/tts/client/Client.d.mts +19 -20
  366. package/dist/esm/api/resources/tts/client/Client.mjs +56 -138
  367. package/dist/esm/api/resources/tts/errors/BadRequestError.mjs +5 -1
  368. package/dist/esm/api/resources/tts/errors/UnprocessableEntityError.mjs +5 -1
  369. package/dist/esm/api/resources/tts/resources/streamInput/client/Client.d.mts +15 -14
  370. package/dist/esm/api/resources/tts/resources/streamInput/client/Client.mjs +8 -4
  371. package/dist/esm/api/resources/tts/resources/voices/client/Client.d.mts +13 -14
  372. package/dist/esm/api/resources/tts/resources/voices/client/Client.mjs +32 -86
  373. package/dist/esm/api/resources/tts/resources/voices/client/requests/PostedVoice.d.mts +1 -1
  374. package/dist/esm/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.mts +1 -1
  375. package/dist/esm/api/resources/tts/types/OctaveVersion.d.mts +7 -3
  376. package/dist/esm/api/resources/tts/types/OctaveVersion.mjs +7 -3
  377. package/dist/esm/api/resources/tts/types/PostedTts.d.mts +0 -6
  378. package/dist/esm/api/resources/tts/types/PostedUtteranceVoiceWithId.d.mts +1 -1
  379. package/dist/esm/api/resources/tts/types/PostedUtteranceVoiceWithName.d.mts +1 -1
  380. package/dist/esm/api/resources/tts/types/PublishTts.d.mts +14 -4
  381. package/dist/esm/api/resources/tts/types/ReturnPagedVoices.d.mts +5 -9
  382. package/dist/esm/api/resources/tts/types/ReturnVoice.d.mts +3 -3
  383. package/dist/esm/auth/HeaderAuthProvider.d.mts +26 -0
  384. package/dist/esm/auth/HeaderAuthProvider.mjs +54 -0
  385. package/dist/esm/auth/index.d.mts +1 -0
  386. package/dist/esm/auth/index.mjs +1 -0
  387. package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
  388. package/dist/esm/core/auth/AuthProvider.mjs +1 -0
  389. package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
  390. package/dist/esm/core/auth/AuthRequest.mjs +1 -0
  391. package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
  392. package/dist/esm/core/auth/BasicAuth.mjs +24 -0
  393. package/dist/esm/core/auth/BearerToken.d.mts +7 -0
  394. package/dist/esm/core/auth/BearerToken.mjs +13 -0
  395. package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
  396. package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
  397. package/dist/esm/core/auth/index.d.mts +5 -0
  398. package/dist/esm/core/auth/index.mjs +3 -0
  399. package/dist/esm/core/base64.d.mts +2 -0
  400. package/dist/esm/core/base64.mjs +22 -0
  401. package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
  402. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +2 -2
  403. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -3
  404. package/dist/esm/core/fetcher/Fetcher.mjs +42 -24
  405. package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
  406. package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
  407. package/dist/esm/core/fetcher/makeRequest.mjs +0 -2
  408. package/dist/esm/core/fetcher/requestWithRetries.mjs +0 -9
  409. package/dist/esm/core/fetcher/signals.d.mts +1 -7
  410. package/dist/esm/core/fetcher/signals.mjs +0 -12
  411. package/dist/esm/core/headers.d.mts +2 -2
  412. package/dist/esm/core/index.d.mts +2 -0
  413. package/dist/esm/core/index.mjs +2 -0
  414. package/dist/esm/core/logging/logger.mjs +1 -1
  415. package/dist/esm/core/pagination/CustomPager.d.mts +67 -0
  416. package/dist/esm/core/pagination/CustomPager.mjs +189 -0
  417. package/dist/esm/core/pagination/index.d.mts +1 -0
  418. package/dist/esm/core/pagination/index.mjs +1 -0
  419. package/dist/esm/core/runtime/runtime.mjs +11 -10
  420. package/dist/esm/core/schemas/Schema.d.mts +1 -0
  421. package/dist/esm/core/schemas/Schema.mjs +1 -0
  422. package/dist/esm/core/schemas/builders/object/object.mjs +14 -1
  423. package/dist/esm/core/schemas/builders/primitives/index.d.mts +1 -0
  424. package/dist/esm/core/schemas/builders/primitives/index.mjs +1 -0
  425. package/dist/esm/core/schemas/builders/primitives/never.d.mts +2 -0
  426. package/dist/esm/core/schemas/builders/primitives/never.mjs +11 -0
  427. package/dist/esm/core/url/join.mjs +0 -1
  428. package/dist/esm/errors/HumeError.mjs +5 -1
  429. package/dist/esm/errors/HumeTimeoutError.mjs +5 -1
  430. package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
  431. package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
  432. package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.d.mts +3 -3
  433. package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.mjs +3 -3
  434. package/dist/esm/serialization/resources/tts/types/ReturnPagedVoices.d.mts +4 -4
  435. package/dist/esm/serialization/resources/tts/types/ReturnPagedVoices.mjs +4 -4
  436. package/dist/esm/serialization/resources/tts/types/ReturnVoice.d.mts +3 -3
  437. package/dist/esm/serialization/resources/tts/types/ReturnVoice.mjs +3 -3
  438. package/dist/esm/version.d.mts +1 -1
  439. package/dist/esm/version.mjs +1 -1
  440. package/dist/esm/wrapper/SilenceFiller.d.mts +64 -10
  441. package/dist/esm/wrapper/SilenceFiller.mjs +109 -26
  442. package/dist/esm/wrapper/expressionMeasurement/ExpressionMeasurementClient.d.mts +1 -1
  443. package/dist/esm/wrapper/expressionMeasurement/ExpressionMeasurementClient.mjs +1 -1
  444. package/dist/esm/wrapper/expressionMeasurement/batch/BatchClient.d.mts +1 -1
  445. package/dist/esm/wrapper/expressionMeasurement/batch/BatchClient.mjs +1 -1
  446. package/dist/esm/wrapper/fetchAccessToken.mjs +3 -0
  447. package/dist/esm/wrapper/index.d.mts +5 -0
  448. package/dist/esm/wrapper/index.mjs +4 -5
  449. package/package.json +5 -2
  450. package/reference.md +621 -1205
  451. package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
  452. package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
  453. package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
  454. package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
package/reference.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Reference
2
- ## Tts
3
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
2
+ ## EmpathicVoice ControlPlane
3
+ <details><summary><code>client.empathicVoice.controlPlane.<a href="/src/api/resources/empathicVoice/resources/controlPlane/client/Client.ts">send</a>(chat_id, { ...params }) -> void</code></summary>
4
4
  <dl>
5
5
  <dd>
6
6
 
@@ -12,9 +12,7 @@
12
12
  <dl>
13
13
  <dd>
14
14
 
15
- Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
16
-
17
- The response includes the base64-encoded audio and metadata in JSON format.
15
+ Send a message to a specific chat.
18
16
  </dd>
19
17
  </dl>
20
18
  </dd>
@@ -29,21 +27,8 @@ The response includes the base64-encoded audio and metadata in JSON format.
29
27
  <dd>
30
28
 
31
29
  ```typescript
32
- await client.tts.synthesizeJson({
33
- context: {
34
- utterances: [{
35
- text: "How can people see beauty so differently?",
36
- description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
37
- }]
38
- },
39
- format: {
40
- type: "mp3"
41
- },
42
- numGenerations: 1,
43
- utterances: [{
44
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
45
- description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
46
- }]
30
+ await client.empathicVoice.controlPlane.send("chat_id", {
31
+ type: "session_settings"
47
32
  });
48
33
 
49
34
  ```
@@ -60,7 +45,15 @@ await client.tts.synthesizeJson({
60
45
  <dl>
61
46
  <dd>
62
47
 
63
- **request:** `Hume.PostedTts`
48
+ **chat_id:** `string`
49
+
50
+ </dd>
51
+ </dl>
52
+
53
+ <dl>
54
+ <dd>
55
+
56
+ **request:** `Hume.ControlPlanePublishEvent`
64
57
 
65
58
  </dd>
66
59
  </dl>
@@ -68,7 +61,7 @@ await client.tts.synthesizeJson({
68
61
  <dl>
69
62
  <dd>
70
63
 
71
- **requestOptions:** `Tts.RequestOptions`
64
+ **requestOptions:** `ControlPlaneClient.RequestOptions`
72
65
 
73
66
  </dd>
74
67
  </dl>
@@ -80,26 +73,11 @@ await client.tts.synthesizeJson({
80
73
  </dl>
81
74
  </details>
82
75
 
83
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> core.BinaryResponse</code></summary>
84
- <dl>
85
- <dd>
86
-
87
- #### 📝 Description
88
-
89
- <dl>
90
- <dd>
91
-
76
+ ## EmpathicVoice ChatGroups
77
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
92
78
  <dl>
93
79
  <dd>
94
80
 
95
- Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
96
-
97
- The response contains the generated audio file in the requested format.
98
- </dd>
99
- </dl>
100
- </dd>
101
- </dl>
102
-
103
81
  #### 🔌 Usage
104
82
 
105
83
  <dl>
@@ -109,19 +87,29 @@ The response contains the generated audio file in the requested format.
109
87
  <dd>
110
88
 
111
89
  ```typescript
112
- await client.tts.synthesizeFile({
113
- context: {
114
- generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2"
115
- },
116
- format: {
117
- type: "mp3"
118
- },
119
- numGenerations: 1,
120
- utterances: [{
121
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
122
- description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
123
- }]
90
+ const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
91
+ pageNumber: 0,
92
+ pageSize: 1,
93
+ ascendingOrder: true,
94
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
95
+ });
96
+ for await (const item of pageableResponse) {
97
+ console.log(item);
98
+ }
99
+
100
+ // Or you can manually iterate page-by-page
101
+ let page = await client.empathicVoice.chatGroups.listChatGroups({
102
+ pageNumber: 0,
103
+ pageSize: 1,
104
+ ascendingOrder: true,
105
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
124
106
  });
107
+ while (page.hasNextPage()) {
108
+ page = page.getNextPage();
109
+ }
110
+
111
+ // You can also access the underlying response
112
+ const response = page.response;
125
113
 
126
114
  ```
127
115
  </dd>
@@ -137,7 +125,7 @@ await client.tts.synthesizeFile({
137
125
  <dl>
138
126
  <dd>
139
127
 
140
- **request:** `Hume.PostedTts`
128
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
141
129
 
142
130
  </dd>
143
131
  </dl>
@@ -145,7 +133,7 @@ await client.tts.synthesizeFile({
145
133
  <dl>
146
134
  <dd>
147
135
 
148
- **requestOptions:** `Tts.RequestOptions`
136
+ **requestOptions:** `ChatGroupsClient.RequestOptions`
149
137
 
150
138
  </dd>
151
139
  </dl>
@@ -157,24 +145,10 @@ await client.tts.synthesizeFile({
157
145
  </dl>
158
146
  </details>
159
147
 
160
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> core.BinaryResponse</code></summary>
161
- <dl>
162
- <dd>
163
-
164
- #### 📝 Description
165
-
166
- <dl>
167
- <dd>
168
-
148
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
169
149
  <dl>
170
150
  <dd>
171
151
 
172
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
173
- </dd>
174
- </dl>
175
- </dd>
176
- </dl>
177
-
178
152
  #### 🔌 Usage
179
153
 
180
154
  <dl>
@@ -184,14 +158,10 @@ Streams synthesized speech using the specified voice. If no voice is provided, a
184
158
  <dd>
185
159
 
186
160
  ```typescript
187
- await client.tts.synthesizeFileStreaming({
188
- utterances: [{
189
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
190
- voice: {
191
- name: "Male English Actor",
192
- provider: "HUME_AI"
193
- }
194
- }]
161
+ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
162
+ pageNumber: 0,
163
+ pageSize: 1,
164
+ ascendingOrder: true
195
165
  });
196
166
 
197
167
  ```
@@ -208,7 +178,15 @@ await client.tts.synthesizeFileStreaming({
208
178
  <dl>
209
179
  <dd>
210
180
 
211
- **request:** `Hume.PostedTts`
181
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
182
+
183
+ </dd>
184
+ </dl>
185
+
186
+ <dl>
187
+ <dd>
188
+
189
+ **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
212
190
 
213
191
  </dd>
214
192
  </dl>
@@ -216,7 +194,7 @@ await client.tts.synthesizeFileStreaming({
216
194
  <dl>
217
195
  <dd>
218
196
 
219
- **requestOptions:** `Tts.RequestOptions`
197
+ **requestOptions:** `ChatGroupsClient.RequestOptions`
220
198
 
221
199
  </dd>
222
200
  </dl>
@@ -228,11 +206,11 @@ await client.tts.synthesizeFileStreaming({
228
206
  </dl>
229
207
  </details>
230
208
 
231
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
209
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
232
210
  <dl>
233
211
  <dd>
234
212
 
235
- #### 📝 Description
213
+ #### 🔌 Usage
236
214
 
237
215
  <dl>
238
216
  <dd>
@@ -240,15 +218,20 @@ await client.tts.synthesizeFileStreaming({
240
218
  <dl>
241
219
  <dd>
242
220
 
243
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
221
+ ```typescript
222
+ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
223
+ pageNumber: 0,
224
+ pageSize: 10,
225
+ ascendingOrder: true
226
+ });
244
227
 
245
- The response is a stream of JSON objects including audio encoded in base64.
228
+ ```
246
229
  </dd>
247
230
  </dl>
248
231
  </dd>
249
232
  </dl>
250
233
 
251
- #### 🔌 Usage
234
+ #### ⚙️ Parameters
252
235
 
253
236
  <dl>
254
237
  <dd>
@@ -256,35 +239,15 @@ The response is a stream of JSON objects including audio encoded in base64.
256
239
  <dl>
257
240
  <dd>
258
241
 
259
- ```typescript
260
- const response = await client.tts.synthesizeJsonStreaming({
261
- utterances: [{
262
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
263
- voice: {
264
- name: "Male English Actor",
265
- provider: "HUME_AI"
266
- }
267
- }]
268
- });
269
- for await (const item of response) {
270
- console.log(item);
271
- }
272
-
273
- ```
274
- </dd>
275
- </dl>
242
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
243
+
276
244
  </dd>
277
245
  </dl>
278
246
 
279
- #### ⚙️ Parameters
280
-
281
- <dl>
282
- <dd>
283
-
284
247
  <dl>
285
248
  <dd>
286
249
 
287
- **request:** `Hume.PostedTts`
250
+ **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
288
251
 
289
252
  </dd>
290
253
  </dl>
@@ -292,7 +255,7 @@ for await (const item of response) {
292
255
  <dl>
293
256
  <dd>
294
257
 
295
- **requestOptions:** `Tts.RequestOptions`
258
+ **requestOptions:** `ChatGroupsClient.RequestOptions`
296
259
 
297
260
  </dd>
298
261
  </dl>
@@ -304,7 +267,7 @@ for await (const item of response) {
304
267
  </dl>
305
268
  </details>
306
269
 
307
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
270
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
308
271
  <dl>
309
272
  <dd>
310
273
 
@@ -317,11 +280,28 @@ for await (const item of response) {
317
280
  <dd>
318
281
 
319
282
  ```typescript
320
- const response = await client.tts.convertVoiceJson({});
321
- for await (const item of response) {
283
+ const pageableResponse = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
284
+ pageNumber: 0,
285
+ pageSize: 3,
286
+ ascendingOrder: true
287
+ });
288
+ for await (const item of pageableResponse) {
322
289
  console.log(item);
323
290
  }
324
291
 
292
+ // Or you can manually iterate page-by-page
293
+ let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
294
+ pageNumber: 0,
295
+ pageSize: 3,
296
+ ascendingOrder: true
297
+ });
298
+ while (page.hasNextPage()) {
299
+ page = page.getNextPage();
300
+ }
301
+
302
+ // You can also access the underlying response
303
+ const response = page.response;
304
+
325
305
  ```
326
306
  </dd>
327
307
  </dl>
@@ -336,7 +316,7 @@ for await (const item of response) {
336
316
  <dl>
337
317
  <dd>
338
318
 
339
- **request:** `Hume.tts.ConvertVoiceJsonRequest`
319
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
340
320
 
341
321
  </dd>
342
322
  </dl>
@@ -344,7 +324,15 @@ for await (const item of response) {
344
324
  <dl>
345
325
  <dd>
346
326
 
347
- **requestOptions:** `Tts.RequestOptions`
327
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
328
+
329
+ </dd>
330
+ </dl>
331
+
332
+ <dl>
333
+ <dd>
334
+
335
+ **requestOptions:** `ChatGroupsClient.RequestOptions`
348
336
 
349
337
  </dd>
350
338
  </dl>
@@ -356,25 +344,11 @@ for await (const item of response) {
356
344
  </dl>
357
345
  </details>
358
346
 
359
- ## Tts Voices
360
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
361
- <dl>
362
- <dd>
363
-
364
- #### 📝 Description
365
-
366
- <dl>
367
- <dd>
368
-
347
+ ## EmpathicVoice Chats
348
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
369
349
  <dl>
370
350
  <dd>
371
351
 
372
- Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
373
- </dd>
374
- </dl>
375
- </dd>
376
- </dl>
377
-
378
352
  #### 🔌 Usage
379
353
 
380
354
  <dl>
@@ -384,16 +358,20 @@ Lists voices you have saved in your account, or voices from the [Voice Library](
384
358
  <dd>
385
359
 
386
360
  ```typescript
387
- const pageableResponse = await client.tts.voices.list({
388
- provider: "CUSTOM_VOICE"
361
+ const pageableResponse = await client.empathicVoice.chats.listChats({
362
+ pageNumber: 0,
363
+ pageSize: 1,
364
+ ascendingOrder: true
389
365
  });
390
366
  for await (const item of pageableResponse) {
391
367
  console.log(item);
392
368
  }
393
369
 
394
370
  // Or you can manually iterate page-by-page
395
- let page = await client.tts.voices.list({
396
- provider: "CUSTOM_VOICE"
371
+ let page = await client.empathicVoice.chats.listChats({
372
+ pageNumber: 0,
373
+ pageSize: 1,
374
+ ascendingOrder: true
397
375
  });
398
376
  while (page.hasNextPage()) {
399
377
  page = page.getNextPage();
@@ -416,7 +394,7 @@ const response = page.response;
416
394
  <dl>
417
395
  <dd>
418
396
 
419
- **request:** `Hume.tts.VoicesListRequest`
397
+ **request:** `Hume.empathicVoice.ChatsListChatsRequest`
420
398
 
421
399
  </dd>
422
400
  </dl>
@@ -424,7 +402,7 @@ const response = page.response;
424
402
  <dl>
425
403
  <dd>
426
404
 
427
- **requestOptions:** `Voices.RequestOptions`
405
+ **requestOptions:** `ChatsClient.RequestOptions`
428
406
 
429
407
  </dd>
430
408
  </dl>
@@ -436,26 +414,10 @@ const response = page.response;
436
414
  </dl>
437
415
  </details>
438
416
 
439
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
440
- <dl>
441
- <dd>
442
-
443
- #### 📝 Description
444
-
445
- <dl>
446
- <dd>
447
-
417
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatPagedEvents></code></summary>
448
418
  <dl>
449
419
  <dd>
450
420
 
451
- Saves a new custom voice to your account using the specified TTS generation ID.
452
-
453
- Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
454
- </dd>
455
- </dl>
456
- </dd>
457
- </dl>
458
-
459
421
  #### 🔌 Usage
460
422
 
461
423
  <dl>
@@ -465,10 +427,27 @@ Once saved, this voice can be reused in subsequent TTS requests, ensuring consis
465
427
  <dd>
466
428
 
467
429
  ```typescript
468
- await client.tts.voices.create({
469
- generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
470
- name: "David Hume"
430
+ const pageableResponse = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
431
+ pageNumber: 0,
432
+ pageSize: 3,
433
+ ascendingOrder: true
471
434
  });
435
+ for await (const item of pageableResponse) {
436
+ console.log(item);
437
+ }
438
+
439
+ // Or you can manually iterate page-by-page
440
+ let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
441
+ pageNumber: 0,
442
+ pageSize: 3,
443
+ ascendingOrder: true
444
+ });
445
+ while (page.hasNextPage()) {
446
+ page = page.getNextPage();
447
+ }
448
+
449
+ // You can also access the underlying response
450
+ const response = page.response;
472
451
 
473
452
  ```
474
453
  </dd>
@@ -484,7 +463,15 @@ await client.tts.voices.create({
484
463
  <dl>
485
464
  <dd>
486
465
 
487
- **request:** `Hume.tts.PostedVoice`
466
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
467
+
468
+ </dd>
469
+ </dl>
470
+
471
+ <dl>
472
+ <dd>
473
+
474
+ **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
488
475
 
489
476
  </dd>
490
477
  </dl>
@@ -492,7 +479,7 @@ await client.tts.voices.create({
492
479
  <dl>
493
480
  <dd>
494
481
 
495
- **requestOptions:** `Voices.RequestOptions`
482
+ **requestOptions:** `ChatsClient.RequestOptions`
496
483
 
497
484
  </dd>
498
485
  </dl>
@@ -504,24 +491,10 @@ await client.tts.voices.create({
504
491
  </dl>
505
492
  </details>
506
493
 
507
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
508
- <dl>
509
- <dd>
510
-
511
- #### 📝 Description
512
-
513
- <dl>
514
- <dd>
515
-
494
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
516
495
  <dl>
517
496
  <dd>
518
497
 
519
- Deletes a previously generated custom voice.
520
- </dd>
521
- </dl>
522
- </dd>
523
- </dl>
524
-
525
498
  #### 🔌 Usage
526
499
 
527
500
  <dl>
@@ -531,9 +504,7 @@ Deletes a previously generated custom voice.
531
504
  <dd>
532
505
 
533
506
  ```typescript
534
- await client.tts.voices.delete({
535
- name: "David Hume"
536
- });
507
+ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
537
508
 
538
509
  ```
539
510
  </dd>
@@ -549,7 +520,7 @@ await client.tts.voices.delete({
549
520
  <dl>
550
521
  <dd>
551
522
 
552
- **request:** `Hume.tts.VoicesDeleteRequest`
523
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
553
524
 
554
525
  </dd>
555
526
  </dl>
@@ -557,7 +528,7 @@ await client.tts.voices.delete({
557
528
  <dl>
558
529
  <dd>
559
530
 
560
- **requestOptions:** `Voices.RequestOptions`
531
+ **requestOptions:** `ChatsClient.RequestOptions`
561
532
 
562
533
  </dd>
563
534
  </dl>
@@ -569,25 +540,11 @@ await client.tts.voices.delete({
569
540
  </dl>
570
541
  </details>
571
542
 
572
- ## EmpathicVoice ControlPlane
573
- <details><summary><code>client.empathicVoice.controlPlane.<a href="/src/api/resources/empathicVoice/resources/controlPlane/client/Client.ts">send</a>(chatId, { ...params }) -> void</code></summary>
574
- <dl>
575
- <dd>
576
-
577
- #### 📝 Description
578
-
579
- <dl>
580
- <dd>
581
-
543
+ ## EmpathicVoice Configs
544
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
582
545
  <dl>
583
546
  <dd>
584
547
 
585
- Send a message to a specific chat.
586
- </dd>
587
- </dl>
588
- </dd>
589
- </dl>
590
-
591
548
  #### 🔌 Usage
592
549
 
593
550
  <dl>
@@ -597,9 +554,25 @@ Send a message to a specific chat.
597
554
  <dd>
598
555
 
599
556
  ```typescript
600
- await client.empathicVoice.controlPlane.send("chat_id", {
601
- type: "session_settings"
557
+ const pageableResponse = await client.empathicVoice.configs.listConfigs({
558
+ pageNumber: 0,
559
+ pageSize: 1
560
+ });
561
+ for await (const item of pageableResponse) {
562
+ console.log(item);
563
+ }
564
+
565
+ // Or you can manually iterate page-by-page
566
+ let page = await client.empathicVoice.configs.listConfigs({
567
+ pageNumber: 0,
568
+ pageSize: 1
602
569
  });
570
+ while (page.hasNextPage()) {
571
+ page = page.getNextPage();
572
+ }
573
+
574
+ // You can also access the underlying response
575
+ const response = page.response;
603
576
 
604
577
  ```
605
578
  </dd>
@@ -615,15 +588,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
615
588
  <dl>
616
589
  <dd>
617
590
 
618
- **chatId:** `string`
619
-
620
- </dd>
621
- </dl>
622
-
623
- <dl>
624
- <dd>
625
-
626
- **request:** `Hume.ControlPlanePublishEvent`
591
+ **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
627
592
 
628
593
  </dd>
629
594
  </dl>
@@ -631,7 +596,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
631
596
  <dl>
632
597
  <dd>
633
598
 
634
- **requestOptions:** `ControlPlane.RequestOptions`
599
+ **requestOptions:** `ConfigsClient.RequestOptions`
635
600
 
636
601
  </dd>
637
602
  </dl>
@@ -643,25 +608,10 @@ await client.empathicVoice.controlPlane.send("chat_id", {
643
608
  </dl>
644
609
  </details>
645
610
 
646
- ## EmpathicVoice ChatGroups
647
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
648
- <dl>
649
- <dd>
650
-
651
- #### 📝 Description
652
-
653
- <dl>
654
- <dd>
655
-
611
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
656
612
  <dl>
657
613
  <dd>
658
614
 
659
- Fetches a paginated list of **Chat Groups**.
660
- </dd>
661
- </dl>
662
- </dd>
663
- </dl>
664
-
665
615
  #### 🔌 Usage
666
616
 
667
617
  <dl>
@@ -671,29 +621,37 @@ Fetches a paginated list of **Chat Groups**.
671
621
  <dd>
672
622
 
673
623
  ```typescript
674
- const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
675
- pageNumber: 0,
676
- pageSize: 1,
677
- ascendingOrder: true,
678
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
679
- });
680
- for await (const item of pageableResponse) {
681
- console.log(item);
682
- }
683
-
684
- // Or you can manually iterate page-by-page
685
- let page = await client.empathicVoice.chatGroups.listChatGroups({
686
- pageNumber: 0,
687
- pageSize: 1,
688
- ascendingOrder: true,
689
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
624
+ await client.empathicVoice.configs.createConfig({
625
+ name: "Weather Assistant Config",
626
+ prompt: {
627
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
628
+ version: 0
629
+ },
630
+ eviVersion: "3",
631
+ voice: {
632
+ provider: "HUME_AI",
633
+ name: "Ava Song"
634
+ },
635
+ languageModel: {
636
+ modelProvider: "ANTHROPIC",
637
+ modelResource: "claude-3-7-sonnet-latest",
638
+ temperature: 1
639
+ },
640
+ eventMessages: {
641
+ onNewChat: {
642
+ enabled: false,
643
+ text: ""
644
+ },
645
+ onInactivityTimeout: {
646
+ enabled: false,
647
+ text: ""
648
+ },
649
+ onMaxDurationTimeout: {
650
+ enabled: false,
651
+ text: ""
652
+ }
653
+ }
690
654
  });
691
- while (page.hasNextPage()) {
692
- page = page.getNextPage();
693
- }
694
-
695
- // You can also access the underlying response
696
- const response = page.response;
697
655
 
698
656
  ```
699
657
  </dd>
@@ -709,7 +667,7 @@ const response = page.response;
709
667
  <dl>
710
668
  <dd>
711
669
 
712
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
670
+ **request:** `Hume.empathicVoice.PostedConfig`
713
671
 
714
672
  </dd>
715
673
  </dl>
@@ -717,7 +675,7 @@ const response = page.response;
717
675
  <dl>
718
676
  <dd>
719
677
 
720
- **requestOptions:** `ChatGroups.RequestOptions`
678
+ **requestOptions:** `ConfigsClient.RequestOptions`
721
679
 
722
680
  </dd>
723
681
  </dl>
@@ -729,24 +687,10 @@ const response = page.response;
729
687
  </dl>
730
688
  </details>
731
689
 
732
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
733
- <dl>
734
- <dd>
735
-
736
- #### 📝 Description
737
-
738
- <dl>
739
- <dd>
740
-
690
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
741
691
  <dl>
742
692
  <dd>
743
693
 
744
- Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
745
- </dd>
746
- </dl>
747
- </dd>
748
- </dl>
749
-
750
694
  #### 🔌 Usage
751
695
 
752
696
  <dl>
@@ -756,11 +700,19 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
756
700
  <dd>
757
701
 
758
702
  ```typescript
759
- await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
760
- pageNumber: 0,
761
- pageSize: 1,
762
- ascendingOrder: true
763
- });
703
+ const pageableResponse = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
704
+ for await (const item of pageableResponse) {
705
+ console.log(item);
706
+ }
707
+
708
+ // Or you can manually iterate page-by-page
709
+ let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
710
+ while (page.hasNextPage()) {
711
+ page = page.getNextPage();
712
+ }
713
+
714
+ // You can also access the underlying response
715
+ const response = page.response;
764
716
 
765
717
  ```
766
718
  </dd>
@@ -776,7 +728,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
776
728
  <dl>
777
729
  <dd>
778
730
 
779
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
731
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
780
732
 
781
733
  </dd>
782
734
  </dl>
@@ -784,7 +736,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
784
736
  <dl>
785
737
  <dd>
786
738
 
787
- **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
739
+ **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
788
740
 
789
741
  </dd>
790
742
  </dl>
@@ -792,7 +744,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
792
744
  <dl>
793
745
  <dd>
794
746
 
795
- **requestOptions:** `ChatGroups.RequestOptions`
747
+ **requestOptions:** `ConfigsClient.RequestOptions`
796
748
 
797
749
  </dd>
798
750
  </dl>
@@ -804,24 +756,10 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
804
756
  </dl>
805
757
  </details>
806
758
 
807
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
808
- <dl>
809
- <dd>
810
-
811
- #### 📝 Description
812
-
813
- <dl>
814
- <dd>
815
-
759
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
816
760
  <dl>
817
761
  <dd>
818
762
 
819
- Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
820
- </dd>
821
- </dl>
822
- </dd>
823
- </dl>
824
-
825
763
  #### 🔌 Usage
826
764
 
827
765
  <dl>
@@ -831,10 +769,39 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
831
769
  <dd>
832
770
 
833
771
  ```typescript
834
- await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
835
- pageNumber: 0,
836
- pageSize: 10,
837
- ascendingOrder: true
772
+ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
773
+ versionDescription: "This is an updated version of the Weather Assistant Config.",
774
+ eviVersion: "3",
775
+ prompt: {
776
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
777
+ version: 0
778
+ },
779
+ voice: {
780
+ provider: "HUME_AI",
781
+ name: "Ava Song"
782
+ },
783
+ languageModel: {
784
+ modelProvider: "ANTHROPIC",
785
+ modelResource: "claude-3-7-sonnet-latest",
786
+ temperature: 1
787
+ },
788
+ ellmModel: {
789
+ allowShortResponses: true
790
+ },
791
+ eventMessages: {
792
+ onNewChat: {
793
+ enabled: false,
794
+ text: ""
795
+ },
796
+ onInactivityTimeout: {
797
+ enabled: false,
798
+ text: ""
799
+ },
800
+ onMaxDurationTimeout: {
801
+ enabled: false,
802
+ text: ""
803
+ }
804
+ }
838
805
  });
839
806
 
840
807
  ```
@@ -851,7 +818,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
851
818
  <dl>
852
819
  <dd>
853
820
 
854
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
821
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
855
822
 
856
823
  </dd>
857
824
  </dl>
@@ -859,7 +826,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
859
826
  <dl>
860
827
  <dd>
861
828
 
862
- **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
829
+ **request:** `Hume.empathicVoice.PostedConfigVersion`
863
830
 
864
831
  </dd>
865
832
  </dl>
@@ -867,7 +834,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
867
834
  <dl>
868
835
  <dd>
869
836
 
870
- **requestOptions:** `ChatGroups.RequestOptions`
837
+ **requestOptions:** `ConfigsClient.RequestOptions`
871
838
 
872
839
  </dd>
873
840
  </dl>
@@ -879,24 +846,10 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
879
846
  </dl>
880
847
  </details>
881
848
 
882
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
849
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
883
850
  <dl>
884
851
  <dd>
885
852
 
886
- #### 📝 Description
887
-
888
- <dl>
889
- <dd>
890
-
891
- <dl>
892
- <dd>
893
-
894
- Fetches a paginated list of **Chat** events associated with a **Chat Group**.
895
- </dd>
896
- </dl>
897
- </dd>
898
- </dl>
899
-
900
853
  #### 🔌 Usage
901
854
 
902
855
  <dl>
@@ -906,27 +859,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
906
859
  <dd>
907
860
 
908
861
  ```typescript
909
- const pageableResponse = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
910
- pageNumber: 0,
911
- pageSize: 3,
912
- ascendingOrder: true
913
- });
914
- for await (const item of pageableResponse) {
915
- console.log(item);
916
- }
917
-
918
- // Or you can manually iterate page-by-page
919
- let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
920
- pageNumber: 0,
921
- pageSize: 3,
922
- ascendingOrder: true
923
- });
924
- while (page.hasNextPage()) {
925
- page = page.getNextPage();
926
- }
927
-
928
- // You can also access the underlying response
929
- const response = page.response;
862
+ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
930
863
 
931
864
  ```
932
865
  </dd>
@@ -942,7 +875,7 @@ const response = page.response;
942
875
  <dl>
943
876
  <dd>
944
877
 
945
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
878
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
946
879
 
947
880
  </dd>
948
881
  </dl>
@@ -950,15 +883,7 @@ const response = page.response;
950
883
  <dl>
951
884
  <dd>
952
885
 
953
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
954
-
955
- </dd>
956
- </dl>
957
-
958
- <dl>
959
- <dd>
960
-
961
- **requestOptions:** `ChatGroups.RequestOptions`
886
+ **requestOptions:** `ConfigsClient.RequestOptions`
962
887
 
963
888
  </dd>
964
889
  </dl>
@@ -970,25 +895,10 @@ const response = page.response;
970
895
  </dl>
971
896
  </details>
972
897
 
973
- ## EmpathicVoice Chats
974
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
975
- <dl>
976
- <dd>
977
-
978
- #### 📝 Description
979
-
980
- <dl>
981
- <dd>
982
-
898
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
983
899
  <dl>
984
900
  <dd>
985
901
 
986
- Fetches a paginated list of **Chats**.
987
- </dd>
988
- </dl>
989
- </dd>
990
- </dl>
991
-
992
902
  #### 🔌 Usage
993
903
 
994
904
  <dl>
@@ -998,27 +908,9 @@ Fetches a paginated list of **Chats**.
998
908
  <dd>
999
909
 
1000
910
  ```typescript
1001
- const pageableResponse = await client.empathicVoice.chats.listChats({
1002
- pageNumber: 0,
1003
- pageSize: 1,
1004
- ascendingOrder: true
1005
- });
1006
- for await (const item of pageableResponse) {
1007
- console.log(item);
1008
- }
1009
-
1010
- // Or you can manually iterate page-by-page
1011
- let page = await client.empathicVoice.chats.listChats({
1012
- pageNumber: 0,
1013
- pageSize: 1,
1014
- ascendingOrder: true
911
+ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
912
+ name: "Updated Weather Assistant Config Name"
1015
913
  });
1016
- while (page.hasNextPage()) {
1017
- page = page.getNextPage();
1018
- }
1019
-
1020
- // You can also access the underlying response
1021
- const response = page.response;
1022
914
 
1023
915
  ```
1024
916
  </dd>
@@ -1034,7 +926,7 @@ const response = page.response;
1034
926
  <dl>
1035
927
  <dd>
1036
928
 
1037
- **request:** `Hume.empathicVoice.ChatsListChatsRequest`
929
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
1038
930
 
1039
931
  </dd>
1040
932
  </dl>
@@ -1042,7 +934,15 @@ const response = page.response;
1042
934
  <dl>
1043
935
  <dd>
1044
936
 
1045
- **requestOptions:** `Chats.RequestOptions`
937
+ **request:** `Hume.empathicVoice.PostedConfigName`
938
+
939
+ </dd>
940
+ </dl>
941
+
942
+ <dl>
943
+ <dd>
944
+
945
+ **requestOptions:** `ConfigsClient.RequestOptions`
1046
946
 
1047
947
  </dd>
1048
948
  </dl>
@@ -1054,24 +954,10 @@ const response = page.response;
1054
954
  </dl>
1055
955
  </details>
1056
956
 
1057
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatPagedEvents></code></summary>
1058
- <dl>
1059
- <dd>
1060
-
1061
- #### 📝 Description
1062
-
1063
- <dl>
1064
- <dd>
1065
-
957
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
1066
958
  <dl>
1067
959
  <dd>
1068
960
 
1069
- Fetches a paginated list of **Chat** events.
1070
- </dd>
1071
- </dl>
1072
- </dd>
1073
- </dl>
1074
-
1075
961
  #### 🔌 Usage
1076
962
 
1077
963
  <dl>
@@ -1081,27 +967,7 @@ Fetches a paginated list of **Chat** events.
1081
967
  <dd>
1082
968
 
1083
969
  ```typescript
1084
- const pageableResponse = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
1085
- pageNumber: 0,
1086
- pageSize: 3,
1087
- ascendingOrder: true
1088
- });
1089
- for await (const item of pageableResponse) {
1090
- console.log(item);
1091
- }
1092
-
1093
- // Or you can manually iterate page-by-page
1094
- let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
1095
- pageNumber: 0,
1096
- pageSize: 3,
1097
- ascendingOrder: true
1098
- });
1099
- while (page.hasNextPage()) {
1100
- page = page.getNextPage();
1101
- }
1102
-
1103
- // You can also access the underlying response
1104
- const response = page.response;
970
+ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1105
971
 
1106
972
  ```
1107
973
  </dd>
@@ -1117,7 +983,7 @@ const response = page.response;
1117
983
  <dl>
1118
984
  <dd>
1119
985
 
1120
- **id:** `string` — Identifier for a Chat. Formatted as a UUID.
986
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
1121
987
 
1122
988
  </dd>
1123
989
  </dl>
@@ -1125,7 +991,7 @@ const response = page.response;
1125
991
  <dl>
1126
992
  <dd>
1127
993
 
1128
- **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
994
+ **version:** `number` — Version number for a config. Version numbers should be integers.
1129
995
 
1130
996
  </dd>
1131
997
  </dl>
@@ -1133,7 +999,7 @@ const response = page.response;
1133
999
  <dl>
1134
1000
  <dd>
1135
1001
 
1136
- **requestOptions:** `Chats.RequestOptions`
1002
+ **requestOptions:** `ConfigsClient.RequestOptions`
1137
1003
 
1138
1004
  </dd>
1139
1005
  </dl>
@@ -1145,11 +1011,11 @@ const response = page.response;
1145
1011
  </dl>
1146
1012
  </details>
1147
1013
 
1148
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
1014
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
1149
1015
  <dl>
1150
1016
  <dd>
1151
1017
 
1152
- #### 📝 Description
1018
+ #### 🔌 Usage
1153
1019
 
1154
1020
  <dl>
1155
1021
  <dd>
@@ -1157,13 +1023,16 @@ const response = page.response;
1157
1023
  <dl>
1158
1024
  <dd>
1159
1025
 
1160
- Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
1026
+ ```typescript
1027
+ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1028
+
1029
+ ```
1161
1030
  </dd>
1162
1031
  </dl>
1163
1032
  </dd>
1164
1033
  </dl>
1165
1034
 
1166
- #### 🔌 Usage
1035
+ #### ⚙️ Parameters
1167
1036
 
1168
1037
  <dl>
1169
1038
  <dd>
@@ -1171,24 +1040,15 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
1171
1040
  <dl>
1172
1041
  <dd>
1173
1042
 
1174
- ```typescript
1175
- await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
1176
-
1177
- ```
1178
- </dd>
1179
- </dl>
1043
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
1044
+
1180
1045
  </dd>
1181
1046
  </dl>
1182
1047
 
1183
- #### ⚙️ Parameters
1184
-
1185
1048
  <dl>
1186
1049
  <dd>
1187
1050
 
1188
- <dl>
1189
- <dd>
1190
-
1191
- **id:** `string` — Identifier for a chat. Formatted as a UUID.
1051
+ **version:** `number` — Version number for a config. Version numbers should be integers.
1192
1052
 
1193
1053
  </dd>
1194
1054
  </dl>
@@ -1196,7 +1056,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
1196
1056
  <dl>
1197
1057
  <dd>
1198
1058
 
1199
- **requestOptions:** `Chats.RequestOptions`
1059
+ **requestOptions:** `ConfigsClient.RequestOptions`
1200
1060
 
1201
1061
  </dd>
1202
1062
  </dl>
@@ -1208,12 +1068,11 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
1208
1068
  </dl>
1209
1069
  </details>
1210
1070
 
1211
- ## EmpathicVoice Configs
1212
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
1071
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
1213
1072
  <dl>
1214
1073
  <dd>
1215
1074
 
1216
- #### 📝 Description
1075
+ #### 🔌 Usage
1217
1076
 
1218
1077
  <dl>
1219
1078
  <dd>
@@ -1221,15 +1080,18 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
1221
1080
  <dl>
1222
1081
  <dd>
1223
1082
 
1224
- Fetches a paginated list of **Configs**.
1083
+ ```typescript
1084
+ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
1085
+ versionDescription: "This is an updated version_description."
1086
+ });
1225
1087
 
1226
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1088
+ ```
1227
1089
  </dd>
1228
1090
  </dl>
1229
1091
  </dd>
1230
1092
  </dl>
1231
1093
 
1232
- #### 🔌 Usage
1094
+ #### ⚙️ Parameters
1233
1095
 
1234
1096
  <dl>
1235
1097
  <dd>
@@ -1237,42 +1099,23 @@ For more details on configuration options and how to configure EVI, see our [con
1237
1099
  <dl>
1238
1100
  <dd>
1239
1101
 
1240
- ```typescript
1241
- const pageableResponse = await client.empathicVoice.configs.listConfigs({
1242
- pageNumber: 0,
1243
- pageSize: 1
1244
- });
1245
- for await (const item of pageableResponse) {
1246
- console.log(item);
1247
- }
1248
-
1249
- // Or you can manually iterate page-by-page
1250
- let page = await client.empathicVoice.configs.listConfigs({
1251
- pageNumber: 0,
1252
- pageSize: 1
1253
- });
1254
- while (page.hasNextPage()) {
1255
- page = page.getNextPage();
1256
- }
1257
-
1258
- // You can also access the underlying response
1259
- const response = page.response;
1260
-
1261
- ```
1262
- </dd>
1263
- </dl>
1102
+ **id:** `string` — Identifier for a config. Formatted as a UUID.
1103
+
1264
1104
  </dd>
1265
1105
  </dl>
1266
1106
 
1267
- #### ⚙️ Parameters
1268
-
1269
1107
  <dl>
1270
1108
  <dd>
1271
1109
 
1110
+ **version:** `number` — Version number for a config. Version numbers should be integers.
1111
+
1112
+ </dd>
1113
+ </dl>
1114
+
1272
1115
  <dl>
1273
1116
  <dd>
1274
1117
 
1275
- **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
1118
+ **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
1276
1119
 
1277
1120
  </dd>
1278
1121
  </dl>
@@ -1280,7 +1123,7 @@ const response = page.response;
1280
1123
  <dl>
1281
1124
  <dd>
1282
1125
 
1283
- **requestOptions:** `Configs.RequestOptions`
1126
+ **requestOptions:** `ConfigsClient.RequestOptions`
1284
1127
 
1285
1128
  </dd>
1286
1129
  </dl>
@@ -1292,26 +1135,11 @@ const response = page.response;
1292
1135
  </dl>
1293
1136
  </details>
1294
1137
 
1295
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
1296
- <dl>
1297
- <dd>
1298
-
1299
- #### 📝 Description
1300
-
1301
- <dl>
1302
- <dd>
1303
-
1138
+ ## EmpathicVoice Prompts
1139
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts></code></summary>
1304
1140
  <dl>
1305
1141
  <dd>
1306
1142
 
1307
- Creates a **Config** which can be applied to EVI.
1308
-
1309
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1310
- </dd>
1311
- </dl>
1312
- </dd>
1313
- </dl>
1314
-
1315
1143
  #### 🔌 Usage
1316
1144
 
1317
1145
  <dl>
@@ -1321,37 +1149,25 @@ For more details on configuration options and how to configure EVI, see our [con
1321
1149
  <dd>
1322
1150
 
1323
1151
  ```typescript
1324
- await client.empathicVoice.configs.createConfig({
1325
- name: "Weather Assistant Config",
1326
- prompt: {
1327
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1328
- version: 0
1329
- },
1330
- eviVersion: "3",
1331
- voice: {
1332
- provider: "HUME_AI",
1333
- name: "Ava Song"
1334
- },
1335
- languageModel: {
1336
- modelProvider: "ANTHROPIC",
1337
- modelResource: "claude-3-7-sonnet-latest",
1338
- temperature: 1
1339
- },
1340
- eventMessages: {
1341
- onNewChat: {
1342
- enabled: false,
1343
- text: ""
1344
- },
1345
- onInactivityTimeout: {
1346
- enabled: false,
1347
- text: ""
1348
- },
1349
- onMaxDurationTimeout: {
1350
- enabled: false,
1351
- text: ""
1352
- }
1353
- }
1152
+ const pageableResponse = await client.empathicVoice.prompts.listPrompts({
1153
+ pageNumber: 0,
1154
+ pageSize: 2
1354
1155
  });
1156
+ for await (const item of pageableResponse) {
1157
+ console.log(item);
1158
+ }
1159
+
1160
+ // Or you can manually iterate page-by-page
1161
+ let page = await client.empathicVoice.prompts.listPrompts({
1162
+ pageNumber: 0,
1163
+ pageSize: 2
1164
+ });
1165
+ while (page.hasNextPage()) {
1166
+ page = page.getNextPage();
1167
+ }
1168
+
1169
+ // You can also access the underlying response
1170
+ const response = page.response;
1355
1171
 
1356
1172
  ```
1357
1173
  </dd>
@@ -1367,7 +1183,7 @@ await client.empathicVoice.configs.createConfig({
1367
1183
  <dl>
1368
1184
  <dd>
1369
1185
 
1370
- **request:** `Hume.empathicVoice.PostedConfig`
1186
+ **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1371
1187
 
1372
1188
  </dd>
1373
1189
  </dl>
@@ -1375,7 +1191,7 @@ await client.empathicVoice.configs.createConfig({
1375
1191
  <dl>
1376
1192
  <dd>
1377
1193
 
1378
- **requestOptions:** `Configs.RequestOptions`
1194
+ **requestOptions:** `PromptsClient.RequestOptions`
1379
1195
 
1380
1196
  </dd>
1381
1197
  </dl>
@@ -1387,26 +1203,10 @@ await client.empathicVoice.configs.createConfig({
1387
1203
  </dl>
1388
1204
  </details>
1389
1205
 
1390
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
1391
- <dl>
1392
- <dd>
1393
-
1394
- #### 📝 Description
1395
-
1396
- <dl>
1397
- <dd>
1398
-
1206
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1399
1207
  <dl>
1400
1208
  <dd>
1401
1209
 
1402
- Fetches a list of a **Config's** versions.
1403
-
1404
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1405
- </dd>
1406
- </dl>
1407
- </dd>
1408
- </dl>
1409
-
1410
1210
  #### 🔌 Usage
1411
1211
 
1412
1212
  <dl>
@@ -1416,19 +1216,10 @@ For more details on configuration options and how to configure EVI, see our [con
1416
1216
  <dd>
1417
1217
 
1418
1218
  ```typescript
1419
- const pageableResponse = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1420
- for await (const item of pageableResponse) {
1421
- console.log(item);
1422
- }
1423
-
1424
- // Or you can manually iterate page-by-page
1425
- let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1426
- while (page.hasNextPage()) {
1427
- page = page.getNextPage();
1428
- }
1429
-
1430
- // You can also access the underlying response
1431
- const response = page.response;
1219
+ await client.empathicVoice.prompts.createPrompt({
1220
+ name: "Weather Assistant Prompt",
1221
+ text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
1222
+ });
1432
1223
 
1433
1224
  ```
1434
1225
  </dd>
@@ -1444,15 +1235,7 @@ const response = page.response;
1444
1235
  <dl>
1445
1236
  <dd>
1446
1237
 
1447
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1448
-
1449
- </dd>
1450
- </dl>
1451
-
1452
- <dl>
1453
- <dd>
1454
-
1455
- **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
1238
+ **request:** `Hume.empathicVoice.PostedPrompt`
1456
1239
 
1457
1240
  </dd>
1458
1241
  </dl>
@@ -1460,7 +1243,7 @@ const response = page.response;
1460
1243
  <dl>
1461
1244
  <dd>
1462
1245
 
1463
- **requestOptions:** `Configs.RequestOptions`
1246
+ **requestOptions:** `PromptsClient.RequestOptions`
1464
1247
 
1465
1248
  </dd>
1466
1249
  </dl>
@@ -1472,26 +1255,10 @@ const response = page.response;
1472
1255
  </dl>
1473
1256
  </details>
1474
1257
 
1475
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
1476
- <dl>
1477
- <dd>
1478
-
1479
- #### 📝 Description
1480
-
1481
- <dl>
1482
- <dd>
1483
-
1258
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
1484
1259
  <dl>
1485
1260
  <dd>
1486
1261
 
1487
- Updates a **Config** by creating a new version of the **Config**.
1488
-
1489
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1490
- </dd>
1491
- </dl>
1492
- </dd>
1493
- </dl>
1494
-
1495
1262
  #### 🔌 Usage
1496
1263
 
1497
1264
  <dl>
@@ -1501,40 +1268,7 @@ For more details on configuration options and how to configure EVI, see our [con
1501
1268
  <dd>
1502
1269
 
1503
1270
  ```typescript
1504
- await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1505
- versionDescription: "This is an updated version of the Weather Assistant Config.",
1506
- eviVersion: "3",
1507
- prompt: {
1508
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1509
- version: 0
1510
- },
1511
- voice: {
1512
- provider: "HUME_AI",
1513
- name: "Ava Song"
1514
- },
1515
- languageModel: {
1516
- modelProvider: "ANTHROPIC",
1517
- modelResource: "claude-3-7-sonnet-latest",
1518
- temperature: 1
1519
- },
1520
- ellmModel: {
1521
- allowShortResponses: true
1522
- },
1523
- eventMessages: {
1524
- onNewChat: {
1525
- enabled: false,
1526
- text: ""
1527
- },
1528
- onInactivityTimeout: {
1529
- enabled: false,
1530
- text: ""
1531
- },
1532
- onMaxDurationTimeout: {
1533
- enabled: false,
1534
- text: ""
1535
- }
1536
- }
1537
- });
1271
+ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1538
1272
 
1539
1273
  ```
1540
1274
  </dd>
@@ -1550,7 +1284,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
1550
1284
  <dl>
1551
1285
  <dd>
1552
1286
 
1553
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1287
+ **id:** `string`
1554
1288
 
1555
1289
  </dd>
1556
1290
  </dl>
@@ -1558,7 +1292,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
1558
1292
  <dl>
1559
1293
  <dd>
1560
1294
 
1561
- **request:** `Hume.empathicVoice.PostedConfigVersion`
1295
+ **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1562
1296
 
1563
1297
  </dd>
1564
1298
  </dl>
@@ -1566,7 +1300,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
1566
1300
  <dl>
1567
1301
  <dd>
1568
1302
 
1569
- **requestOptions:** `Configs.RequestOptions`
1303
+ **requestOptions:** `PromptsClient.RequestOptions`
1570
1304
 
1571
1305
  </dd>
1572
1306
  </dl>
@@ -1578,11 +1312,11 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
1578
1312
  </dl>
1579
1313
  </details>
1580
1314
 
1581
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
1315
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1582
1316
  <dl>
1583
1317
  <dd>
1584
1318
 
1585
- #### 📝 Description
1319
+ #### 🔌 Usage
1586
1320
 
1587
1321
  <dl>
1588
1322
  <dd>
@@ -1590,15 +1324,19 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
1590
1324
  <dl>
1591
1325
  <dd>
1592
1326
 
1593
- Deletes a **Config** and its versions.
1327
+ ```typescript
1328
+ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1329
+ text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
1330
+ versionDescription: "This is an updated version of the Weather Assistant Prompt."
1331
+ });
1594
1332
 
1595
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1333
+ ```
1596
1334
  </dd>
1597
1335
  </dl>
1598
1336
  </dd>
1599
1337
  </dl>
1600
1338
 
1601
- #### 🔌 Usage
1339
+ #### ⚙️ Parameters
1602
1340
 
1603
1341
  <dl>
1604
1342
  <dd>
@@ -1606,24 +1344,15 @@ For more details on configuration options and how to configure EVI, see our [con
1606
1344
  <dl>
1607
1345
  <dd>
1608
1346
 
1609
- ```typescript
1610
- await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1611
-
1612
- ```
1613
- </dd>
1614
- </dl>
1347
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
1348
+
1615
1349
  </dd>
1616
1350
  </dl>
1617
1351
 
1618
- #### ⚙️ Parameters
1619
-
1620
- <dl>
1621
- <dd>
1622
-
1623
1352
  <dl>
1624
1353
  <dd>
1625
1354
 
1626
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1355
+ **request:** `Hume.empathicVoice.PostedPromptVersion`
1627
1356
 
1628
1357
  </dd>
1629
1358
  </dl>
@@ -1631,7 +1360,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
1631
1360
  <dl>
1632
1361
  <dd>
1633
1362
 
1634
- **requestOptions:** `Configs.RequestOptions`
1363
+ **requestOptions:** `PromptsClient.RequestOptions`
1635
1364
 
1636
1365
  </dd>
1637
1366
  </dl>
@@ -1643,26 +1372,10 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
1643
1372
  </dl>
1644
1373
  </details>
1645
1374
 
1646
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
1647
- <dl>
1648
- <dd>
1649
-
1650
- #### 📝 Description
1651
-
1652
- <dl>
1653
- <dd>
1654
-
1375
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1655
1376
  <dl>
1656
1377
  <dd>
1657
1378
 
1658
- Updates the name of a **Config**.
1659
-
1660
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1661
- </dd>
1662
- </dl>
1663
- </dd>
1664
- </dl>
1665
-
1666
1379
  #### 🔌 Usage
1667
1380
 
1668
1381
  <dl>
@@ -1672,9 +1385,7 @@ For more details on configuration options and how to configure EVI, see our [con
1672
1385
  <dd>
1673
1386
 
1674
1387
  ```typescript
1675
- await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1676
- name: "Updated Weather Assistant Config Name"
1677
- });
1388
+ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1678
1389
 
1679
1390
  ```
1680
1391
  </dd>
@@ -1690,15 +1401,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
1690
1401
  <dl>
1691
1402
  <dd>
1692
1403
 
1693
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1694
-
1695
- </dd>
1696
- </dl>
1697
-
1698
- <dl>
1699
- <dd>
1700
-
1701
- **request:** `Hume.empathicVoice.PostedConfigName`
1404
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
1702
1405
 
1703
1406
  </dd>
1704
1407
  </dl>
@@ -1706,7 +1409,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
1706
1409
  <dl>
1707
1410
  <dd>
1708
1411
 
1709
- **requestOptions:** `Configs.RequestOptions`
1412
+ **requestOptions:** `PromptsClient.RequestOptions`
1710
1413
 
1711
1414
  </dd>
1712
1415
  </dl>
@@ -1718,26 +1421,10 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
1718
1421
  </dl>
1719
1422
  </details>
1720
1423
 
1721
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
1722
- <dl>
1723
- <dd>
1724
-
1725
- #### 📝 Description
1726
-
1727
- <dl>
1728
- <dd>
1729
-
1424
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1730
1425
  <dl>
1731
1426
  <dd>
1732
1427
 
1733
- Fetches a specified version of a **Config**.
1734
-
1735
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1736
- </dd>
1737
- </dl>
1738
- </dd>
1739
- </dl>
1740
-
1741
1428
  #### 🔌 Usage
1742
1429
 
1743
1430
  <dl>
@@ -1747,7 +1434,9 @@ For more details on configuration options and how to configure EVI, see our [con
1747
1434
  <dd>
1748
1435
 
1749
1436
  ```typescript
1750
- await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1437
+ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1438
+ name: "Updated Weather Assistant Prompt Name"
1439
+ });
1751
1440
 
1752
1441
  ```
1753
1442
  </dd>
@@ -1763,7 +1452,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
1763
1452
  <dl>
1764
1453
  <dd>
1765
1454
 
1766
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1455
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
1767
1456
 
1768
1457
  </dd>
1769
1458
  </dl>
@@ -1771,13 +1460,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
1771
1460
  <dl>
1772
1461
  <dd>
1773
1462
 
1774
- **version:** `number`
1775
-
1776
- Version number for a Config.
1777
-
1778
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
1779
-
1780
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1463
+ **request:** `Hume.empathicVoice.PostedPromptName`
1781
1464
 
1782
1465
  </dd>
1783
1466
  </dl>
@@ -1785,7 +1468,7 @@ Version numbers are integer values representing different iterations of the Conf
1785
1468
  <dl>
1786
1469
  <dd>
1787
1470
 
1788
- **requestOptions:** `Configs.RequestOptions`
1471
+ **requestOptions:** `PromptsClient.RequestOptions`
1789
1472
 
1790
1473
  </dd>
1791
1474
  </dl>
@@ -1797,26 +1480,10 @@ Version numbers are integer values representing different iterations of the Conf
1797
1480
  </dl>
1798
1481
  </details>
1799
1482
 
1800
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
1801
- <dl>
1802
- <dd>
1803
-
1804
- #### 📝 Description
1805
-
1806
- <dl>
1807
- <dd>
1808
-
1483
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
1809
1484
  <dl>
1810
1485
  <dd>
1811
1486
 
1812
- Deletes a specified version of a **Config**.
1813
-
1814
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1815
- </dd>
1816
- </dl>
1817
- </dd>
1818
- </dl>
1819
-
1820
1487
  #### 🔌 Usage
1821
1488
 
1822
1489
  <dl>
@@ -1826,7 +1493,7 @@ For more details on configuration options and how to configure EVI, see our [con
1826
1493
  <dd>
1827
1494
 
1828
1495
  ```typescript
1829
- await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1496
+ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1830
1497
 
1831
1498
  ```
1832
1499
  </dd>
@@ -1842,7 +1509,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
1842
1509
  <dl>
1843
1510
  <dd>
1844
1511
 
1845
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1512
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
1846
1513
 
1847
1514
  </dd>
1848
1515
  </dl>
@@ -1850,13 +1517,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
1850
1517
  <dl>
1851
1518
  <dd>
1852
1519
 
1853
- **version:** `number`
1854
-
1855
- Version number for a Config.
1856
-
1857
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
1858
-
1859
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1520
+ **version:** `number` — Version number for a prompt. Version numbers should be integers.
1860
1521
 
1861
1522
  </dd>
1862
1523
  </dl>
@@ -1864,7 +1525,7 @@ Version numbers are integer values representing different iterations of the Conf
1864
1525
  <dl>
1865
1526
  <dd>
1866
1527
 
1867
- **requestOptions:** `Configs.RequestOptions`
1528
+ **requestOptions:** `PromptsClient.RequestOptions`
1868
1529
 
1869
1530
  </dd>
1870
1531
  </dl>
@@ -1876,26 +1537,10 @@ Version numbers are integer values representing different iterations of the Conf
1876
1537
  </dl>
1877
1538
  </details>
1878
1539
 
1879
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
1880
- <dl>
1881
- <dd>
1882
-
1883
- #### 📝 Description
1884
-
1885
- <dl>
1886
- <dd>
1887
-
1540
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1888
1541
  <dl>
1889
1542
  <dd>
1890
1543
 
1891
- Updates the description of a **Config**.
1892
-
1893
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1894
- </dd>
1895
- </dl>
1896
- </dd>
1897
- </dl>
1898
-
1899
1544
  #### 🔌 Usage
1900
1545
 
1901
1546
  <dl>
@@ -1905,9 +1550,7 @@ For more details on configuration options and how to configure EVI, see our [con
1905
1550
  <dd>
1906
1551
 
1907
1552
  ```typescript
1908
- await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
1909
- versionDescription: "This is an updated version_description."
1910
- });
1553
+ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1911
1554
 
1912
1555
  ```
1913
1556
  </dd>
@@ -1923,21 +1566,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
1923
1566
  <dl>
1924
1567
  <dd>
1925
1568
 
1926
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
1927
-
1928
- </dd>
1929
- </dl>
1930
-
1931
- <dl>
1932
- <dd>
1933
-
1934
- **version:** `number`
1935
-
1936
- Version number for a Config.
1937
-
1938
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
1939
-
1940
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1569
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
1941
1570
 
1942
1571
  </dd>
1943
1572
  </dl>
@@ -1945,7 +1574,7 @@ Version numbers are integer values representing different iterations of the Conf
1945
1574
  <dl>
1946
1575
  <dd>
1947
1576
 
1948
- **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
1577
+ **version:** `number` — Version number for a prompt. Version numbers should be integers.
1949
1578
 
1950
1579
  </dd>
1951
1580
  </dl>
@@ -1953,7 +1582,7 @@ Version numbers are integer values representing different iterations of the Conf
1953
1582
  <dl>
1954
1583
  <dd>
1955
1584
 
1956
- **requestOptions:** `Configs.RequestOptions`
1585
+ **requestOptions:** `PromptsClient.RequestOptions`
1957
1586
 
1958
1587
  </dd>
1959
1588
  </dl>
@@ -1965,27 +1594,10 @@ Version numbers are integer values representing different iterations of the Conf
1965
1594
  </dl>
1966
1595
  </details>
1967
1596
 
1968
- ## EmpathicVoice Prompts
1969
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts></code></summary>
1970
- <dl>
1971
- <dd>
1972
-
1973
- #### 📝 Description
1974
-
1975
- <dl>
1976
- <dd>
1977
-
1597
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1978
1598
  <dl>
1979
1599
  <dd>
1980
1600
 
1981
- Fetches a paginated list of **Prompts**.
1982
-
1983
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1984
- </dd>
1985
- </dl>
1986
- </dd>
1987
- </dl>
1988
-
1989
1601
  #### 🔌 Usage
1990
1602
 
1991
1603
  <dl>
@@ -1995,25 +1607,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1995
1607
  <dd>
1996
1608
 
1997
1609
  ```typescript
1998
- const pageableResponse = await client.empathicVoice.prompts.listPrompts({
1999
- pageNumber: 0,
2000
- pageSize: 2
2001
- });
2002
- for await (const item of pageableResponse) {
2003
- console.log(item);
2004
- }
2005
-
2006
- // Or you can manually iterate page-by-page
2007
- let page = await client.empathicVoice.prompts.listPrompts({
2008
- pageNumber: 0,
2009
- pageSize: 2
1610
+ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1611
+ versionDescription: "This is an updated version_description."
2010
1612
  });
2011
- while (page.hasNextPage()) {
2012
- page = page.getNextPage();
2013
- }
2014
-
2015
- // You can also access the underlying response
2016
- const response = page.response;
2017
1613
 
2018
1614
  ```
2019
1615
  </dd>
@@ -2029,7 +1625,7 @@ const response = page.response;
2029
1625
  <dl>
2030
1626
  <dd>
2031
1627
 
2032
- **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1628
+ **id:** `string` — Identifier for a prompt. Formatted as a UUID.
2033
1629
 
2034
1630
  </dd>
2035
1631
  </dl>
@@ -2037,37 +1633,38 @@ const response = page.response;
2037
1633
  <dl>
2038
1634
  <dd>
2039
1635
 
2040
- **requestOptions:** `Prompts.RequestOptions`
1636
+ **version:** `number` — Version number for a prompt. Version numbers should be integers.
2041
1637
 
2042
1638
  </dd>
2043
1639
  </dl>
2044
- </dd>
2045
- </dl>
2046
-
2047
-
2048
- </dd>
2049
- </dl>
2050
- </details>
2051
1640
 
2052
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
2053
1641
  <dl>
2054
1642
  <dd>
2055
1643
 
2056
- #### 📝 Description
2057
-
2058
- <dl>
2059
- <dd>
1644
+ **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1645
+
1646
+ </dd>
1647
+ </dl>
2060
1648
 
2061
1649
  <dl>
2062
1650
  <dd>
2063
1651
 
2064
- Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
2065
-
2066
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1652
+ **requestOptions:** `PromptsClient.RequestOptions`
1653
+
1654
+ </dd>
1655
+ </dl>
2067
1656
  </dd>
2068
1657
  </dl>
1658
+
1659
+
2069
1660
  </dd>
2070
1661
  </dl>
1662
+ </details>
1663
+
1664
+ ## EmpathicVoice Tools
1665
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
1666
+ <dl>
1667
+ <dd>
2071
1668
 
2072
1669
  #### 🔌 Usage
2073
1670
 
@@ -2078,10 +1675,25 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2078
1675
  <dd>
2079
1676
 
2080
1677
  ```typescript
2081
- await client.empathicVoice.prompts.createPrompt({
2082
- name: "Weather Assistant Prompt",
2083
- text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
1678
+ const pageableResponse = await client.empathicVoice.tools.listTools({
1679
+ pageNumber: 0,
1680
+ pageSize: 2
1681
+ });
1682
+ for await (const item of pageableResponse) {
1683
+ console.log(item);
1684
+ }
1685
+
1686
+ // Or you can manually iterate page-by-page
1687
+ let page = await client.empathicVoice.tools.listTools({
1688
+ pageNumber: 0,
1689
+ pageSize: 2
2084
1690
  });
1691
+ while (page.hasNextPage()) {
1692
+ page = page.getNextPage();
1693
+ }
1694
+
1695
+ // You can also access the underlying response
1696
+ const response = page.response;
2085
1697
 
2086
1698
  ```
2087
1699
  </dd>
@@ -2097,7 +1709,7 @@ await client.empathicVoice.prompts.createPrompt({
2097
1709
  <dl>
2098
1710
  <dd>
2099
1711
 
2100
- **request:** `Hume.empathicVoice.PostedPrompt`
1712
+ **request:** `Hume.empathicVoice.ToolsListToolsRequest`
2101
1713
 
2102
1714
  </dd>
2103
1715
  </dl>
@@ -2105,7 +1717,7 @@ await client.empathicVoice.prompts.createPrompt({
2105
1717
  <dl>
2106
1718
  <dd>
2107
1719
 
2108
- **requestOptions:** `Prompts.RequestOptions`
1720
+ **requestOptions:** `ToolsClient.RequestOptions`
2109
1721
 
2110
1722
  </dd>
2111
1723
  </dl>
@@ -2117,26 +1729,10 @@ await client.empathicVoice.prompts.createPrompt({
2117
1729
  </dl>
2118
1730
  </details>
2119
1731
 
2120
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
2121
- <dl>
2122
- <dd>
2123
-
2124
- #### 📝 Description
2125
-
2126
- <dl>
2127
- <dd>
2128
-
1732
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2129
1733
  <dl>
2130
1734
  <dd>
2131
1735
 
2132
- Fetches a list of a **Prompt's** versions.
2133
-
2134
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2135
- </dd>
2136
- </dl>
2137
- </dd>
2138
- </dl>
2139
-
2140
1736
  #### 🔌 Usage
2141
1737
 
2142
1738
  <dl>
@@ -2146,7 +1742,13 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2146
1742
  <dd>
2147
1743
 
2148
1744
  ```typescript
2149
- await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1745
+ await client.empathicVoice.tools.createTool({
1746
+ name: "get_current_weather",
1747
+ parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
1748
+ versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
1749
+ description: "This tool is for getting the current weather.",
1750
+ fallbackContent: "Unable to fetch current weather."
1751
+ });
2150
1752
 
2151
1753
  ```
2152
1754
  </dd>
@@ -2162,15 +1764,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
2162
1764
  <dl>
2163
1765
  <dd>
2164
1766
 
2165
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2166
-
2167
- </dd>
2168
- </dl>
2169
-
2170
- <dl>
2171
- <dd>
2172
-
2173
- **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1767
+ **request:** `Hume.empathicVoice.PostedUserDefinedTool`
2174
1768
 
2175
1769
  </dd>
2176
1770
  </dl>
@@ -2178,7 +1772,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
2178
1772
  <dl>
2179
1773
  <dd>
2180
1774
 
2181
- **requestOptions:** `Prompts.RequestOptions`
1775
+ **requestOptions:** `ToolsClient.RequestOptions`
2182
1776
 
2183
1777
  </dd>
2184
1778
  </dl>
@@ -2190,26 +1784,10 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
2190
1784
  </dl>
2191
1785
  </details>
2192
1786
 
2193
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
2194
- <dl>
2195
- <dd>
2196
-
2197
- #### 📝 Description
2198
-
2199
- <dl>
2200
- <dd>
2201
-
1787
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
2202
1788
  <dl>
2203
1789
  <dd>
2204
1790
 
2205
- Updates a **Prompt** by creating a new version of the **Prompt**.
2206
-
2207
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2208
- </dd>
2209
- </dl>
2210
- </dd>
2211
- </dl>
2212
-
2213
1791
  #### 🔌 Usage
2214
1792
 
2215
1793
  <dl>
@@ -2219,10 +1797,19 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2219
1797
  <dd>
2220
1798
 
2221
1799
  ```typescript
2222
- await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
2223
- text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
2224
- versionDescription: "This is an updated version of the Weather Assistant Prompt."
2225
- });
1800
+ const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
1801
+ for await (const item of pageableResponse) {
1802
+ console.log(item);
1803
+ }
1804
+
1805
+ // Or you can manually iterate page-by-page
1806
+ let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
1807
+ while (page.hasNextPage()) {
1808
+ page = page.getNextPage();
1809
+ }
1810
+
1811
+ // You can also access the underlying response
1812
+ const response = page.response;
2226
1813
 
2227
1814
  ```
2228
1815
  </dd>
@@ -2238,7 +1825,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
2238
1825
  <dl>
2239
1826
  <dd>
2240
1827
 
2241
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1828
+ **id:** `string`
2242
1829
 
2243
1830
  </dd>
2244
1831
  </dl>
@@ -2246,7 +1833,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
2246
1833
  <dl>
2247
1834
  <dd>
2248
1835
 
2249
- **request:** `Hume.empathicVoice.PostedPromptVersion`
1836
+ **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
2250
1837
 
2251
1838
  </dd>
2252
1839
  </dl>
@@ -2254,7 +1841,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
2254
1841
  <dl>
2255
1842
  <dd>
2256
1843
 
2257
- **requestOptions:** `Prompts.RequestOptions`
1844
+ **requestOptions:** `ToolsClient.RequestOptions`
2258
1845
 
2259
1846
  </dd>
2260
1847
  </dl>
@@ -2266,11 +1853,11 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
2266
1853
  </dl>
2267
1854
  </details>
2268
1855
 
2269
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1856
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2270
1857
  <dl>
2271
1858
  <dd>
2272
1859
 
2273
- #### 📝 Description
1860
+ #### 🔌 Usage
2274
1861
 
2275
1862
  <dl>
2276
1863
  <dd>
@@ -2278,15 +1865,21 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
2278
1865
  <dl>
2279
1866
  <dd>
2280
1867
 
2281
- Deletes a **Prompt** and its versions.
1868
+ ```typescript
1869
+ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
1870
+ parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
1871
+ versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
1872
+ fallbackContent: "Unable to fetch current weather.",
1873
+ description: "This tool is for getting the current weather."
1874
+ });
2282
1875
 
2283
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1876
+ ```
2284
1877
  </dd>
2285
1878
  </dl>
2286
1879
  </dd>
2287
1880
  </dl>
2288
1881
 
2289
- #### 🔌 Usage
1882
+ #### ⚙️ Parameters
2290
1883
 
2291
1884
  <dl>
2292
1885
  <dd>
@@ -2294,24 +1887,15 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2294
1887
  <dl>
2295
1888
  <dd>
2296
1889
 
2297
- ```typescript
2298
- await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
2299
-
2300
- ```
2301
- </dd>
2302
- </dl>
1890
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
1891
+
2303
1892
  </dd>
2304
1893
  </dl>
2305
1894
 
2306
- #### ⚙️ Parameters
2307
-
2308
- <dl>
2309
- <dd>
2310
-
2311
1895
  <dl>
2312
1896
  <dd>
2313
1897
 
2314
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1898
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
2315
1899
 
2316
1900
  </dd>
2317
1901
  </dl>
@@ -2319,7 +1903,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
2319
1903
  <dl>
2320
1904
  <dd>
2321
1905
 
2322
- **requestOptions:** `Prompts.RequestOptions`
1906
+ **requestOptions:** `ToolsClient.RequestOptions`
2323
1907
 
2324
1908
  </dd>
2325
1909
  </dl>
@@ -2331,26 +1915,10 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
2331
1915
  </dl>
2332
1916
  </details>
2333
1917
 
2334
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
2335
- <dl>
2336
- <dd>
2337
-
2338
- #### 📝 Description
2339
-
2340
- <dl>
2341
- <dd>
2342
-
1918
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
2343
1919
  <dl>
2344
1920
  <dd>
2345
1921
 
2346
- Updates the name of a **Prompt**.
2347
-
2348
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2349
- </dd>
2350
- </dl>
2351
- </dd>
2352
- </dl>
2353
-
2354
1922
  #### 🔌 Usage
2355
1923
 
2356
1924
  <dl>
@@ -2360,9 +1928,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2360
1928
  <dd>
2361
1929
 
2362
1930
  ```typescript
2363
- await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
2364
- name: "Updated Weather Assistant Prompt Name"
2365
- });
1931
+ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
2366
1932
 
2367
1933
  ```
2368
1934
  </dd>
@@ -2378,15 +1944,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
2378
1944
  <dl>
2379
1945
  <dd>
2380
1946
 
2381
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2382
-
2383
- </dd>
2384
- </dl>
2385
-
2386
- <dl>
2387
- <dd>
2388
-
2389
- **request:** `Hume.empathicVoice.PostedPromptName`
1947
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
2390
1948
 
2391
1949
  </dd>
2392
1950
  </dl>
@@ -2394,7 +1952,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
2394
1952
  <dl>
2395
1953
  <dd>
2396
1954
 
2397
- **requestOptions:** `Prompts.RequestOptions`
1955
+ **requestOptions:** `ToolsClient.RequestOptions`
2398
1956
 
2399
1957
  </dd>
2400
1958
  </dl>
@@ -2406,26 +1964,10 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
2406
1964
  </dl>
2407
1965
  </details>
2408
1966
 
2409
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
2410
- <dl>
2411
- <dd>
2412
-
2413
- #### 📝 Description
2414
-
2415
- <dl>
2416
- <dd>
2417
-
1967
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
2418
1968
  <dl>
2419
1969
  <dd>
2420
1970
 
2421
- Fetches a specified version of a **Prompt**.
2422
-
2423
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2424
- </dd>
2425
- </dl>
2426
- </dd>
2427
- </dl>
2428
-
2429
1971
  #### 🔌 Usage
2430
1972
 
2431
1973
  <dl>
@@ -2435,7 +1977,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2435
1977
  <dd>
2436
1978
 
2437
1979
  ```typescript
2438
- await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1980
+ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
1981
+ name: "get_current_temperature"
1982
+ });
2439
1983
 
2440
1984
  ```
2441
1985
  </dd>
@@ -2451,7 +1995,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
2451
1995
  <dl>
2452
1996
  <dd>
2453
1997
 
2454
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1998
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
2455
1999
 
2456
2000
  </dd>
2457
2001
  </dl>
@@ -2459,13 +2003,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
2459
2003
  <dl>
2460
2004
  <dd>
2461
2005
 
2462
- **version:** `number`
2463
-
2464
- Version number for a Prompt.
2465
-
2466
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
2467
-
2468
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2006
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
2469
2007
 
2470
2008
  </dd>
2471
2009
  </dl>
@@ -2473,7 +2011,7 @@ Version numbers are integer values representing different iterations of the Prom
2473
2011
  <dl>
2474
2012
  <dd>
2475
2013
 
2476
- **requestOptions:** `Prompts.RequestOptions`
2014
+ **requestOptions:** `ToolsClient.RequestOptions`
2477
2015
 
2478
2016
  </dd>
2479
2017
  </dl>
@@ -2485,26 +2023,10 @@ Version numbers are integer values representing different iterations of the Prom
2485
2023
  </dl>
2486
2024
  </details>
2487
2025
 
2488
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
2489
- <dl>
2490
- <dd>
2491
-
2492
- #### 📝 Description
2493
-
2494
- <dl>
2495
- <dd>
2496
-
2026
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2497
2027
  <dl>
2498
2028
  <dd>
2499
2029
 
2500
- Deletes a specified version of a **Prompt**.
2501
-
2502
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2503
- </dd>
2504
- </dl>
2505
- </dd>
2506
- </dl>
2507
-
2508
2030
  #### 🔌 Usage
2509
2031
 
2510
2032
  <dl>
@@ -2514,7 +2036,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2514
2036
  <dd>
2515
2037
 
2516
2038
  ```typescript
2517
- await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
2039
+ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
2518
2040
 
2519
2041
  ```
2520
2042
  </dd>
@@ -2530,7 +2052,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
2530
2052
  <dl>
2531
2053
  <dd>
2532
2054
 
2533
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2055
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
2534
2056
 
2535
2057
  </dd>
2536
2058
  </dl>
@@ -2538,13 +2060,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
2538
2060
  <dl>
2539
2061
  <dd>
2540
2062
 
2541
- **version:** `number`
2542
-
2543
- Version number for a Prompt.
2544
-
2545
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
2546
-
2547
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2063
+ **version:** `number` — Version number for a tool. Version numbers should be integers.
2548
2064
 
2549
2065
  </dd>
2550
2066
  </dl>
@@ -2552,7 +2068,7 @@ Version numbers are integer values representing different iterations of the Prom
2552
2068
  <dl>
2553
2069
  <dd>
2554
2070
 
2555
- **requestOptions:** `Prompts.RequestOptions`
2071
+ **requestOptions:** `ToolsClient.RequestOptions`
2556
2072
 
2557
2073
  </dd>
2558
2074
  </dl>
@@ -2564,26 +2080,10 @@ Version numbers are integer values representing different iterations of the Prom
2564
2080
  </dl>
2565
2081
  </details>
2566
2082
 
2567
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
2568
- <dl>
2569
- <dd>
2570
-
2571
- #### 📝 Description
2572
-
2573
- <dl>
2574
- <dd>
2575
-
2083
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
2576
2084
  <dl>
2577
2085
  <dd>
2578
2086
 
2579
- Updates the description of a **Prompt**.
2580
-
2581
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2582
- </dd>
2583
- </dl>
2584
- </dd>
2585
- </dl>
2586
-
2587
2087
  #### 🔌 Usage
2588
2088
 
2589
2089
  <dl>
@@ -2593,9 +2093,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
2593
2093
  <dd>
2594
2094
 
2595
2095
  ```typescript
2596
- await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
2597
- versionDescription: "This is an updated version_description."
2598
- });
2096
+ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
2599
2097
 
2600
2098
  ```
2601
2099
  </dd>
@@ -2611,21 +2109,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
2611
2109
  <dl>
2612
2110
  <dd>
2613
2111
 
2614
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2615
-
2616
- </dd>
2617
- </dl>
2618
-
2619
- <dl>
2620
- <dd>
2621
-
2622
- **version:** `number`
2623
-
2624
- Version number for a Prompt.
2625
-
2626
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
2627
-
2628
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2112
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
2629
2113
 
2630
2114
  </dd>
2631
2115
  </dl>
@@ -2633,7 +2117,7 @@ Version numbers are integer values representing different iterations of the Prom
2633
2117
  <dl>
2634
2118
  <dd>
2635
2119
 
2636
- **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
2120
+ **version:** `number` — Version number for a tool. Version numbers should be integers.
2637
2121
 
2638
2122
  </dd>
2639
2123
  </dl>
@@ -2641,7 +2125,7 @@ Version numbers are integer values representing different iterations of the Prom
2641
2125
  <dl>
2642
2126
  <dd>
2643
2127
 
2644
- **requestOptions:** `Prompts.RequestOptions`
2128
+ **requestOptions:** `ToolsClient.RequestOptions`
2645
2129
 
2646
2130
  </dd>
2647
2131
  </dl>
@@ -2653,55 +2137,22 @@ Version numbers are integer values representing different iterations of the Prom
2653
2137
  </dl>
2654
2138
  </details>
2655
2139
 
2656
- ## EmpathicVoice Tools
2657
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
2658
- <dl>
2659
- <dd>
2660
-
2661
- #### 📝 Description
2662
-
2663
- <dl>
2664
- <dd>
2665
-
2140
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2666
2141
  <dl>
2667
2142
  <dd>
2668
2143
 
2669
- Fetches a paginated list of **Tools**.
2670
-
2671
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2672
- </dd>
2673
- </dl>
2674
- </dd>
2675
- </dl>
2676
-
2677
2144
  #### 🔌 Usage
2678
2145
 
2679
2146
  <dl>
2680
- <dd>
2681
-
2682
- <dl>
2683
- <dd>
2684
-
2685
- ```typescript
2686
- const pageableResponse = await client.empathicVoice.tools.listTools({
2687
- pageNumber: 0,
2688
- pageSize: 2
2689
- });
2690
- for await (const item of pageableResponse) {
2691
- console.log(item);
2692
- }
2147
+ <dd>
2693
2148
 
2694
- // Or you can manually iterate page-by-page
2695
- let page = await client.empathicVoice.tools.listTools({
2696
- pageNumber: 0,
2697
- pageSize: 2
2698
- });
2699
- while (page.hasNextPage()) {
2700
- page = page.getNextPage();
2701
- }
2149
+ <dl>
2150
+ <dd>
2702
2151
 
2703
- // You can also access the underlying response
2704
- const response = page.response;
2152
+ ```typescript
2153
+ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
2154
+ versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
2155
+ });
2705
2156
 
2706
2157
  ```
2707
2158
  </dd>
@@ -2717,7 +2168,23 @@ const response = page.response;
2717
2168
  <dl>
2718
2169
  <dd>
2719
2170
 
2720
- **request:** `Hume.empathicVoice.ToolsListToolsRequest`
2171
+ **id:** `string` — Identifier for a tool. Formatted as a UUID.
2172
+
2173
+ </dd>
2174
+ </dl>
2175
+
2176
+ <dl>
2177
+ <dd>
2178
+
2179
+ **version:** `number` — Version number for a tool. Version numbers should be integers.
2180
+
2181
+ </dd>
2182
+ </dl>
2183
+
2184
+ <dl>
2185
+ <dd>
2186
+
2187
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
2721
2188
 
2722
2189
  </dd>
2723
2190
  </dl>
@@ -2725,7 +2192,7 @@ const response = page.response;
2725
2192
  <dl>
2726
2193
  <dd>
2727
2194
 
2728
- **requestOptions:** `Tools.RequestOptions`
2195
+ **requestOptions:** `ToolsClient.RequestOptions`
2729
2196
 
2730
2197
  </dd>
2731
2198
  </dl>
@@ -2737,7 +2204,8 @@ const response = page.response;
2737
2204
  </dl>
2738
2205
  </details>
2739
2206
 
2740
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2207
+ ## Tts
2208
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
2741
2209
  <dl>
2742
2210
  <dd>
2743
2211
 
@@ -2749,9 +2217,9 @@ const response = page.response;
2749
2217
  <dl>
2750
2218
  <dd>
2751
2219
 
2752
- Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
2220
+ Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2753
2221
 
2754
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2222
+ The response includes the base64-encoded audio and metadata in JSON format.
2755
2223
  </dd>
2756
2224
  </dl>
2757
2225
  </dd>
@@ -2766,12 +2234,21 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
2766
2234
  <dd>
2767
2235
 
2768
2236
  ```typescript
2769
- await client.empathicVoice.tools.createTool({
2770
- name: "get_current_weather",
2771
- parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
2772
- versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
2773
- description: "This tool is for getting the current weather.",
2774
- fallbackContent: "Unable to fetch current weather."
2237
+ await client.tts.synthesizeJson({
2238
+ context: {
2239
+ utterances: [{
2240
+ text: "How can people see beauty so differently?",
2241
+ description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
2242
+ }]
2243
+ },
2244
+ format: {
2245
+ type: "mp3"
2246
+ },
2247
+ numGenerations: 1,
2248
+ utterances: [{
2249
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2250
+ description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
2251
+ }]
2775
2252
  });
2776
2253
 
2777
2254
  ```
@@ -2788,7 +2265,7 @@ await client.empathicVoice.tools.createTool({
2788
2265
  <dl>
2789
2266
  <dd>
2790
2267
 
2791
- **request:** `Hume.empathicVoice.PostedUserDefinedTool`
2268
+ **request:** `Hume.PostedTts`
2792
2269
 
2793
2270
  </dd>
2794
2271
  </dl>
@@ -2796,7 +2273,7 @@ await client.empathicVoice.tools.createTool({
2796
2273
  <dl>
2797
2274
  <dd>
2798
2275
 
2799
- **requestOptions:** `Tools.RequestOptions`
2276
+ **requestOptions:** `TtsClient.RequestOptions`
2800
2277
 
2801
2278
  </dd>
2802
2279
  </dl>
@@ -2808,7 +2285,7 @@ await client.empathicVoice.tools.createTool({
2808
2285
  </dl>
2809
2286
  </details>
2810
2287
 
2811
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
2288
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> core.BinaryResponse</code></summary>
2812
2289
  <dl>
2813
2290
  <dd>
2814
2291
 
@@ -2820,9 +2297,9 @@ await client.empathicVoice.tools.createTool({
2820
2297
  <dl>
2821
2298
  <dd>
2822
2299
 
2823
- Fetches a list of a **Tool's** versions.
2300
+ Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2824
2301
 
2825
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2302
+ The response contains the generated audio file in the requested format.
2826
2303
  </dd>
2827
2304
  </dl>
2828
2305
  </dd>
@@ -2837,19 +2314,19 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
2837
2314
  <dd>
2838
2315
 
2839
2316
  ```typescript
2840
- const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
2841
- for await (const item of pageableResponse) {
2842
- console.log(item);
2843
- }
2844
-
2845
- // Or you can manually iterate page-by-page
2846
- let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
2847
- while (page.hasNextPage()) {
2848
- page = page.getNextPage();
2849
- }
2850
-
2851
- // You can also access the underlying response
2852
- const response = page.response;
2317
+ await client.tts.synthesizeFile({
2318
+ context: {
2319
+ generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2"
2320
+ },
2321
+ format: {
2322
+ type: "mp3"
2323
+ },
2324
+ numGenerations: 1,
2325
+ utterances: [{
2326
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2327
+ description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
2328
+ }]
2329
+ });
2853
2330
 
2854
2331
  ```
2855
2332
  </dd>
@@ -2865,15 +2342,7 @@ const response = page.response;
2865
2342
  <dl>
2866
2343
  <dd>
2867
2344
 
2868
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
2869
-
2870
- </dd>
2871
- </dl>
2872
-
2873
- <dl>
2874
- <dd>
2875
-
2876
- **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
2345
+ **request:** `Hume.PostedTts`
2877
2346
 
2878
2347
  </dd>
2879
2348
  </dl>
@@ -2881,7 +2350,7 @@ const response = page.response;
2881
2350
  <dl>
2882
2351
  <dd>
2883
2352
 
2884
- **requestOptions:** `Tools.RequestOptions`
2353
+ **requestOptions:** `TtsClient.RequestOptions`
2885
2354
 
2886
2355
  </dd>
2887
2356
  </dl>
@@ -2893,7 +2362,7 @@ const response = page.response;
2893
2362
  </dl>
2894
2363
  </details>
2895
2364
 
2896
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2365
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> core.BinaryResponse</code></summary>
2897
2366
  <dl>
2898
2367
  <dd>
2899
2368
 
@@ -2905,9 +2374,7 @@ const response = page.response;
2905
2374
  <dl>
2906
2375
  <dd>
2907
2376
 
2908
- Updates a **Tool** by creating a new version of the **Tool**.
2909
-
2910
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2377
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2911
2378
  </dd>
2912
2379
  </dl>
2913
2380
  </dd>
@@ -2922,11 +2389,14 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
2922
2389
  <dd>
2923
2390
 
2924
2391
  ```typescript
2925
- await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
2926
- parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
2927
- versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
2928
- fallbackContent: "Unable to fetch current weather.",
2929
- description: "This tool is for getting the current weather."
2392
+ await client.tts.synthesizeFileStreaming({
2393
+ utterances: [{
2394
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2395
+ voice: {
2396
+ name: "Male English Actor",
2397
+ provider: "HUME_AI"
2398
+ }
2399
+ }]
2930
2400
  });
2931
2401
 
2932
2402
  ```
@@ -2943,15 +2413,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
2943
2413
  <dl>
2944
2414
  <dd>
2945
2415
 
2946
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
2947
-
2948
- </dd>
2949
- </dl>
2950
-
2951
- <dl>
2952
- <dd>
2953
-
2954
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
2416
+ **request:** `Hume.PostedTts`
2955
2417
 
2956
2418
  </dd>
2957
2419
  </dl>
@@ -2959,7 +2421,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
2959
2421
  <dl>
2960
2422
  <dd>
2961
2423
 
2962
- **requestOptions:** `Tools.RequestOptions`
2424
+ **requestOptions:** `TtsClient.RequestOptions`
2963
2425
 
2964
2426
  </dd>
2965
2427
  </dl>
@@ -2971,7 +2433,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
2971
2433
  </dl>
2972
2434
  </details>
2973
2435
 
2974
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
2436
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
2975
2437
  <dl>
2976
2438
  <dd>
2977
2439
 
@@ -2983,9 +2445,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
2983
2445
  <dl>
2984
2446
  <dd>
2985
2447
 
2986
- Deletes a **Tool** and its versions.
2448
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2987
2449
 
2988
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2450
+ The response is a stream of JSON objects including audio encoded in base64.
2989
2451
  </dd>
2990
2452
  </dl>
2991
2453
  </dd>
@@ -3000,7 +2462,18 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
3000
2462
  <dd>
3001
2463
 
3002
2464
  ```typescript
3003
- await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
2465
+ const response = await client.tts.synthesizeJsonStreaming({
2466
+ utterances: [{
2467
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2468
+ voice: {
2469
+ name: "Male English Actor",
2470
+ provider: "HUME_AI"
2471
+ }
2472
+ }]
2473
+ });
2474
+ for await (const item of response) {
2475
+ console.log(item);
2476
+ }
3004
2477
 
3005
2478
  ```
3006
2479
  </dd>
@@ -3016,7 +2489,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
3016
2489
  <dl>
3017
2490
  <dd>
3018
2491
 
3019
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
2492
+ **request:** `Hume.PostedTts`
3020
2493
 
3021
2494
  </dd>
3022
2495
  </dl>
@@ -3024,7 +2497,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
3024
2497
  <dl>
3025
2498
  <dd>
3026
2499
 
3027
- **requestOptions:** `Tools.RequestOptions`
2500
+ **requestOptions:** `TtsClient.RequestOptions`
3028
2501
 
3029
2502
  </dd>
3030
2503
  </dl>
@@ -3036,26 +2509,10 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
3036
2509
  </dl>
3037
2510
  </details>
3038
2511
 
3039
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
3040
- <dl>
3041
- <dd>
3042
-
3043
- #### 📝 Description
3044
-
3045
- <dl>
3046
- <dd>
3047
-
2512
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
3048
2513
  <dl>
3049
2514
  <dd>
3050
2515
 
3051
- Updates the name of a **Tool**.
3052
-
3053
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
3054
- </dd>
3055
- </dl>
3056
- </dd>
3057
- </dl>
3058
-
3059
2516
  #### 🔌 Usage
3060
2517
 
3061
2518
  <dl>
@@ -3065,9 +2522,10 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
3065
2522
  <dd>
3066
2523
 
3067
2524
  ```typescript
3068
- await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
3069
- name: "get_current_temperature"
3070
- });
2525
+ const response = await client.tts.convertVoiceJson({});
2526
+ for await (const item of response) {
2527
+ console.log(item);
2528
+ }
3071
2529
 
3072
2530
  ```
3073
2531
  </dd>
@@ -3083,15 +2541,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
3083
2541
  <dl>
3084
2542
  <dd>
3085
2543
 
3086
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
3087
-
3088
- </dd>
3089
- </dl>
3090
-
3091
- <dl>
3092
- <dd>
3093
-
3094
- **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
2544
+ **request:** `Hume.tts.ConvertVoiceJsonRequest`
3095
2545
 
3096
2546
  </dd>
3097
2547
  </dl>
@@ -3099,7 +2549,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
3099
2549
  <dl>
3100
2550
  <dd>
3101
2551
 
3102
- **requestOptions:** `Tools.RequestOptions`
2552
+ **requestOptions:** `TtsClient.RequestOptions`
3103
2553
 
3104
2554
  </dd>
3105
2555
  </dl>
@@ -3111,7 +2561,8 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
3111
2561
  </dl>
3112
2562
  </details>
3113
2563
 
3114
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2564
+ ## Tts Voices
2565
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
3115
2566
  <dl>
3116
2567
  <dd>
3117
2568
 
@@ -3123,9 +2574,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
3123
2574
  <dl>
3124
2575
  <dd>
3125
2576
 
3126
- Fetches a specified version of a **Tool**.
3127
-
3128
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2577
+ Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/voices).
3129
2578
  </dd>
3130
2579
  </dl>
3131
2580
  </dd>
@@ -3140,7 +2589,23 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
3140
2589
  <dd>
3141
2590
 
3142
2591
  ```typescript
3143
- await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
2592
+ const pageableResponse = await client.tts.voices.list({
2593
+ provider: "CUSTOM_VOICE"
2594
+ });
2595
+ for await (const item of pageableResponse) {
2596
+ console.log(item);
2597
+ }
2598
+
2599
+ // Or you can manually iterate page-by-page
2600
+ let page = await client.tts.voices.list({
2601
+ provider: "CUSTOM_VOICE"
2602
+ });
2603
+ while (page.hasNextPage()) {
2604
+ page = page.getNextPage();
2605
+ }
2606
+
2607
+ // You can also access the underlying response
2608
+ const response = page.response;
3144
2609
 
3145
2610
  ```
3146
2611
  </dd>
@@ -3156,21 +2621,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
3156
2621
  <dl>
3157
2622
  <dd>
3158
2623
 
3159
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
3160
-
3161
- </dd>
3162
- </dl>
3163
-
3164
- <dl>
3165
- <dd>
3166
-
3167
- **version:** `number`
3168
-
3169
- Version number for a Tool.
3170
-
3171
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
3172
-
3173
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
2624
+ **request:** `Hume.tts.VoicesListRequest`
3174
2625
 
3175
2626
  </dd>
3176
2627
  </dl>
@@ -3178,7 +2629,7 @@ Version numbers are integer values representing different iterations of the Tool
3178
2629
  <dl>
3179
2630
  <dd>
3180
2631
 
3181
- **requestOptions:** `Tools.RequestOptions`
2632
+ **requestOptions:** `VoicesClient.RequestOptions`
3182
2633
 
3183
2634
  </dd>
3184
2635
  </dl>
@@ -3190,7 +2641,7 @@ Version numbers are integer values representing different iterations of the Tool
3190
2641
  </dl>
3191
2642
  </details>
3192
2643
 
3193
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
2644
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
3194
2645
  <dl>
3195
2646
  <dd>
3196
2647
 
@@ -3202,9 +2653,9 @@ Version numbers are integer values representing different iterations of the Tool
3202
2653
  <dl>
3203
2654
  <dd>
3204
2655
 
3205
- Deletes a specified version of a **Tool**.
2656
+ Saves a new custom voice to your account using the specified TTS generation ID.
3206
2657
 
3207
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2658
+ Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
3208
2659
  </dd>
3209
2660
  </dl>
3210
2661
  </dd>
@@ -3219,7 +2670,10 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
3219
2670
  <dd>
3220
2671
 
3221
2672
  ```typescript
3222
- await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
2673
+ await client.tts.voices.create({
2674
+ generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
2675
+ name: "David Hume"
2676
+ });
3223
2677
 
3224
2678
  ```
3225
2679
  </dd>
@@ -3235,21 +2689,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
3235
2689
  <dl>
3236
2690
  <dd>
3237
2691
 
3238
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
3239
-
3240
- </dd>
3241
- </dl>
3242
-
3243
- <dl>
3244
- <dd>
3245
-
3246
- **version:** `number`
3247
-
3248
- Version number for a Tool.
3249
-
3250
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
3251
-
3252
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
2692
+ **request:** `Hume.tts.PostedVoice`
3253
2693
 
3254
2694
  </dd>
3255
2695
  </dl>
@@ -3257,7 +2697,7 @@ Version numbers are integer values representing different iterations of the Tool
3257
2697
  <dl>
3258
2698
  <dd>
3259
2699
 
3260
- **requestOptions:** `Tools.RequestOptions`
2700
+ **requestOptions:** `VoicesClient.RequestOptions`
3261
2701
 
3262
2702
  </dd>
3263
2703
  </dl>
@@ -3269,7 +2709,7 @@ Version numbers are integer values representing different iterations of the Tool
3269
2709
  </dl>
3270
2710
  </details>
3271
2711
 
3272
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
2712
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
3273
2713
  <dl>
3274
2714
  <dd>
3275
2715
 
@@ -3281,9 +2721,7 @@ Version numbers are integer values representing different iterations of the Tool
3281
2721
  <dl>
3282
2722
  <dd>
3283
2723
 
3284
- Updates the description of a specified **Tool** version.
3285
-
3286
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
2724
+ Deletes a previously generated custom voice.
3287
2725
  </dd>
3288
2726
  </dl>
3289
2727
  </dd>
@@ -3298,8 +2736,8 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
3298
2736
  <dd>
3299
2737
 
3300
2738
  ```typescript
3301
- await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
3302
- versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
2739
+ await client.tts.voices.delete({
2740
+ name: "David Hume"
3303
2741
  });
3304
2742
 
3305
2743
  ```
@@ -3316,29 +2754,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
3316
2754
  <dl>
3317
2755
  <dd>
3318
2756
 
3319
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
3320
-
3321
- </dd>
3322
- </dl>
3323
-
3324
- <dl>
3325
- <dd>
3326
-
3327
- **version:** `number`
3328
-
3329
- Version number for a Tool.
3330
-
3331
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
3332
-
3333
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
3334
-
3335
- </dd>
3336
- </dl>
3337
-
3338
- <dl>
3339
- <dd>
3340
-
3341
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
2757
+ **request:** `Hume.tts.VoicesDeleteRequest`
3342
2758
 
3343
2759
  </dd>
3344
2760
  </dl>
@@ -3346,7 +2762,7 @@ Version numbers are integer values representing different iterations of the Tool
3346
2762
  <dl>
3347
2763
  <dd>
3348
2764
 
3349
- **requestOptions:** `Tools.RequestOptions`
2765
+ **requestOptions:** `VoicesClient.RequestOptions`
3350
2766
 
3351
2767
  </dd>
3352
2768
  </dl>
@@ -3410,7 +2826,7 @@ await client.expressionMeasurement.batch.listJobs();
3410
2826
  <dl>
3411
2827
  <dd>
3412
2828
 
3413
- **requestOptions:** `Batch.RequestOptions`
2829
+ **requestOptions:** `BatchClient.RequestOptions`
3414
2830
 
3415
2831
  </dd>
3416
2832
  </dl>
@@ -3476,7 +2892,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
3476
2892
  <dl>
3477
2893
  <dd>
3478
2894
 
3479
- **requestOptions:** `Batch.RequestOptions`
2895
+ **requestOptions:** `BatchClient.RequestOptions`
3480
2896
 
3481
2897
  </dd>
3482
2898
  </dl>
@@ -3539,7 +2955,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
3539
2955
  <dl>
3540
2956
  <dd>
3541
2957
 
3542
- **requestOptions:** `Batch.RequestOptions`
2958
+ **requestOptions:** `BatchClient.RequestOptions`
3543
2959
 
3544
2960
  </dd>
3545
2961
  </dl>
@@ -3602,7 +3018,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3602
3018
  <dl>
3603
3019
  <dd>
3604
3020
 
3605
- **requestOptions:** `Batch.RequestOptions`
3021
+ **requestOptions:** `BatchClient.RequestOptions`
3606
3022
 
3607
3023
  </dd>
3608
3024
  </dl>
@@ -3667,7 +3083,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile({
3667
3083
  <dl>
3668
3084
  <dd>
3669
3085
 
3670
- **requestOptions:** `Batch.RequestOptions`
3086
+ **requestOptions:** `BatchClient.RequestOptions`
3671
3087
 
3672
3088
  </dd>
3673
3089
  </dl>