hume 0.15.12 → 0.15.13

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 (228) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -3
  3. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.js +11 -3
  4. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +1 -1
  5. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.ts +1 -1
  6. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +1 -1
  7. package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +6 -2
  8. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/Client.d.ts +8 -2
  9. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/Client.js +8 -2
  10. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.ts +1 -1
  11. package/dist/cjs/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.ts +1 -1
  12. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/Client.d.ts +58 -10
  13. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/Client.js +58 -10
  14. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.ts +1 -1
  15. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
  16. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +3 -2
  17. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
  18. package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts +1 -1
  19. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +57 -9
  20. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/Client.js +57 -9
  21. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +6 -2
  22. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +6 -2
  23. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts +1 -1
  24. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts +1 -1
  25. package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +1 -1
  26. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/Client.d.ts +57 -9
  27. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/Client.js +57 -9
  28. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +16 -5
  29. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolName.d.ts +8 -1
  30. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +8 -4
  31. package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts +1 -1
  32. package/dist/cjs/api/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
  33. package/dist/cjs/api/resources/empathicVoice/types/AssistantInput.d.ts +3 -1
  34. package/dist/cjs/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  35. package/dist/cjs/api/resources/empathicVoice/types/AssistantProsody.d.ts +1 -1
  36. package/dist/cjs/api/resources/empathicVoice/types/AudioInput.d.ts +3 -1
  37. package/dist/cjs/api/resources/empathicVoice/types/AudioOutput.d.ts +3 -1
  38. package/dist/cjs/api/resources/empathicVoice/types/ChatMetadata.d.ts +3 -1
  39. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettings.d.ts +4 -2
  40. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.ts +3 -3
  41. package/dist/cjs/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.ts +5 -11
  42. package/dist/cjs/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +3 -1
  43. package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
  44. package/dist/cjs/api/resources/empathicVoice/types/PostedEllmModel.d.ts +5 -1
  45. package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpec.d.ts +6 -2
  46. package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +3 -1
  47. package/dist/cjs/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +5 -1
  48. package/dist/cjs/api/resources/empathicVoice/types/PostedNudgeSpec.d.ts +2 -2
  49. package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpec.d.ts +6 -2
  50. package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +3 -1
  51. package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.d.ts +5 -1
  52. package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.js +5 -1
  53. package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +6 -2
  54. package/dist/cjs/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +3 -1
  55. package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +9 -2
  56. package/dist/cjs/api/resources/empathicVoice/types/ReturnChat.d.ts +4 -4
  57. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +9 -5
  58. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +5 -5
  59. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +5 -1
  60. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +10 -6
  61. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +7 -3
  62. package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +10 -6
  63. package/dist/cjs/api/resources/empathicVoice/types/ReturnConfig.d.ts +17 -7
  64. package/dist/cjs/api/resources/empathicVoice/types/ReturnConfigSpec.d.ts +8 -2
  65. package/dist/cjs/api/resources/empathicVoice/types/ReturnEllmModel.d.ts +5 -1
  66. package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts +6 -2
  67. package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +3 -1
  68. package/dist/cjs/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +5 -1
  69. package/dist/cjs/api/resources/empathicVoice/types/ReturnNudgeSpec.d.ts +2 -2
  70. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +6 -2
  71. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +6 -2
  72. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +6 -2
  73. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +6 -2
  74. package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +6 -2
  75. package/dist/cjs/api/resources/empathicVoice/types/ReturnPrompt.d.ts +8 -4
  76. package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +6 -2
  77. package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +3 -1
  78. package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +16 -5
  79. package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.d.ts +5 -1
  80. package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.js +5 -1
  81. package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +6 -2
  82. package/dist/cjs/api/resources/empathicVoice/types/SessionSettings.d.ts +13 -4
  83. package/dist/cjs/api/resources/empathicVoice/types/ToolCallMessage.d.ts +8 -2
  84. package/dist/cjs/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +3 -1
  85. package/dist/cjs/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +3 -1
  86. package/dist/cjs/api/resources/empathicVoice/types/UserInput.d.ts +1 -1
  87. package/dist/cjs/api/resources/empathicVoice/types/UserInterruption.d.ts +3 -1
  88. package/dist/cjs/api/resources/empathicVoice/types/UserMessage.d.ts +3 -1
  89. package/dist/cjs/api/resources/empathicVoice/types/VoiceId.d.ts +1 -1
  90. package/dist/cjs/api/resources/empathicVoice/types/VoiceName.d.ts +1 -1
  91. package/dist/cjs/api/resources/empathicVoice/types/WebSocketError.d.ts +3 -1
  92. package/dist/cjs/api/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +2 -0
  93. package/dist/cjs/api/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +2 -0
  94. package/dist/cjs/api/resources/empathicVoice/types/WebhookEventToolCall.d.ts +2 -0
  95. package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.d.ts +2 -0
  96. package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.js +2 -2
  97. package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts +1 -1
  98. package/dist/cjs/api/resources/tts/resources/voices/client/Client.js +1 -1
  99. package/dist/cjs/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +1 -1
  100. package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts +1 -1
  101. package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts +1 -1
  102. package/dist/cjs/api/resources/tts/types/ReturnPagedVoices.d.ts +5 -1
  103. package/dist/cjs/core/schemas/builders/object/object.js +20 -2
  104. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +1 -0
  105. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventChatEnded.js +1 -0
  106. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +1 -0
  107. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventChatStarted.js +1 -0
  108. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventToolCall.d.ts +1 -0
  109. package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventToolCall.js +1 -0
  110. package/dist/cjs/version.d.ts +1 -1
  111. package/dist/cjs/version.js +1 -1
  112. package/dist/esm/BaseClient.mjs +2 -2
  113. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.d.mts +11 -3
  114. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.mjs +11 -3
  115. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.mts +1 -1
  116. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetChatGroupRequest.d.mts +1 -1
  117. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.mts +1 -1
  118. package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.mts +6 -2
  119. package/dist/esm/api/resources/empathicVoice/resources/chats/client/Client.d.mts +8 -2
  120. package/dist/esm/api/resources/empathicVoice/resources/chats/client/Client.mjs +8 -2
  121. package/dist/esm/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.mts +1 -1
  122. package/dist/esm/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.mts +1 -1
  123. package/dist/esm/api/resources/empathicVoice/resources/configs/client/Client.d.mts +58 -10
  124. package/dist/esm/api/resources/empathicVoice/resources/configs/client/Client.mjs +58 -10
  125. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.mts +1 -1
  126. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.mts +1 -1
  127. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +3 -2
  128. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +2 -2
  129. package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.mts +1 -1
  130. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/Client.d.mts +57 -9
  131. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/Client.mjs +57 -9
  132. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +6 -2
  133. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +6 -2
  134. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.mts +1 -1
  135. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.mts +1 -1
  136. package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.mts +1 -1
  137. package/dist/esm/api/resources/empathicVoice/resources/tools/client/Client.d.mts +57 -9
  138. package/dist/esm/api/resources/empathicVoice/resources/tools/client/Client.mjs +57 -9
  139. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +16 -5
  140. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolName.d.mts +8 -1
  141. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +8 -4
  142. package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.mts +1 -1
  143. package/dist/esm/api/resources/empathicVoice/types/AssistantEnd.d.mts +1 -1
  144. package/dist/esm/api/resources/empathicVoice/types/AssistantInput.d.mts +3 -1
  145. package/dist/esm/api/resources/empathicVoice/types/AssistantMessage.d.mts +1 -1
  146. package/dist/esm/api/resources/empathicVoice/types/AssistantProsody.d.mts +1 -1
  147. package/dist/esm/api/resources/empathicVoice/types/AudioInput.d.mts +3 -1
  148. package/dist/esm/api/resources/empathicVoice/types/AudioOutput.d.mts +3 -1
  149. package/dist/esm/api/resources/empathicVoice/types/ChatMetadata.d.mts +3 -1
  150. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettings.d.mts +4 -2
  151. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsAudio.d.mts +3 -3
  152. package/dist/esm/api/resources/empathicVoice/types/ConnectSessionSettingsContext.d.mts +5 -11
  153. package/dist/esm/api/resources/empathicVoice/types/PauseAssistantMessage.d.mts +3 -1
  154. package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinTool.d.mts +1 -1
  155. package/dist/esm/api/resources/empathicVoice/types/PostedEllmModel.d.mts +5 -1
  156. package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpec.d.mts +6 -2
  157. package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +3 -1
  158. package/dist/esm/api/resources/empathicVoice/types/PostedLanguageModel.d.mts +5 -1
  159. package/dist/esm/api/resources/empathicVoice/types/PostedNudgeSpec.d.mts +2 -2
  160. package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpec.d.mts +6 -2
  161. package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.mts +3 -1
  162. package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.d.mts +5 -1
  163. package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.mjs +5 -1
  164. package/dist/esm/api/resources/empathicVoice/types/PostedWebhookSpec.d.mts +6 -2
  165. package/dist/esm/api/resources/empathicVoice/types/ResumeAssistantMessage.d.mts +3 -1
  166. package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +9 -2
  167. package/dist/esm/api/resources/empathicVoice/types/ReturnChat.d.mts +4 -4
  168. package/dist/esm/api/resources/empathicVoice/types/ReturnChatEvent.d.mts +9 -5
  169. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroup.d.mts +5 -5
  170. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +5 -1
  171. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +10 -6
  172. package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +7 -3
  173. package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +10 -6
  174. package/dist/esm/api/resources/empathicVoice/types/ReturnConfig.d.mts +17 -7
  175. package/dist/esm/api/resources/empathicVoice/types/ReturnConfigSpec.d.mts +8 -2
  176. package/dist/esm/api/resources/empathicVoice/types/ReturnEllmModel.d.mts +5 -1
  177. package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.mts +6 -2
  178. package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +3 -1
  179. package/dist/esm/api/resources/empathicVoice/types/ReturnLanguageModel.d.mts +5 -1
  180. package/dist/esm/api/resources/empathicVoice/types/ReturnNudgeSpec.d.mts +2 -2
  181. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +6 -2
  182. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChats.d.mts +6 -2
  183. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +6 -2
  184. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +6 -2
  185. package/dist/esm/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +6 -2
  186. package/dist/esm/api/resources/empathicVoice/types/ReturnPrompt.d.mts +8 -4
  187. package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +6 -2
  188. package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.mts +3 -1
  189. package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +16 -5
  190. package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.d.mts +5 -1
  191. package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.mjs +5 -1
  192. package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +6 -2
  193. package/dist/esm/api/resources/empathicVoice/types/SessionSettings.d.mts +13 -4
  194. package/dist/esm/api/resources/empathicVoice/types/ToolCallMessage.d.mts +8 -2
  195. package/dist/esm/api/resources/empathicVoice/types/ToolErrorMessage.d.mts +3 -1
  196. package/dist/esm/api/resources/empathicVoice/types/ToolResponseMessage.d.mts +3 -1
  197. package/dist/esm/api/resources/empathicVoice/types/UserInput.d.mts +1 -1
  198. package/dist/esm/api/resources/empathicVoice/types/UserInterruption.d.mts +3 -1
  199. package/dist/esm/api/resources/empathicVoice/types/UserMessage.d.mts +3 -1
  200. package/dist/esm/api/resources/empathicVoice/types/VoiceId.d.mts +1 -1
  201. package/dist/esm/api/resources/empathicVoice/types/VoiceName.d.mts +1 -1
  202. package/dist/esm/api/resources/empathicVoice/types/WebSocketError.d.mts +3 -1
  203. package/dist/esm/api/resources/empathicVoice/types/WebhookEventChatEnded.d.mts +2 -0
  204. package/dist/esm/api/resources/empathicVoice/types/WebhookEventChatStarted.d.mts +2 -0
  205. package/dist/esm/api/resources/empathicVoice/types/WebhookEventToolCall.d.mts +2 -0
  206. package/dist/esm/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.d.mts +2 -0
  207. package/dist/esm/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.mjs +2 -2
  208. package/dist/esm/api/resources/tts/resources/voices/client/Client.d.mts +1 -1
  209. package/dist/esm/api/resources/tts/resources/voices/client/Client.mjs +1 -1
  210. package/dist/esm/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.mts +1 -1
  211. package/dist/esm/api/resources/tts/types/PostedUtteranceVoiceWithId.d.mts +1 -1
  212. package/dist/esm/api/resources/tts/types/PostedUtteranceVoiceWithName.d.mts +1 -1
  213. package/dist/esm/api/resources/tts/types/ReturnPagedVoices.d.mts +5 -1
  214. package/dist/esm/core/schemas/builders/object/object.mjs +20 -2
  215. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventChatEnded.d.mts +1 -0
  216. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventChatEnded.mjs +1 -0
  217. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventChatStarted.d.mts +1 -0
  218. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventChatStarted.mjs +1 -0
  219. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventToolCall.d.mts +1 -0
  220. package/dist/esm/serialization/resources/empathicVoice/types/WebhookEventToolCall.mjs +1 -0
  221. package/dist/esm/version.d.mts +1 -1
  222. package/dist/esm/version.mjs +1 -1
  223. package/package.json +2 -2
  224. package/reference.md +630 -46
  225. package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
  226. package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
  227. package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
  228. package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "hume",
46
- "X-Fern-SDK-Version": "0.15.11",
47
- "User-Agent": "hume/0.15.11",
46
+ "X-Fern-SDK-Version": "0.15.13",
47
+ "User-Agent": "hume/0.15.13",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -11,6 +11,8 @@ export declare class ChatGroupsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ChatGroupsClient.Options>;
12
12
  constructor(options?: ChatGroupsClient.Options);
13
13
  /**
14
+ * Fetches a paginated list of **Chat Groups**.
15
+ *
14
16
  * @param {Hume.empathicVoice.ChatGroupsListChatGroupsRequest} request
15
17
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -26,7 +28,9 @@ export declare class ChatGroupsClient {
26
28
  */
27
29
  listChatGroups(request?: Hume.empathicVoice.ChatGroupsListChatGroupsRequest, requestOptions?: ChatGroupsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChatGroup, Hume.empathicVoice.ReturnPagedChatGroups>>;
28
30
  /**
29
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
31
+ * Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
32
+ *
33
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
30
34
  * @param {Hume.empathicVoice.ChatGroupsGetChatGroupRequest} request
31
35
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
32
36
  *
@@ -42,7 +46,9 @@ export declare class ChatGroupsClient {
42
46
  getChatGroup(id: string, request?: Hume.empathicVoice.ChatGroupsGetChatGroupRequest, requestOptions?: ChatGroupsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnChatGroupPagedChats>;
43
47
  private __getChatGroup;
44
48
  /**
45
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
49
+ * 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).
50
+ *
51
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
46
52
  * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request
47
53
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
48
54
  *
@@ -58,7 +64,9 @@ export declare class ChatGroupsClient {
58
64
  getAudio(id: string, request?: Hume.empathicVoice.ChatGroupsGetAudioRequest, requestOptions?: ChatGroupsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructions>;
59
65
  private __getAudio;
60
66
  /**
61
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
67
+ * Fetches a paginated list of **Chat** events associated with a **Chat Group**.
68
+ *
69
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
62
70
  * @param {Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest} request
63
71
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
64
72
  *
@@ -57,6 +57,8 @@ class ChatGroupsClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * Fetches a paginated list of **Chat Groups**.
61
+ *
60
62
  * @param {Hume.empathicVoice.ChatGroupsListChatGroupsRequest} request
61
63
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
62
64
  *
@@ -142,7 +144,9 @@ class ChatGroupsClient {
142
144
  });
143
145
  }
144
146
  /**
145
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
147
+ * Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
148
+ *
149
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
146
150
  * @param {Hume.empathicVoice.ChatGroupsGetChatGroupRequest} request
147
151
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
148
152
  *
@@ -215,7 +219,9 @@ class ChatGroupsClient {
215
219
  });
216
220
  }
217
221
  /**
218
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
222
+ * 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).
223
+ *
224
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
219
225
  * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request
220
226
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
221
227
  *
@@ -287,7 +293,9 @@ class ChatGroupsClient {
287
293
  });
288
294
  }
289
295
  /**
290
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
296
+ * Fetches a paginated list of **Chat** events associated with a **Chat Group**.
297
+ *
298
+ * @param {string} id - Identifier for a Chat Group. Formatted as a UUID.
291
299
  * @param {Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest} request
292
300
  * @param {ChatGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
293
301
  *
@@ -19,6 +19,6 @@ export interface ChatGroupsGetAudioRequest {
19
19
  * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
20
20
  */
21
21
  pageSize?: number;
22
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
22
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
23
23
  ascendingOrder?: boolean;
24
24
  }
@@ -21,6 +21,6 @@ export interface ChatGroupsGetChatGroupRequest {
21
21
  * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
22
22
  */
23
23
  pageNumber?: number;
24
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
24
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
25
25
  ascendingOrder?: boolean;
26
26
  }
@@ -19,6 +19,6 @@ export interface ChatGroupsListChatGroupEventsRequest {
19
19
  * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
20
20
  */
21
21
  pageNumber?: number;
22
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
22
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
23
23
  ascendingOrder?: boolean;
24
24
  }
@@ -20,8 +20,12 @@ export interface ChatGroupsListChatGroupsRequest {
20
20
  * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
21
21
  */
22
22
  pageSize?: number;
23
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
23
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
24
24
  ascendingOrder?: boolean;
25
- /** Filter chatgroups to only include chats that used this config in their most recent chat. */
25
+ /**
26
+ * The unique identifier for an EVI configuration.
27
+ *
28
+ * Filter Chat Groups to only include Chats that used this `config_id` in their most recent Chat.
29
+ */
26
30
  configId?: string;
27
31
  }
@@ -11,6 +11,8 @@ export declare class ChatsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ChatsClient.Options>;
12
12
  constructor(options?: ChatsClient.Options);
13
13
  /**
14
+ * Fetches a paginated list of **Chats**.
15
+ *
14
16
  * @param {Hume.empathicVoice.ChatsListChatsRequest} request
15
17
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -25,7 +27,9 @@ export declare class ChatsClient {
25
27
  */
26
28
  listChats(request?: Hume.empathicVoice.ChatsListChatsRequest, requestOptions?: ChatsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChat, Hume.empathicVoice.ReturnPagedChats>>;
27
29
  /**
28
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
30
+ * Fetches a paginated list of **Chat** events.
31
+ *
32
+ * @param {string} id - Identifier for a Chat. Formatted as a UUID.
29
33
  * @param {Hume.empathicVoice.ChatsListChatEventsRequest} request
30
34
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
31
35
  *
@@ -40,7 +44,9 @@ export declare class ChatsClient {
40
44
  */
41
45
  listChatEvents(id: string, request?: Hume.empathicVoice.ChatsListChatEventsRequest, requestOptions?: ChatsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChatEvent, Hume.empathicVoice.ReturnChatPagedEvents>>;
42
46
  /**
43
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
47
+ * 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).
48
+ *
49
+ * @param {string} id - Identifier for a Chat. Formatted as a UUID.
44
50
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
45
51
  *
46
52
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -57,6 +57,8 @@ class ChatsClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * Fetches a paginated list of **Chats**.
61
+ *
60
62
  * @param {Hume.empathicVoice.ChatsListChatsRequest} request
61
63
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
62
64
  *
@@ -142,7 +144,9 @@ class ChatsClient {
142
144
  });
143
145
  }
144
146
  /**
145
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
147
+ * Fetches a paginated list of **Chat** events.
148
+ *
149
+ * @param {string} id - Identifier for a Chat. Formatted as a UUID.
146
150
  * @param {Hume.empathicVoice.ChatsListChatEventsRequest} request
147
151
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
148
152
  *
@@ -226,7 +230,9 @@ class ChatsClient {
226
230
  });
227
231
  }
228
232
  /**
229
- * @param {string} id - Identifier for a chat. Formatted as a UUID.
233
+ * 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).
234
+ *
235
+ * @param {string} id - Identifier for a Chat. Formatted as a UUID.
230
236
  * @param {ChatsClient.RequestOptions} requestOptions - Request-specific configuration.
231
237
  *
232
238
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -19,6 +19,6 @@ export interface ChatsListChatEventsRequest {
19
19
  * This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
20
20
  */
21
21
  pageNumber?: number;
22
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
22
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
23
23
  ascendingOrder?: boolean;
24
24
  }
@@ -19,7 +19,7 @@ export interface ChatsListChatsRequest {
19
19
  * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
20
20
  */
21
21
  pageSize?: number;
22
- /** Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true. */
22
+ /** Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true. */
23
23
  ascendingOrder?: boolean;
24
24
  /** Filter to only include chats that used this config. */
25
25
  configId?: string;
@@ -11,6 +11,10 @@ export declare class ConfigsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ConfigsClient.Options>;
12
12
  constructor(options?: ConfigsClient.Options);
13
13
  /**
14
+ * Fetches a paginated list of **Configs**.
15
+ *
16
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
17
+ *
14
18
  * @param {Hume.empathicVoice.ConfigsListConfigsRequest} request
15
19
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
16
20
  *
@@ -24,6 +28,10 @@ export declare class ConfigsClient {
24
28
  */
25
29
  listConfigs(request?: Hume.empathicVoice.ConfigsListConfigsRequest, requestOptions?: ConfigsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnConfig, Hume.empathicVoice.ReturnPagedConfigs>>;
26
30
  /**
31
+ * Creates a **Config** which can be applied to EVI.
32
+ *
33
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
34
+ *
27
35
  * @param {Hume.empathicVoice.PostedConfig} request
28
36
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
29
37
  *
@@ -65,7 +73,11 @@ export declare class ConfigsClient {
65
73
  createConfig(request: Hume.empathicVoice.PostedConfig, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnConfig>;
66
74
  private __createConfig;
67
75
  /**
68
- * @param {string} id - Identifier for a config. Formatted as a UUID.
76
+ * Fetches a list of a **Config's** versions.
77
+ *
78
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
79
+ *
80
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
69
81
  * @param {Hume.empathicVoice.ConfigsListConfigVersionsRequest} request
70
82
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
71
83
  *
@@ -76,7 +88,11 @@ export declare class ConfigsClient {
76
88
  */
77
89
  listConfigVersions(id: string, request?: Hume.empathicVoice.ConfigsListConfigVersionsRequest, requestOptions?: ConfigsClient.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnConfig, Hume.empathicVoice.ReturnPagedConfigs>>;
78
90
  /**
79
- * @param {string} id - Identifier for a config. Formatted as a UUID.
91
+ * Updates a **Config** by creating a new version of the **Config**.
92
+ *
93
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
94
+ *
95
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
80
96
  * @param {Hume.empathicVoice.PostedConfigVersion} request
81
97
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
82
98
  *
@@ -121,7 +137,11 @@ export declare class ConfigsClient {
121
137
  createConfigVersion(id: string, request: Hume.empathicVoice.PostedConfigVersion, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnConfig>;
122
138
  private __createConfigVersion;
123
139
  /**
124
- * @param {string} id - Identifier for a config. Formatted as a UUID.
140
+ * Deletes a **Config** and its versions.
141
+ *
142
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
143
+ *
144
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
125
145
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
126
146
  *
127
147
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -132,7 +152,11 @@ export declare class ConfigsClient {
132
152
  deleteConfig(id: string, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<void>;
133
153
  private __deleteConfig;
134
154
  /**
135
- * @param {string} id - Identifier for a config. Formatted as a UUID.
155
+ * Updates the name of a **Config**.
156
+ *
157
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
158
+ *
159
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
136
160
  * @param {Hume.empathicVoice.PostedConfigName} request
137
161
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
138
162
  *
@@ -146,8 +170,16 @@ export declare class ConfigsClient {
146
170
  updateConfigName(id: string, request: Hume.empathicVoice.PostedConfigName, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<string>;
147
171
  private __updateConfigName;
148
172
  /**
149
- * @param {string} id - Identifier for a config. Formatted as a UUID.
150
- * @param {number} version - Version number for a config. Version numbers should be integers.
173
+ * Fetches a specified version of a **Config**.
174
+ *
175
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
176
+ *
177
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
178
+ * @param {number} version - Version number for a Config.
179
+ *
180
+ * 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.
181
+ *
182
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
151
183
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
152
184
  *
153
185
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -158,8 +190,16 @@ export declare class ConfigsClient {
158
190
  getConfigVersion(id: string, version: number, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<Hume.empathicVoice.ReturnConfig>;
159
191
  private __getConfigVersion;
160
192
  /**
161
- * @param {string} id - Identifier for a config. Formatted as a UUID.
162
- * @param {number} version - Version number for a config. Version numbers should be integers.
193
+ * Deletes a specified version of a **Config**.
194
+ *
195
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
196
+ *
197
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
198
+ * @param {number} version - Version number for a Config.
199
+ *
200
+ * 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.
201
+ *
202
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
163
203
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
164
204
  *
165
205
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -170,8 +210,16 @@ export declare class ConfigsClient {
170
210
  deleteConfigVersion(id: string, version: number, requestOptions?: ConfigsClient.RequestOptions): core.HttpResponsePromise<void>;
171
211
  private __deleteConfigVersion;
172
212
  /**
173
- * @param {string} id - Identifier for a config. Formatted as a UUID.
174
- * @param {number} version - Version number for a config. Version numbers should be integers.
213
+ * Updates the description of a **Config**.
214
+ *
215
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
216
+ *
217
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
218
+ * @param {number} version - Version number for a Config.
219
+ *
220
+ * 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.
221
+ *
222
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
175
223
  * @param {Hume.empathicVoice.PostedConfigVersionDescription} request
176
224
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
177
225
  *
@@ -57,6 +57,10 @@ class ConfigsClient {
57
57
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
58
  }
59
59
  /**
60
+ * Fetches a paginated list of **Configs**.
61
+ *
62
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
63
+ *
60
64
  * @param {Hume.empathicVoice.ConfigsListConfigsRequest} request
61
65
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
62
66
  *
@@ -140,6 +144,10 @@ class ConfigsClient {
140
144
  });
141
145
  }
142
146
  /**
147
+ * Creates a **Config** which can be applied to EVI.
148
+ *
149
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
150
+ *
143
151
  * @param {Hume.empathicVoice.PostedConfig} request
144
152
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
145
153
  *
@@ -237,7 +245,11 @@ class ConfigsClient {
237
245
  });
238
246
  }
239
247
  /**
240
- * @param {string} id - Identifier for a config. Formatted as a UUID.
248
+ * Fetches a list of a **Config's** versions.
249
+ *
250
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
251
+ *
252
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
241
253
  * @param {Hume.empathicVoice.ConfigsListConfigVersionsRequest} request
242
254
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
243
255
  *
@@ -317,7 +329,11 @@ class ConfigsClient {
317
329
  });
318
330
  }
319
331
  /**
320
- * @param {string} id - Identifier for a config. Formatted as a UUID.
332
+ * Updates a **Config** by creating a new version of the **Config**.
333
+ *
334
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
335
+ *
336
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
321
337
  * @param {Hume.empathicVoice.PostedConfigVersion} request
322
338
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
323
339
  *
@@ -418,7 +434,11 @@ class ConfigsClient {
418
434
  });
419
435
  }
420
436
  /**
421
- * @param {string} id - Identifier for a config. Formatted as a UUID.
437
+ * Deletes a **Config** and its versions.
438
+ *
439
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
440
+ *
441
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
422
442
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
423
443
  *
424
444
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -470,7 +490,11 @@ class ConfigsClient {
470
490
  });
471
491
  }
472
492
  /**
473
- * @param {string} id - Identifier for a config. Formatted as a UUID.
493
+ * Updates the name of a **Config**.
494
+ *
495
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
496
+ *
497
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
474
498
  * @param {Hume.empathicVoice.PostedConfigName} request
475
499
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
476
500
  *
@@ -532,8 +556,16 @@ class ConfigsClient {
532
556
  });
533
557
  }
534
558
  /**
535
- * @param {string} id - Identifier for a config. Formatted as a UUID.
536
- * @param {number} version - Version number for a config. Version numbers should be integers.
559
+ * Fetches a specified version of a **Config**.
560
+ *
561
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
562
+ *
563
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
564
+ * @param {number} version - Version number for a Config.
565
+ *
566
+ * 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.
567
+ *
568
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
537
569
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
538
570
  *
539
571
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -594,8 +626,16 @@ class ConfigsClient {
594
626
  });
595
627
  }
596
628
  /**
597
- * @param {string} id - Identifier for a config. Formatted as a UUID.
598
- * @param {number} version - Version number for a config. Version numbers should be integers.
629
+ * Deletes a specified version of a **Config**.
630
+ *
631
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
632
+ *
633
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
634
+ * @param {number} version - Version number for a Config.
635
+ *
636
+ * 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.
637
+ *
638
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
599
639
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
600
640
  *
601
641
  * @throws {@link Hume.empathicVoice.BadRequestError}
@@ -647,8 +687,16 @@ class ConfigsClient {
647
687
  });
648
688
  }
649
689
  /**
650
- * @param {string} id - Identifier for a config. Formatted as a UUID.
651
- * @param {number} version - Version number for a config. Version numbers should be integers.
690
+ * Updates the description of a **Config**.
691
+ *
692
+ * For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
693
+ *
694
+ * @param {string} id - Identifier for a Config. Formatted as a UUID.
695
+ * @param {number} version - Version number for a Config.
696
+ *
697
+ * 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.
698
+ *
699
+ * Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
652
700
  * @param {Hume.empathicVoice.PostedConfigVersionDescription} request
653
701
  * @param {ConfigsClient.RequestOptions} requestOptions - Request-specific configuration.
654
702
  *
@@ -15,6 +15,6 @@ export interface ConfigsListConfigVersionsRequest {
15
15
  * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
16
16
  */
17
17
  pageSize?: number;
18
- /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false. */
18
+ /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false. */
19
19
  restrictToMostRecent?: boolean;
20
20
  }
@@ -18,7 +18,7 @@ export interface ConfigsListConfigsRequest {
18
18
  * For example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10.
19
19
  */
20
20
  pageSize?: number;
21
- /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false. */
21
+ /** By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false. */
22
22
  restrictToMostRecent?: boolean;
23
23
  /** Filter to only include configs with this name. */
24
24
  name?: string;
@@ -38,7 +38,7 @@ export interface PostedConfig {
38
38
  builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
39
39
  ellmModel?: Hume.empathicVoice.PostedEllmModel;
40
40
  eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
41
- /** The version of the EVI used with this config. */
41
+ /** EVI version to use. Only versions `3` and `4-mini` are supported. */
42
42
  eviVersion: string;
43
43
  languageModel?: Hume.empathicVoice.PostedLanguageModel;
44
44
  /** Name applied to all versions of a particular Config. */
@@ -48,8 +48,9 @@ export interface PostedConfig {
48
48
  timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
49
49
  /** Tool specification for a Config. */
50
50
  tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
51
- /** Description that is appended to a specific version of a Config. */
51
+ /** An optional description of the Config version. */
52
52
  versionDescription?: string;
53
+ /** A voice specification associated with this Config. */
53
54
  voice?: Hume.empathicVoice.VoiceRef;
54
55
  /** Webhook config specifications for each subscriber. */
55
56
  webhooks?: (Hume.empathicVoice.PostedWebhookSpec | undefined)[];
@@ -41,7 +41,7 @@ export interface PostedConfigVersion {
41
41
  builtinTools?: (Hume.empathicVoice.PostedBuiltinTool | undefined)[];
42
42
  ellmModel?: Hume.empathicVoice.PostedEllmModel;
43
43
  eventMessages?: Hume.empathicVoice.PostedEventMessageSpecs;
44
- /** The version of the EVI used with this config. */
44
+ /** EVI version to use. Only versions `3` and `4-mini` are supported. */
45
45
  eviVersion: string;
46
46
  languageModel?: Hume.empathicVoice.PostedLanguageModel;
47
47
  nudges?: Hume.empathicVoice.PostedNudgeSpec;
@@ -49,7 +49,7 @@ export interface PostedConfigVersion {
49
49
  timeouts?: Hume.empathicVoice.PostedTimeoutSpecs;
50
50
  /** Tool specification for a Config. */
51
51
  tools?: (Hume.empathicVoice.PostedUserDefinedToolSpec | undefined)[];
52
- /** Description that is appended to a specific version of a Config. */
52
+ /** An optional description of the Config version. */
53
53
  versionDescription?: string;
54
54
  voice?: Hume.empathicVoice.VoiceRef;
55
55
  /** Webhook config specifications for each subscriber. */
@@ -5,6 +5,6 @@
5
5
  * }
6
6
  */
7
7
  export interface PostedConfigVersionDescription {
8
- /** Description that is appended to a specific version of a Config. */
8
+ /** An optional description of the Config version. */
9
9
  versionDescription?: string;
10
10
  }