hume 0.9.2 → 0.9.4

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 (224) hide show
  1. package/.mock/definition/api.yml +6 -6
  2. package/.mock/definition/empathic-voice/__package__.yml +3083 -2703
  3. package/.mock/definition/empathic-voice/chat.yml +143 -143
  4. package/.mock/definition/empathic-voice/chatGroups.yml +581 -508
  5. package/.mock/definition/empathic-voice/chats.yml +480 -449
  6. package/.mock/definition/empathic-voice/configs.yml +913 -871
  7. package/.mock/definition/empathic-voice/customVoices.yml +255 -234
  8. package/.mock/definition/empathic-voice/prompts.yml +523 -526
  9. package/.mock/definition/empathic-voice/tools.yml +588 -588
  10. package/.mock/definition/expression-measurement/batch/__package__.yml +1758 -1758
  11. package/.mock/definition/expression-measurement/stream/__package__.yml +486 -485
  12. package/.mock/fern.config.json +3 -3
  13. package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +17 -0
  14. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +83 -3
  15. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +29 -0
  16. package/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
  17. package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +12 -0
  18. package/api/resources/empathicVoice/resources/chats/client/Client.js +65 -2
  19. package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
  20. package/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
  21. package/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
  22. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
  23. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
  24. package/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
  25. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
  26. package/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
  27. package/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
  28. package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  29. package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
  30. package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  31. package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
  32. package/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
  33. package/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
  34. package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
  35. package/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
  36. package/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
  37. package/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
  38. package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
  39. package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
  40. package/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
  41. package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
  42. package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
  43. package/api/resources/empathicVoice/types/PostedVoice.d.ts +3 -3
  44. package/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
  45. package/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
  46. package/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
  47. package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
  48. package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
  49. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
  50. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
  51. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
  52. package/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
  53. package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
  54. package/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
  55. package/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
  56. package/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
  57. package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
  58. package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
  59. package/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
  60. package/api/resources/empathicVoice/types/ReturnVoice.d.ts +3 -3
  61. package/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
  62. package/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
  63. package/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
  64. package/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
  65. package/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  66. package/api/resources/empathicVoice/types/index.d.ts +8 -2
  67. package/api/resources/empathicVoice/types/index.js +8 -2
  68. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  69. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +17 -0
  70. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +83 -3
  71. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +29 -0
  72. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +1 -0
  73. package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +12 -0
  74. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +65 -2
  75. package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
  76. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
  77. package/dist/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +1 -1
  78. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
  79. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
  80. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.d.ts +2 -7
  81. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +8 -13
  82. package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/CustomVoicesListCustomVoicesRequest.d.ts +1 -1
  83. package/dist/api/resources/empathicVoice/resources/customVoices/client/requests/PostedCustomVoiceName.d.ts +0 -6
  84. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  85. package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +2 -2
  86. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  87. package/dist/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +1 -1
  88. package/dist/api/resources/empathicVoice/types/AudioOutput.d.ts +1 -1
  89. package/dist/api/resources/empathicVoice/types/PostedCustomVoice.d.ts +2 -2
  90. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +3 -2
  91. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +2 -1
  92. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +51 -9
  93. package/dist/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
  94. package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
  95. package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
  96. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
  97. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
  98. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
  99. package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +3 -3
  100. package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
  101. package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
  102. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
  103. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +5 -0
  104. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
  105. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
  106. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
  107. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +5 -0
  108. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
  109. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
  110. package/dist/api/resources/empathicVoice/types/ReturnCustomVoice.d.ts +2 -2
  111. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +3 -2
  112. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +2 -1
  113. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +51 -9
  114. package/dist/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
  115. package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
  116. package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
  117. package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
  118. package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +3 -3
  119. package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
  120. package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
  121. package/dist/api/resources/empathicVoice/types/UserInput.d.ts +3 -1
  122. package/dist/api/resources/empathicVoice/types/VoiceNameEnum.d.ts +2 -1
  123. package/dist/api/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  124. package/dist/api/resources/empathicVoice/types/index.d.ts +8 -2
  125. package/dist/api/resources/empathicVoice/types/index.js +8 -2
  126. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  127. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
  128. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
  129. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
  130. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
  131. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
  132. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
  133. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
  134. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
  135. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
  136. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
  137. package/dist/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
  138. package/dist/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
  139. package/dist/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
  140. package/dist/serialization/resources/empathicVoice/types/{ExtendedVoiceArgs.js → PostedVoiceProvider.js} +2 -7
  141. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
  142. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
  143. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
  144. package/{serialization/resources/empathicVoice/types/ExtendedVoiceArgs.js → dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js} +2 -7
  145. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
  146. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
  147. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
  148. package/{serialization/resources/empathicVoice/types/VoiceArgs.js → dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js} +2 -11
  149. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
  150. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
  151. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
  152. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
  153. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
  154. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
  155. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
  156. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
  157. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
  158. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
  159. package/dist/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
  160. package/dist/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
  161. package/dist/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
  162. package/dist/serialization/resources/empathicVoice/types/{VoiceArgs.js → ReturnVoiceProvider.js} +2 -11
  163. package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
  164. package/dist/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  165. package/dist/serialization/resources/empathicVoice/types/index.d.ts +8 -2
  166. package/dist/serialization/resources/empathicVoice/types/index.js +8 -2
  167. package/dist/version.d.ts +1 -1
  168. package/dist/version.js +1 -1
  169. package/package.json +1 -1
  170. package/reference.md +144 -144
  171. package/serialization/resources/empathicVoice/types/PostedCustomVoice.d.ts +1 -1
  172. package/serialization/resources/empathicVoice/types/PostedCustomVoice.js +1 -1
  173. package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.d.ts +1 -1
  174. package/serialization/resources/empathicVoice/types/PostedCustomVoiceBaseVoice.js +1 -1
  175. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +9 -2
  176. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +9 -2
  177. package/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
  178. package/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
  179. package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
  180. package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
  181. package/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
  182. package/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
  183. package/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
  184. package/serialization/resources/empathicVoice/types/PostedVoiceProvider.js +31 -0
  185. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
  186. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
  187. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
  188. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +31 -0
  189. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
  190. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
  191. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
  192. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +31 -0
  193. package/serialization/resources/empathicVoice/types/ReturnCustomVoice.d.ts +1 -1
  194. package/serialization/resources/empathicVoice/types/ReturnCustomVoice.js +1 -1
  195. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.d.ts +1 -1
  196. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceBaseVoice.js +1 -1
  197. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +9 -2
  198. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +9 -2
  199. package/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
  200. package/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
  201. package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
  202. package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
  203. package/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
  204. package/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
  205. package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
  206. package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.js +31 -0
  207. package/serialization/resources/empathicVoice/types/VoiceNameEnum.d.ts +1 -1
  208. package/serialization/resources/empathicVoice/types/VoiceNameEnum.js +1 -0
  209. package/serialization/resources/empathicVoice/types/index.d.ts +8 -2
  210. package/serialization/resources/empathicVoice/types/index.js +8 -2
  211. package/version.d.ts +1 -1
  212. package/version.js +1 -1
  213. package/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
  214. package/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
  215. package/dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -9
  216. package/dist/api/resources/empathicVoice/types/VoiceArgs.d.ts +0 -13
  217. package/dist/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
  218. package/dist/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
  219. package/serialization/resources/empathicVoice/types/ExtendedVoiceArgs.d.ts +0 -15
  220. package/serialization/resources/empathicVoice/types/VoiceArgs.d.ts +0 -19
  221. /package/api/resources/empathicVoice/{types/ExtendedVoiceArgs.js → resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
  222. /package/api/resources/empathicVoice/types/{VoiceArgs.js → ReturnChatAudioReconstruction.js} +0 -0
  223. /package/{dist/api/resources/empathicVoice/types/ExtendedVoiceArgs.js → api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js} +0 -0
  224. /package/dist/api/resources/empathicVoice/{types/VoiceArgs.js → resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.js} +0 -0
@@ -1,880 +1,922 @@
1
1
  imports:
2
- root: __package__.yml
2
+ root: __package__.yml
3
3
  service:
4
- auth: false
5
- base-path: ""
6
- endpoints:
7
- list-configs:
8
- path: /v0/evi/configs
9
- method: GET
10
- auth: true
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ list-configs:
8
+ path: /v0/evi/configs
9
+ method: GET
10
+ auth: true
11
+ docs: >-
12
+ Fetches a paginated list of **Configs**.
13
+
14
+
15
+ For more details on configuration options and how to configure EVI, see
16
+ our [configuration
17
+ guide](/docs/empathic-voice-interface-evi/configuration).
18
+ display-name: List configs
19
+ request:
20
+ name: ConfigsListConfigsRequest
21
+ query-parameters:
22
+ page_number:
23
+ type: optional<integer>
11
24
  docs: >-
12
- Fetches a paginated list of **Configs**.
13
-
14
-
15
- For more details on configuration options and how to configure EVI, see
16
- our [configuration
17
- guide](/docs/empathic-voice-interface-evi/configuration).
18
- display-name: List configs
19
- request:
20
- name: ConfigsListConfigsRequest
21
- query-parameters:
22
- page_number:
23
- type: optional<integer>
24
- docs: >-
25
- Specifies the page number to retrieve, enabling pagination.
26
-
27
-
28
- This parameter uses zero-based indexing. For example, setting
29
- `page_number` to 0 retrieves the first page of results (items 0-9
30
- if `page_size` is 10), setting `page_number` to 1 retrieves the
31
- second page (items 10-19), and so on. Defaults to 0, which
32
- retrieves the first page.
33
- page_size:
34
- type: optional<integer>
35
- docs: >-
36
- Specifies the maximum number of results to include per page,
37
- enabling pagination. The value must be between 1 and 100,
38
- inclusive.
39
-
40
-
41
- For example, if `page_size` is set to 10, each page will include
42
- up to 10 items. Defaults to 10.
43
- restrict_to_most_recent:
44
- type: optional<boolean>
45
- docs: >-
46
- By default, `restrict_to_most_recent` is set to true, returning
47
- only the latest version of each config. To include all versions of
48
- each config in the list, set `restrict_to_most_recent` to false.
49
- name:
50
- type: optional<string>
51
- docs: Filter to only include configs with this name.
52
- response:
53
- docs: Success
54
- type: root.ReturnPagedConfigs
55
- errors:
56
- - root.BadRequestError
57
- examples:
58
- - query-parameters:
59
- page_number: 0
60
- page_size: 1
61
- response:
62
- body:
63
- page_number: 0
64
- page_size: 1
65
- total_pages: 1
66
- configs_page:
67
- - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
68
- version: 0
69
- version_description: ""
70
- name: Weather Assistant Config
71
- created_on: 1715267200693
72
- modified_on: 1715267200693
73
- evi_version: "2"
74
- prompt:
75
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
76
- version: 0
77
- version_type: FIXED
78
- version_description: ""
79
- name: Weather Assistant Prompt
80
- created_on: 1715267200693
81
- modified_on: 1715267200693
82
- text: >-
83
- <role>You are an AI weather assistant providing users with
84
- accurate and up-to-date weather information. Respond to
85
- user queries concisely and clearly. Use simple language
86
- and avoid technical jargon. Provide temperature,
87
- precipitation, wind conditions, and any weather alerts.
88
- Include helpful tips if severe weather is expected.</role>
89
- voice:
90
- provider: HUME_AI
91
- name: SAMPLE VOICE
92
- custom_voice:
93
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
94
- version: 1
95
- name: SAMPLE VOICE
96
- created_on: 1724704587367
97
- modified_on: 1725489961583
98
- base_voice: KORA
99
- parameter_model: 20240715-4parameter
100
- parameters:
101
- gender: -7
102
- huskiness: -2
103
- nasality: -8
104
- pitch: -9
105
- language_model:
106
- model_provider: ANTHROPIC
107
- model_resource: claude-3-5-sonnet-20240620
108
- temperature: 1
109
- ellm_model:
110
- allow_short_responses: false
111
- tools: []
112
- builtin_tools: []
113
- event_messages:
114
- on_new_chat:
115
- enabled: false
116
- text: ""
117
- on_inactivity_timeout:
118
- enabled: false
119
- text: ""
120
- on_max_duration_timeout:
121
- enabled: false
122
- text: ""
123
- timeouts:
124
- inactivity:
125
- enabled: true
126
- duration_secs: 600
127
- max_duration:
128
- enabled: true
129
- duration_secs: 1800
130
- create-config:
131
- path: /v0/evi/configs
132
- method: POST
133
- auth: true
134
- docs: >-
135
- Creates a **Config** which can be applied to EVI.
136
-
137
-
138
- For more details on configuration options and how to configure EVI, see
139
- our [configuration
140
- guide](/docs/empathic-voice-interface-evi/configuration).
141
- display-name: Create config
142
- request:
143
- name: PostedConfig
144
- body:
145
- properties:
146
- evi_version:
147
- type: string
148
- docs: >-
149
- Specifies the EVI version to use. Use `"1"` for version 1, or
150
- `"2"` for the latest enhanced version. For a detailed comparison
151
- of the two versions, refer to our
152
- [guide](/docs/empathic-voice-interface-evi/evi-2).
153
- name:
154
- type: string
155
- docs: Name applied to all versions of a particular Config.
156
- version_description:
157
- type: optional<string>
158
- docs: An optional description of the Config version.
159
- prompt: optional<root.PostedConfigPromptSpec>
160
- voice:
161
- type: optional<root.PostedVoice>
162
- docs: A voice specification associated with this Config.
163
- language_model:
164
- type: optional<root.PostedLanguageModel>
165
- docs: >-
166
- The supplemental language model associated with this Config.
167
-
168
-
169
- This model is used to generate longer, more detailed responses
170
- from EVI. Choosing an appropriate supplemental language model
171
- for your use case is crucial for generating fast, high-quality
172
- responses from EVI.
173
- ellm_model:
174
- type: optional<root.PostedEllmModel>
175
- docs: >-
176
- The eLLM setup associated with this Config.
177
-
178
-
179
- Hume's eLLM (empathic Large Language Model) is a multimodal
180
- language model that takes into account both expression measures
181
- and language. The eLLM generates short, empathic language
182
- responses and guides text-to-speech (TTS) prosody.
183
- tools:
184
- type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
185
- docs: List of user-defined tools associated with this Config.
186
- builtin_tools:
187
- type: optional<list<optional<root.PostedBuiltinTool>>>
188
- docs: List of built-in tools associated with this Config.
189
- event_messages: optional<root.PostedEventMessageSpecs>
190
- timeouts: optional<root.PostedTimeoutSpecs>
191
- content-type: application/json
192
- response:
193
- docs: Created
194
- type: root.ReturnConfig
195
- errors:
196
- - root.BadRequestError
197
- examples:
198
- - request:
199
- name: Weather Assistant Config
200
- prompt:
201
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
202
- version: 0
203
- evi_version: "2"
204
- voice:
205
- provider: HUME_AI
206
- name: SAMPLE VOICE
207
- language_model:
208
- model_provider: ANTHROPIC
209
- model_resource: claude-3-5-sonnet-20240620
210
- temperature: 1
211
- event_messages:
212
- on_new_chat:
213
- enabled: false
214
- text: ""
215
- on_inactivity_timeout:
216
- enabled: false
217
- text: ""
218
- on_max_duration_timeout:
219
- enabled: false
220
- text: ""
221
- response:
222
- body:
223
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
224
- version: 0
225
- version_description: ""
226
- name: Weather Assistant Config
227
- created_on: 1715275452390
228
- modified_on: 1715275452390
229
- evi_version: "2"
230
- prompt:
231
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
232
- version: 0
233
- version_type: FIXED
234
- version_description: ""
235
- name: Weather Assistant Prompt
236
- created_on: 1715267200693
237
- modified_on: 1715267200693
238
- text: >-
239
- <role>You are an AI weather assistant providing users with
240
- accurate and up-to-date weather information. Respond to user
241
- queries concisely and clearly. Use simple language and avoid
242
- technical jargon. Provide temperature, precipitation, wind
243
- conditions, and any weather alerts. Include helpful tips if
244
- severe weather is expected.</role>
245
- voice:
246
- provider: HUME_AI
247
- name: SAMPLE VOICE
248
- custom_voice:
249
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
250
- version: 1
251
- name: SAMPLE VOICE
252
- created_on: 1724704587367
253
- modified_on: 1725489961583
254
- base_voice: KORA
255
- parameter_model: 20240715-4parameter
256
- parameters:
257
- gender: -7
258
- huskiness: -2
259
- nasality: -8
260
- pitch: -9
261
- language_model:
262
- model_provider: ANTHROPIC
263
- model_resource: claude-3-5-sonnet-20240620
264
- temperature: 1
265
- ellm_model:
266
- allow_short_responses: false
267
- tools: []
268
- builtin_tools: []
269
- event_messages:
270
- on_new_chat:
271
- enabled: false
272
- text: ""
273
- on_inactivity_timeout:
274
- enabled: false
275
- text: ""
276
- on_max_duration_timeout:
277
- enabled: false
278
- text: ""
279
- timeouts:
280
- inactivity:
281
- enabled: true
282
- duration_secs: 600
283
- max_duration:
284
- enabled: true
285
- duration_secs: 1800
286
- list-config-versions:
287
- path: /v0/evi/configs/{id}
288
- method: GET
289
- auth: true
290
- docs: >-
291
- Fetches a list of a **Config's** versions.
292
-
293
-
294
- For more details on configuration options and how to configure EVI, see
295
- our [configuration
296
- guide](/docs/empathic-voice-interface-evi/configuration).
297
- path-parameters:
298
- id:
299
- type: string
300
- docs: Identifier for a Config. Formatted as a UUID.
301
- display-name: List config versions
302
- request:
303
- name: ConfigsListConfigVersionsRequest
304
- query-parameters:
305
- page_number:
306
- type: optional<integer>
307
- docs: >-
308
- Specifies the page number to retrieve, enabling pagination.
309
-
310
-
311
- This parameter uses zero-based indexing. For example, setting
312
- `page_number` to 0 retrieves the first page of results (items 0-9
313
- if `page_size` is 10), setting `page_number` to 1 retrieves the
314
- second page (items 10-19), and so on. Defaults to 0, which
315
- retrieves the first page.
316
- page_size:
317
- type: optional<integer>
318
- docs: >-
319
- Specifies the maximum number of results to include per page,
320
- enabling pagination. The value must be between 1 and 100,
321
- inclusive.
322
-
323
-
324
- For example, if `page_size` is set to 10, each page will include
325
- up to 10 items. Defaults to 10.
326
- restrict_to_most_recent:
327
- type: optional<boolean>
328
- docs: >-
329
- By default, `restrict_to_most_recent` is set to true, returning
330
- only the latest version of each config. To include all versions of
331
- each config in the list, set `restrict_to_most_recent` to false.
332
- response:
333
- docs: Success
334
- type: root.ReturnPagedConfigs
335
- errors:
336
- - root.BadRequestError
337
- examples:
338
- - path-parameters:
339
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
340
- response:
341
- body:
342
- page_number: 0
343
- page_size: 10
344
- total_pages: 1
345
- configs_page:
346
- - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
347
- version: 0
348
- version_description: ""
349
- name: Weather Assistant Config
350
- created_on: 1715275452390
351
- modified_on: 1715275452390
352
- evi_version: "2"
353
- prompt:
354
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
355
- version: 0
356
- version_type: FIXED
357
- version_description: ""
358
- name: Weather Assistant Prompt
359
- created_on: 1715267200693
360
- modified_on: 1715267200693
361
- text: >-
362
- <role>You are an AI weather assistant providing users with
363
- accurate and up-to-date weather information. Respond to
364
- user queries concisely and clearly. Use simple language
365
- and avoid technical jargon. Provide temperature,
366
- precipitation, wind conditions, and any weather alerts.
367
- Include helpful tips if severe weather is expected.</role>
368
- voice:
369
- provider: HUME_AI
370
- name: SAMPLE VOICE
371
- custom_voice:
372
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
373
- version: 1
374
- name: SAMPLE VOICE
375
- created_on: 1724704587367
376
- modified_on: 1725489961583
377
- base_voice: KORA
378
- parameter_model: 20240715-4parameter
379
- parameters:
380
- gender: -7
381
- huskiness: -2
382
- nasality: -8
383
- pitch: -9
384
- language_model:
385
- model_provider: ANTHROPIC
386
- model_resource: claude-3-5-sonnet-20240620
387
- temperature: 1
388
- ellm_model:
389
- allow_short_responses: false
390
- tools: []
391
- builtin_tools: []
392
- event_messages:
393
- on_new_chat:
394
- enabled: false
395
- text: ""
396
- on_inactivity_timeout:
397
- enabled: false
398
- text: ""
399
- on_max_duration_timeout:
400
- enabled: false
401
- text: ""
402
- timeouts:
403
- inactivity:
404
- enabled: true
405
- duration_secs: 600
406
- max_duration:
407
- enabled: true
408
- duration_secs: 1800
409
- create-config-version:
410
- path: /v0/evi/configs/{id}
411
- method: POST
412
- auth: true
413
- docs: >-
414
- Updates a **Config** by creating a new version of the **Config**.
415
-
416
-
417
- For more details on configuration options and how to configure EVI, see
418
- our [configuration
419
- guide](/docs/empathic-voice-interface-evi/configuration).
420
- path-parameters:
421
- id:
422
- type: string
423
- docs: Identifier for a Config. Formatted as a UUID.
424
- display-name: Create config version
425
- request:
426
- name: PostedConfigVersion
427
- body:
428
- properties:
429
- evi_version:
430
- type: string
431
- docs: The version of the EVI used with this config.
432
- version_description:
433
- type: optional<string>
434
- docs: An optional description of the Config version.
435
- prompt: optional<root.PostedConfigPromptSpec>
436
- voice:
437
- type: optional<root.PostedVoice>
438
- docs: A voice specification associated with this Config version.
439
- language_model:
440
- type: optional<root.PostedLanguageModel>
441
- docs: >-
442
- The supplemental language model associated with this Config
443
- version.
444
-
445
-
446
- This model is used to generate longer, more detailed responses
447
- from EVI. Choosing an appropriate supplemental language model
448
- for your use case is crucial for generating fast, high-quality
449
- responses from EVI.
450
- ellm_model:
451
- type: optional<root.PostedEllmModel>
452
- docs: >-
453
- The eLLM setup associated with this Config version.
454
-
455
-
456
- Hume's eLLM (empathic Large Language Model) is a multimodal
457
- language model that takes into account both expression measures
458
- and language. The eLLM generates short, empathic language
459
- responses and guides text-to-speech (TTS) prosody.
460
- tools:
461
- type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
462
- docs: List of user-defined tools associated with this Config version.
463
- builtin_tools:
464
- type: optional<list<optional<root.PostedBuiltinTool>>>
465
- docs: List of built-in tools associated with this Config version.
466
- event_messages: optional<root.PostedEventMessageSpecs>
467
- timeouts: optional<root.PostedTimeoutSpecs>
468
- content-type: application/json
469
- response:
470
- docs: Created
471
- type: root.ReturnConfig
472
- errors:
473
- - root.BadRequestError
474
- examples:
475
- - path-parameters:
476
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
477
- request:
478
- version_description: This is an updated version of the Weather Assistant Config.
479
- evi_version: "2"
480
- prompt:
481
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
482
- version: 0
483
- voice:
484
- provider: HUME_AI
485
- name: ITO
486
- language_model:
487
- model_provider: ANTHROPIC
488
- model_resource: claude-3-5-sonnet-20240620
489
- temperature: 1
490
- ellm_model:
491
- allow_short_responses: true
492
- event_messages:
493
- on_new_chat:
494
- enabled: false
495
- text: ""
496
- on_inactivity_timeout:
497
- enabled: false
498
- text: ""
499
- on_max_duration_timeout:
500
- enabled: false
501
- text: ""
502
- response:
503
- body:
504
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
505
- version: 1
506
- version_description: This is an updated version of the Weather Assistant Config.
507
- name: Weather Assistant Config
508
- created_on: 1715275452390
509
- modified_on: 1722642242998
510
- evi_version: "2"
511
- prompt:
512
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
513
- version: 0
514
- version_type: FIXED
515
- version_description: ""
516
- name: Weather Assistant Prompt
517
- created_on: 1715267200693
518
- modified_on: 1715267200693
519
- text: >-
520
- <role>You are an AI weather assistant providing users with
521
- accurate and up-to-date weather information. Respond to user
522
- queries concisely and clearly. Use simple language and avoid
523
- technical jargon. Provide temperature, precipitation, wind
524
- conditions, and any weather alerts. Include helpful tips if
525
- severe weather is expected.</role>
526
- voice:
527
- provider: HUME_AI
528
- name: ITO
529
- custom_voice:
530
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
531
- version: 1
532
- name: SAMPLE VOICE
533
- created_on: 1724704587367
534
- modified_on: 1725489961583
535
- base_voice: KORA
536
- parameter_model: 20240715-4parameter
537
- parameters:
538
- gender: -7
539
- huskiness: -2
540
- nasality: -8
541
- pitch: -9
542
- language_model:
543
- model_provider: ANTHROPIC
544
- model_resource: claude-3-5-sonnet-20240620
545
- temperature: 1
546
- ellm_model:
547
- allow_short_responses: true
548
- tools: []
549
- builtin_tools: []
550
- event_messages:
551
- on_new_chat:
552
- enabled: false
553
- text: ""
554
- on_inactivity_timeout:
555
- enabled: false
556
- text: ""
557
- on_max_duration_timeout:
558
- enabled: false
559
- text: ""
560
- timeouts:
561
- inactivity:
562
- enabled: true
563
- duration_secs: 600
564
- max_duration:
565
- enabled: true
566
- duration_secs: 1800
567
- delete-config:
568
- path: /v0/evi/configs/{id}
569
- method: DELETE
570
- auth: true
571
- docs: >-
572
- Deletes a **Config** and its versions.
573
-
574
-
575
- For more details on configuration options and how to configure EVI, see
576
- our [configuration
577
- guide](/docs/empathic-voice-interface-evi/configuration).
578
- path-parameters:
579
- id:
580
- type: string
581
- docs: Identifier for a Config. Formatted as a UUID.
582
- display-name: Delete config
583
- errors:
584
- - root.BadRequestError
585
- examples:
586
- - path-parameters:
587
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
588
- update-config-name:
589
- path: /v0/evi/configs/{id}
590
- method: PATCH
591
- auth: true
25
+ Specifies the page number to retrieve, enabling pagination.
26
+
27
+
28
+ This parameter uses zero-based indexing. For example, setting
29
+ `page_number` to 0 retrieves the first page of results (items 0-9
30
+ if `page_size` is 10), setting `page_number` to 1 retrieves the
31
+ second page (items 10-19), and so on. Defaults to 0, which
32
+ retrieves the first page.
33
+ page_size:
34
+ type: optional<integer>
592
35
  docs: >-
593
- Updates the name of a **Config**.
594
-
595
-
596
- For more details on configuration options and how to configure EVI, see
597
- our [configuration
598
- guide](/docs/empathic-voice-interface-evi/configuration).
599
- path-parameters:
600
- id:
601
- type: string
602
- docs: Identifier for a Config. Formatted as a UUID.
603
- display-name: Update config name
604
- request:
605
- name: PostedConfigName
606
- body:
607
- properties:
608
- name:
609
- type: string
610
- docs: Name applied to all versions of a particular Config.
611
- content-type: application/json
612
- response:
613
- docs: Success
614
- type: text
615
- errors:
616
- - root.BadRequestError
617
- examples:
618
- - path-parameters:
619
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
620
- request:
621
- name: Updated Weather Assistant Config Name
622
- get-config-version:
623
- path: /v0/evi/configs/{id}/version/{version}
624
- method: GET
625
- auth: true
36
+ Specifies the maximum number of results to include per page,
37
+ enabling pagination. The value must be between 1 and 100,
38
+ inclusive.
39
+
40
+
41
+ For example, if `page_size` is set to 10, each page will include
42
+ up to 10 items. Defaults to 10.
43
+ restrict_to_most_recent:
44
+ type: optional<boolean>
626
45
  docs: >-
627
- Fetches a specified version of a **Config**.
628
-
629
-
630
- For more details on configuration options and how to configure EVI, see
631
- our [configuration
632
- guide](/docs/empathic-voice-interface-evi/configuration).
633
- path-parameters:
634
- id:
635
- type: string
636
- docs: Identifier for a Config. Formatted as a UUID.
637
- version:
638
- type: integer
639
- docs: >-
640
- Version number for a Config.
641
-
642
-
643
- Configs, Prompts, Custom Voices, and Tools are versioned. This
644
- versioning system supports iterative development, allowing you to
645
- progressively refine configurations and revert to previous versions
646
- if needed.
647
-
648
-
649
- Version numbers are integer values representing different iterations
650
- of the Config. Each update to the Config increments its version
651
- number.
652
- display-name: Get config version
653
- response:
654
- docs: Success
655
- type: root.ReturnConfig
656
- errors:
657
- - root.BadRequestError
658
- examples:
659
- - path-parameters:
660
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
46
+ By default, `restrict_to_most_recent` is set to true, returning
47
+ only the latest version of each tool. To include all versions of
48
+ each tool in the list, set `restrict_to_most_recent` to false.
49
+ name:
50
+ type: optional<string>
51
+ docs: Filter to only include configs with this name.
52
+ response:
53
+ docs: Success
54
+ type: root.ReturnPagedConfigs
55
+ errors:
56
+ - root.BadRequestError
57
+ examples:
58
+ - query-parameters:
59
+ page_number: 0
60
+ page_size: 1
61
+ response:
62
+ body:
63
+ page_number: 0
64
+ page_size: 1
65
+ total_pages: 1
66
+ configs_page:
67
+ - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
68
+ version: 0
69
+ version_description: ''
70
+ name: Weather Assistant Config
71
+ created_on: 1715267200693
72
+ modified_on: 1715267200693
73
+ evi_version: '2'
74
+ prompt:
75
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
76
+ version: 0
77
+ version_type: FIXED
78
+ version_description: ''
79
+ name: Weather Assistant Prompt
80
+ created_on: 1715267200693
81
+ modified_on: 1715267200693
82
+ text: >-
83
+ <role>You are an AI weather assistant providing users with
84
+ accurate and up-to-date weather information. Respond to
85
+ user queries concisely and clearly. Use simple language
86
+ and avoid technical jargon. Provide temperature,
87
+ precipitation, wind conditions, and any weather alerts.
88
+ Include helpful tips if severe weather is expected.</role>
89
+ voice:
90
+ provider: HUME_AI
91
+ name: SAMPLE VOICE
92
+ custom_voice:
93
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
661
94
  version: 1
662
- response:
663
- body:
664
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
665
- version: 1
666
- version_description: ""
667
- name: Weather Assistant Config
668
- created_on: 1715275452390
669
- modified_on: 1715275452390
670
- evi_version: "2"
671
- prompt:
672
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
673
- version: 0
674
- version_type: FIXED
675
- version_description: ""
676
- name: Weather Assistant Prompt
677
- created_on: 1715267200693
678
- modified_on: 1715267200693
679
- text: >-
680
- <role>You are an AI weather assistant providing users with
681
- accurate and up-to-date weather information. Respond to user
682
- queries concisely and clearly. Use simple language and avoid
683
- technical jargon. Provide temperature, precipitation, wind
684
- conditions, and any weather alerts. Include helpful tips if
685
- severe weather is expected.</role>
686
- voice:
687
- provider: HUME_AI
688
- name: SAMPLE VOICE
689
- custom_voice:
690
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
691
- version: 1
692
- name: SAMPLE VOICE
693
- created_on: 1724704587367
694
- modified_on: 1725489961583
695
- base_voice: KORA
696
- parameter_model: 20240715-4parameter
697
- parameters:
698
- gender: -7
699
- huskiness: -2
700
- nasality: -8
701
- pitch: -9
702
- language_model:
703
- model_provider: ANTHROPIC
704
- model_resource: claude-3-5-sonnet-20240620
705
- temperature: 1
706
- ellm_model:
707
- allow_short_responses: false
708
- tools: []
709
- builtin_tools: []
710
- event_messages:
711
- on_new_chat:
712
- enabled: false
713
- text: ""
714
- on_inactivity_timeout:
715
- enabled: false
716
- text: ""
717
- on_max_duration_timeout:
718
- enabled: false
719
- text: ""
720
- timeouts:
721
- inactivity:
722
- enabled: true
723
- duration_secs: 600
724
- max_duration:
725
- enabled: true
726
- duration_secs: 1800
727
- delete-config-version:
728
- path: /v0/evi/configs/{id}/version/{version}
729
- method: DELETE
730
- auth: true
95
+ name: SAMPLE VOICE
96
+ created_on: 1724704587367
97
+ modified_on: 1725489961583
98
+ base_voice: KORA
99
+ parameter_model: 20241004-11parameter
100
+ parameters:
101
+ gender: 0
102
+ articulation: -10
103
+ assertiveness: 20
104
+ buoyancy: -30
105
+ confidence: -40
106
+ enthusiasm: 50
107
+ nasality: 45
108
+ relaxedness: -35
109
+ smoothness: 25
110
+ tepidity: 15
111
+ tightness: 5
112
+ language_model:
113
+ model_provider: ANTHROPIC
114
+ model_resource: claude-3-5-sonnet-20240620
115
+ temperature: 1
116
+ ellm_model:
117
+ allow_short_responses: false
118
+ tools: []
119
+ builtin_tools: []
120
+ event_messages:
121
+ on_new_chat:
122
+ enabled: false
123
+ text: ''
124
+ on_inactivity_timeout:
125
+ enabled: false
126
+ text: ''
127
+ on_max_duration_timeout:
128
+ enabled: false
129
+ text: ''
130
+ timeouts:
131
+ inactivity:
132
+ enabled: true
133
+ duration_secs: 600
134
+ max_duration:
135
+ enabled: true
136
+ duration_secs: 1800
137
+ create-config:
138
+ path: /v0/evi/configs
139
+ method: POST
140
+ auth: true
141
+ docs: >-
142
+ Creates a **Config** which can be applied to EVI.
143
+
144
+
145
+ For more details on configuration options and how to configure EVI, see
146
+ our [configuration
147
+ guide](/docs/empathic-voice-interface-evi/configuration).
148
+ display-name: Create config
149
+ request:
150
+ name: PostedConfig
151
+ body:
152
+ properties:
153
+ evi_version:
154
+ type: string
155
+ docs: >-
156
+ Specifies the EVI version to use. Use `"1"` for version 1, or
157
+ `"2"` for the latest enhanced version. For a detailed comparison
158
+ of the two versions, refer to our
159
+ [guide](/docs/empathic-voice-interface-evi/evi-2).
160
+ name:
161
+ type: string
162
+ docs: Name applied to all versions of a particular Config.
163
+ version_description:
164
+ type: optional<string>
165
+ docs: An optional description of the Config version.
166
+ prompt: optional<root.PostedConfigPromptSpec>
167
+ voice:
168
+ type: optional<root.PostedVoice>
169
+ docs: A voice specification associated with this Config.
170
+ language_model:
171
+ type: optional<root.PostedLanguageModel>
172
+ docs: >-
173
+ The supplemental language model associated with this Config.
174
+
175
+
176
+ This model is used to generate longer, more detailed responses
177
+ from EVI. Choosing an appropriate supplemental language model
178
+ for your use case is crucial for generating fast, high-quality
179
+ responses from EVI.
180
+ ellm_model:
181
+ type: optional<root.PostedEllmModel>
182
+ docs: >-
183
+ The eLLM setup associated with this Config.
184
+
185
+
186
+ Hume's eLLM (empathic Large Language Model) is a multimodal
187
+ language model that takes into account both expression measures
188
+ and language. The eLLM generates short, empathic language
189
+ responses and guides text-to-speech (TTS) prosody.
190
+ tools:
191
+ type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
192
+ docs: List of user-defined tools associated with this Config.
193
+ builtin_tools:
194
+ type: optional<list<optional<root.PostedBuiltinTool>>>
195
+ docs: List of built-in tools associated with this Config.
196
+ event_messages: optional<root.PostedEventMessageSpecs>
197
+ timeouts: optional<root.PostedTimeoutSpecs>
198
+ content-type: application/json
199
+ response:
200
+ docs: Created
201
+ type: root.ReturnConfig
202
+ errors:
203
+ - root.BadRequestError
204
+ examples:
205
+ - request:
206
+ name: Weather Assistant Config
207
+ prompt:
208
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
209
+ version: 0
210
+ evi_version: '2'
211
+ voice:
212
+ provider: HUME_AI
213
+ name: SAMPLE VOICE
214
+ language_model:
215
+ model_provider: ANTHROPIC
216
+ model_resource: claude-3-5-sonnet-20240620
217
+ temperature: 1
218
+ event_messages:
219
+ on_new_chat:
220
+ enabled: false
221
+ text: ''
222
+ on_inactivity_timeout:
223
+ enabled: false
224
+ text: ''
225
+ on_max_duration_timeout:
226
+ enabled: false
227
+ text: ''
228
+ response:
229
+ body:
230
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
231
+ version: 0
232
+ version_description: ''
233
+ name: Weather Assistant Config
234
+ created_on: 1715275452390
235
+ modified_on: 1715275452390
236
+ evi_version: '2'
237
+ prompt:
238
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
239
+ version: 0
240
+ version_type: FIXED
241
+ version_description: ''
242
+ name: Weather Assistant Prompt
243
+ created_on: 1715267200693
244
+ modified_on: 1715267200693
245
+ text: >-
246
+ <role>You are an AI weather assistant providing users with
247
+ accurate and up-to-date weather information. Respond to user
248
+ queries concisely and clearly. Use simple language and avoid
249
+ technical jargon. Provide temperature, precipitation, wind
250
+ conditions, and any weather alerts. Include helpful tips if
251
+ severe weather is expected.</role>
252
+ voice:
253
+ provider: HUME_AI
254
+ name: SAMPLE VOICE
255
+ custom_voice:
256
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
257
+ version: 1
258
+ name: SAMPLE VOICE
259
+ created_on: 1724704587367
260
+ modified_on: 1725489961583
261
+ base_voice: KORA
262
+ parameter_model: 20241004-11parameter
263
+ parameters:
264
+ gender: 0
265
+ articulation: -10
266
+ assertiveness: 20
267
+ buoyancy: -30
268
+ confidence: -40
269
+ enthusiasm: 50
270
+ nasality: 45
271
+ relaxedness: -35
272
+ smoothness: 25
273
+ tepidity: 15
274
+ tightness: 5
275
+ language_model:
276
+ model_provider: ANTHROPIC
277
+ model_resource: claude-3-5-sonnet-20240620
278
+ temperature: 1
279
+ ellm_model:
280
+ allow_short_responses: false
281
+ tools: []
282
+ builtin_tools: []
283
+ event_messages:
284
+ on_new_chat:
285
+ enabled: false
286
+ text: ''
287
+ on_inactivity_timeout:
288
+ enabled: false
289
+ text: ''
290
+ on_max_duration_timeout:
291
+ enabled: false
292
+ text: ''
293
+ timeouts:
294
+ inactivity:
295
+ enabled: true
296
+ duration_secs: 600
297
+ max_duration:
298
+ enabled: true
299
+ duration_secs: 1800
300
+ list-config-versions:
301
+ path: /v0/evi/configs/{id}
302
+ method: GET
303
+ auth: true
304
+ docs: >-
305
+ Fetches a list of a **Config's** versions.
306
+
307
+
308
+ For more details on configuration options and how to configure EVI, see
309
+ our [configuration
310
+ guide](/docs/empathic-voice-interface-evi/configuration).
311
+ path-parameters:
312
+ id:
313
+ type: string
314
+ docs: Identifier for a Config. Formatted as a UUID.
315
+ display-name: List config versions
316
+ request:
317
+ name: ConfigsListConfigVersionsRequest
318
+ query-parameters:
319
+ page_number:
320
+ type: optional<integer>
731
321
  docs: >-
732
- Deletes a specified version of a **Config**.
733
-
734
-
735
- For more details on configuration options and how to configure EVI, see
736
- our [configuration
737
- guide](/docs/empathic-voice-interface-evi/configuration).
738
- path-parameters:
739
- id:
740
- type: string
741
- docs: Identifier for a Config. Formatted as a UUID.
742
- version:
743
- type: integer
744
- docs: >-
745
- Version number for a Config.
746
-
747
-
748
- Configs, Prompts, Custom Voices, and Tools are versioned. This
749
- versioning system supports iterative development, allowing you to
750
- progressively refine configurations and revert to previous versions
751
- if needed.
752
-
753
-
754
- Version numbers are integer values representing different iterations
755
- of the Config. Each update to the Config increments its version
756
- number.
757
- display-name: Delete config version
758
- errors:
759
- - root.BadRequestError
760
- examples:
761
- - path-parameters:
762
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
763
- version: 1
764
- update-config-description:
765
- path: /v0/evi/configs/{id}/version/{version}
766
- method: PATCH
767
- auth: true
322
+ Specifies the page number to retrieve, enabling pagination.
323
+
324
+
325
+ This parameter uses zero-based indexing. For example, setting
326
+ `page_number` to 0 retrieves the first page of results (items 0-9
327
+ if `page_size` is 10), setting `page_number` to 1 retrieves the
328
+ second page (items 10-19), and so on. Defaults to 0, which
329
+ retrieves the first page.
330
+ page_size:
331
+ type: optional<integer>
332
+ docs: >-
333
+ Specifies the maximum number of results to include per page,
334
+ enabling pagination. The value must be between 1 and 100,
335
+ inclusive.
336
+
337
+
338
+ For example, if `page_size` is set to 10, each page will include
339
+ up to 10 items. Defaults to 10.
340
+ restrict_to_most_recent:
341
+ type: optional<boolean>
768
342
  docs: >-
769
- Updates the description of a **Config**.
770
-
771
-
772
- For more details on configuration options and how to configure EVI, see
773
- our [configuration
774
- guide](/docs/empathic-voice-interface-evi/configuration).
775
- path-parameters:
776
- id:
777
- type: string
778
- docs: Identifier for a Config. Formatted as a UUID.
779
- version:
780
- type: integer
781
- docs: >-
782
- Version number for a Config.
783
-
784
-
785
- Configs, Prompts, Custom Voices, and Tools are versioned. This
786
- versioning system supports iterative development, allowing you to
787
- progressively refine configurations and revert to previous versions
788
- if needed.
789
-
790
-
791
- Version numbers are integer values representing different iterations
792
- of the Config. Each update to the Config increments its version
793
- number.
794
- display-name: Update config description
795
- request:
796
- name: PostedConfigVersionDescription
797
- body:
798
- properties:
799
- version_description:
800
- type: optional<string>
801
- docs: An optional description of the Config version.
802
- content-type: application/json
803
- response:
804
- docs: Success
805
- type: root.ReturnConfig
806
- errors:
807
- - root.BadRequestError
808
- examples:
809
- - path-parameters:
810
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
343
+ By default, `restrict_to_most_recent` is set to true, returning
344
+ only the latest version of each config. To include all versions of
345
+ each config in the list, set `restrict_to_most_recent` to false.
346
+ response:
347
+ docs: Success
348
+ type: root.ReturnPagedConfigs
349
+ errors:
350
+ - root.BadRequestError
351
+ examples:
352
+ - path-parameters:
353
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
354
+ response:
355
+ body:
356
+ page_number: 0
357
+ page_size: 10
358
+ total_pages: 1
359
+ configs_page:
360
+ - id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
361
+ version: 0
362
+ version_description: ''
363
+ name: Weather Assistant Config
364
+ created_on: 1715275452390
365
+ modified_on: 1715275452390
366
+ evi_version: '2'
367
+ prompt:
368
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
369
+ version: 0
370
+ version_type: FIXED
371
+ version_description: ''
372
+ name: Weather Assistant Prompt
373
+ created_on: 1715267200693
374
+ modified_on: 1715267200693
375
+ text: >-
376
+ <role>You are an AI weather assistant providing users with
377
+ accurate and up-to-date weather information. Respond to
378
+ user queries concisely and clearly. Use simple language
379
+ and avoid technical jargon. Provide temperature,
380
+ precipitation, wind conditions, and any weather alerts.
381
+ Include helpful tips if severe weather is expected.</role>
382
+ voice:
383
+ provider: HUME_AI
384
+ name: SAMPLE VOICE
385
+ custom_voice:
386
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
811
387
  version: 1
812
- request:
813
- version_description: This is an updated version_description.
814
- response:
815
- body:
816
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
817
- version: 1
818
- version_description: This is an updated version_description.
819
- name: Weather Assistant Config
820
- created_on: 1715275452390
821
- modified_on: 1715275452390
822
- evi_version: "2"
823
- prompt:
824
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
825
- version: 0
826
- version_type: FIXED
827
- version_description: ""
828
- name: Weather Assistant Prompt
829
- created_on: 1715267200693
830
- modified_on: 1715267200693
831
- text: >-
832
- <role>You are an AI weather assistant providing users with
833
- accurate and up-to-date weather information. Respond to user
834
- queries concisely and clearly. Use simple language and avoid
835
- technical jargon. Provide temperature, precipitation, wind
836
- conditions, and any weather alerts. Include helpful tips if
837
- severe weather is expected.</role>
838
- voice:
839
- provider: HUME_AI
840
- name: SAMPLE VOICE
841
- custom_voice:
842
- id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
843
- version: 1
844
- name: SAMPLE VOICE
845
- created_on: 1724704587367
846
- modified_on: 1725489961583
847
- base_voice: KORA
848
- parameter_model: 20240715-4parameter
849
- parameters:
850
- gender: -7
851
- huskiness: -2
852
- nasality: -8
853
- pitch: -9
854
- language_model:
855
- model_provider: ANTHROPIC
856
- model_resource: claude-3-5-sonnet-20240620
857
- temperature: 1
858
- ellm_model:
859
- allow_short_responses: false
860
- tools: []
861
- builtin_tools: []
862
- event_messages:
863
- on_new_chat:
864
- enabled: false
865
- text: ""
866
- on_inactivity_timeout:
867
- enabled: false
868
- text: ""
869
- on_max_duration_timeout:
870
- enabled: false
871
- text: ""
872
- timeouts:
873
- inactivity:
874
- enabled: true
875
- duration_secs: 600
876
- max_duration:
877
- enabled: true
878
- duration_secs: 1800
879
- source:
880
- openapi: stenographer-openapi.json
388
+ name: SAMPLE VOICE
389
+ created_on: 1724704587367
390
+ modified_on: 1725489961583
391
+ base_voice: KORA
392
+ parameter_model: 20241004-11parameter
393
+ parameters:
394
+ gender: 0
395
+ articulation: -10
396
+ assertiveness: 20
397
+ buoyancy: -30
398
+ confidence: -40
399
+ enthusiasm: 50
400
+ nasality: 45
401
+ relaxedness: -35
402
+ smoothness: 25
403
+ tepidity: 15
404
+ tightness: 5
405
+ language_model:
406
+ model_provider: ANTHROPIC
407
+ model_resource: claude-3-5-sonnet-20240620
408
+ temperature: 1
409
+ ellm_model:
410
+ allow_short_responses: false
411
+ tools: []
412
+ builtin_tools: []
413
+ event_messages:
414
+ on_new_chat:
415
+ enabled: false
416
+ text: ''
417
+ on_inactivity_timeout:
418
+ enabled: false
419
+ text: ''
420
+ on_max_duration_timeout:
421
+ enabled: false
422
+ text: ''
423
+ timeouts:
424
+ inactivity:
425
+ enabled: true
426
+ duration_secs: 600
427
+ max_duration:
428
+ enabled: true
429
+ duration_secs: 1800
430
+ create-config-version:
431
+ path: /v0/evi/configs/{id}
432
+ method: POST
433
+ auth: true
434
+ docs: >-
435
+ Updates a **Config** by creating a new version of the **Config**.
436
+
437
+
438
+ For more details on configuration options and how to configure EVI, see
439
+ our [configuration
440
+ guide](/docs/empathic-voice-interface-evi/configuration).
441
+ path-parameters:
442
+ id:
443
+ type: string
444
+ docs: Identifier for a Config. Formatted as a UUID.
445
+ display-name: Create config version
446
+ request:
447
+ name: PostedConfigVersion
448
+ body:
449
+ properties:
450
+ evi_version:
451
+ type: string
452
+ docs: The version of the EVI used with this config.
453
+ version_description:
454
+ type: optional<string>
455
+ docs: An optional description of the Config version.
456
+ prompt: optional<root.PostedConfigPromptSpec>
457
+ voice:
458
+ type: optional<root.PostedVoice>
459
+ docs: A voice specification associated with this Config version.
460
+ language_model:
461
+ type: optional<root.PostedLanguageModel>
462
+ docs: >-
463
+ The supplemental language model associated with this Config
464
+ version.
465
+
466
+
467
+ This model is used to generate longer, more detailed responses
468
+ from EVI. Choosing an appropriate supplemental language model
469
+ for your use case is crucial for generating fast, high-quality
470
+ responses from EVI.
471
+ ellm_model:
472
+ type: optional<root.PostedEllmModel>
473
+ docs: >-
474
+ The eLLM setup associated with this Config version.
475
+
476
+
477
+ Hume's eLLM (empathic Large Language Model) is a multimodal
478
+ language model that takes into account both expression measures
479
+ and language. The eLLM generates short, empathic language
480
+ responses and guides text-to-speech (TTS) prosody.
481
+ tools:
482
+ type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
483
+ docs: List of user-defined tools associated with this Config version.
484
+ builtin_tools:
485
+ type: optional<list<optional<root.PostedBuiltinTool>>>
486
+ docs: List of built-in tools associated with this Config version.
487
+ event_messages: optional<root.PostedEventMessageSpecs>
488
+ timeouts: optional<root.PostedTimeoutSpecs>
489
+ content-type: application/json
490
+ response:
491
+ docs: Created
492
+ type: root.ReturnConfig
493
+ errors:
494
+ - root.BadRequestError
495
+ examples:
496
+ - path-parameters:
497
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
498
+ request:
499
+ version_description: This is an updated version of the Weather Assistant Config.
500
+ evi_version: '2'
501
+ prompt:
502
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
503
+ version: 0
504
+ voice:
505
+ provider: HUME_AI
506
+ name: ITO
507
+ language_model:
508
+ model_provider: ANTHROPIC
509
+ model_resource: claude-3-5-sonnet-20240620
510
+ temperature: 1
511
+ ellm_model:
512
+ allow_short_responses: true
513
+ event_messages:
514
+ on_new_chat:
515
+ enabled: false
516
+ text: ''
517
+ on_inactivity_timeout:
518
+ enabled: false
519
+ text: ''
520
+ on_max_duration_timeout:
521
+ enabled: false
522
+ text: ''
523
+ response:
524
+ body:
525
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
526
+ version: 1
527
+ version_description: This is an updated version of the Weather Assistant Config.
528
+ name: Weather Assistant Config
529
+ created_on: 1715275452390
530
+ modified_on: 1722642242998
531
+ evi_version: '2'
532
+ prompt:
533
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
534
+ version: 0
535
+ version_type: FIXED
536
+ version_description: ''
537
+ name: Weather Assistant Prompt
538
+ created_on: 1715267200693
539
+ modified_on: 1715267200693
540
+ text: >-
541
+ <role>You are an AI weather assistant providing users with
542
+ accurate and up-to-date weather information. Respond to user
543
+ queries concisely and clearly. Use simple language and avoid
544
+ technical jargon. Provide temperature, precipitation, wind
545
+ conditions, and any weather alerts. Include helpful tips if
546
+ severe weather is expected.</role>
547
+ voice:
548
+ provider: HUME_AI
549
+ name: ITO
550
+ custom_voice:
551
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
552
+ version: 1
553
+ name: SAMPLE VOICE
554
+ created_on: 1724704587367
555
+ modified_on: 1725489961583
556
+ base_voice: KORA
557
+ parameter_model: 20241004-11parameter
558
+ parameters:
559
+ gender: 0
560
+ articulation: -10
561
+ assertiveness: 20
562
+ buoyancy: -30
563
+ confidence: -40
564
+ enthusiasm: 50
565
+ nasality: 45
566
+ relaxedness: -35
567
+ smoothness: 25
568
+ tepidity: 15
569
+ tightness: 5
570
+ language_model:
571
+ model_provider: ANTHROPIC
572
+ model_resource: claude-3-5-sonnet-20240620
573
+ temperature: 1
574
+ ellm_model:
575
+ allow_short_responses: true
576
+ tools: []
577
+ builtin_tools: []
578
+ event_messages:
579
+ on_new_chat:
580
+ enabled: false
581
+ text: ''
582
+ on_inactivity_timeout:
583
+ enabled: false
584
+ text: ''
585
+ on_max_duration_timeout:
586
+ enabled: false
587
+ text: ''
588
+ timeouts:
589
+ inactivity:
590
+ enabled: true
591
+ duration_secs: 600
592
+ max_duration:
593
+ enabled: true
594
+ duration_secs: 1800
595
+ delete-config:
596
+ path: /v0/evi/configs/{id}
597
+ method: DELETE
598
+ auth: true
599
+ docs: >-
600
+ Deletes a **Config** and its versions.
601
+
602
+
603
+ For more details on configuration options and how to configure EVI, see
604
+ our [configuration
605
+ guide](/docs/empathic-voice-interface-evi/configuration).
606
+ path-parameters:
607
+ id:
608
+ type: string
609
+ docs: Identifier for a Config. Formatted as a UUID.
610
+ display-name: Delete config
611
+ errors:
612
+ - root.BadRequestError
613
+ examples:
614
+ - path-parameters:
615
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
616
+ update-config-name:
617
+ path: /v0/evi/configs/{id}
618
+ method: PATCH
619
+ auth: true
620
+ docs: >-
621
+ Updates the name of a **Config**.
622
+
623
+
624
+ For more details on configuration options and how to configure EVI, see
625
+ our [configuration
626
+ guide](/docs/empathic-voice-interface-evi/configuration).
627
+ path-parameters:
628
+ id:
629
+ type: string
630
+ docs: Identifier for a Config. Formatted as a UUID.
631
+ display-name: Update config name
632
+ request:
633
+ name: PostedConfigName
634
+ body:
635
+ properties:
636
+ name:
637
+ type: string
638
+ docs: Name applied to all versions of a particular Config.
639
+ content-type: application/json
640
+ response:
641
+ docs: Success
642
+ type: text
643
+ errors:
644
+ - root.BadRequestError
645
+ examples:
646
+ - path-parameters:
647
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
648
+ request:
649
+ name: Updated Weather Assistant Config Name
650
+ get-config-version:
651
+ path: /v0/evi/configs/{id}/version/{version}
652
+ method: GET
653
+ auth: true
654
+ docs: >-
655
+ Fetches a specified version of a **Config**.
656
+
657
+
658
+ For more details on configuration options and how to configure EVI, see
659
+ our [configuration
660
+ guide](/docs/empathic-voice-interface-evi/configuration).
661
+ path-parameters:
662
+ id:
663
+ type: string
664
+ docs: Identifier for a Config. Formatted as a UUID.
665
+ version:
666
+ type: integer
667
+ docs: >-
668
+ Version number for a Config.
669
+
670
+
671
+ Configs, Prompts, Custom Voices, and Tools are versioned. This
672
+ versioning system supports iterative development, allowing you to
673
+ progressively refine configurations and revert to previous versions
674
+ if needed.
675
+
676
+
677
+ Version numbers are integer values representing different iterations
678
+ of the Config. Each update to the Config increments its version
679
+ number.
680
+ display-name: Get config version
681
+ response:
682
+ docs: Success
683
+ type: root.ReturnConfig
684
+ errors:
685
+ - root.BadRequestError
686
+ examples:
687
+ - path-parameters:
688
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
689
+ version: 1
690
+ response:
691
+ body:
692
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
693
+ version: 1
694
+ version_description: ''
695
+ name: Weather Assistant Config
696
+ created_on: 1715275452390
697
+ modified_on: 1715275452390
698
+ evi_version: '2'
699
+ prompt:
700
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
701
+ version: 0
702
+ version_type: FIXED
703
+ version_description: ''
704
+ name: Weather Assistant Prompt
705
+ created_on: 1715267200693
706
+ modified_on: 1715267200693
707
+ text: >-
708
+ <role>You are an AI weather assistant providing users with
709
+ accurate and up-to-date weather information. Respond to user
710
+ queries concisely and clearly. Use simple language and avoid
711
+ technical jargon. Provide temperature, precipitation, wind
712
+ conditions, and any weather alerts. Include helpful tips if
713
+ severe weather is expected.</role>
714
+ voice:
715
+ provider: HUME_AI
716
+ name: SAMPLE VOICE
717
+ custom_voice:
718
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
719
+ version: 1
720
+ name: SAMPLE VOICE
721
+ created_on: 1724704587367
722
+ modified_on: 1725489961583
723
+ base_voice: KORA
724
+ parameter_model: 20241004-11parameter
725
+ parameters:
726
+ gender: 0
727
+ articulation: -10
728
+ assertiveness: 20
729
+ buoyancy: -30
730
+ confidence: -40
731
+ enthusiasm: 50
732
+ nasality: 45
733
+ relaxedness: -35
734
+ smoothness: 25
735
+ tepidity: 15
736
+ tightness: 5
737
+ language_model:
738
+ model_provider: ANTHROPIC
739
+ model_resource: claude-3-5-sonnet-20240620
740
+ temperature: 1
741
+ ellm_model:
742
+ allow_short_responses: false
743
+ tools: []
744
+ builtin_tools: []
745
+ event_messages:
746
+ on_new_chat:
747
+ enabled: false
748
+ text: ''
749
+ on_inactivity_timeout:
750
+ enabled: false
751
+ text: ''
752
+ on_max_duration_timeout:
753
+ enabled: false
754
+ text: ''
755
+ timeouts:
756
+ inactivity:
757
+ enabled: true
758
+ duration_secs: 600
759
+ max_duration:
760
+ enabled: true
761
+ duration_secs: 1800
762
+ delete-config-version:
763
+ path: /v0/evi/configs/{id}/version/{version}
764
+ method: DELETE
765
+ auth: true
766
+ docs: >-
767
+ Deletes a specified version of a **Config**.
768
+
769
+
770
+ For more details on configuration options and how to configure EVI, see
771
+ our [configuration
772
+ guide](/docs/empathic-voice-interface-evi/configuration).
773
+ path-parameters:
774
+ id:
775
+ type: string
776
+ docs: Identifier for a Config. Formatted as a UUID.
777
+ version:
778
+ type: integer
779
+ docs: >-
780
+ Version number for a Config.
781
+
782
+
783
+ Configs, Prompts, Custom Voices, and Tools are versioned. This
784
+ versioning system supports iterative development, allowing you to
785
+ progressively refine configurations and revert to previous versions
786
+ if needed.
787
+
788
+
789
+ Version numbers are integer values representing different iterations
790
+ of the Config. Each update to the Config increments its version
791
+ number.
792
+ display-name: Delete config version
793
+ errors:
794
+ - root.BadRequestError
795
+ examples:
796
+ - path-parameters:
797
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
798
+ version: 1
799
+ update-config-description:
800
+ path: /v0/evi/configs/{id}/version/{version}
801
+ method: PATCH
802
+ auth: true
803
+ docs: >-
804
+ Updates the description of a **Config**.
805
+
806
+
807
+ For more details on configuration options and how to configure EVI, see
808
+ our [configuration
809
+ guide](/docs/empathic-voice-interface-evi/configuration).
810
+ path-parameters:
811
+ id:
812
+ type: string
813
+ docs: Identifier for a Config. Formatted as a UUID.
814
+ version:
815
+ type: integer
816
+ docs: >-
817
+ Version number for a Config.
818
+
819
+
820
+ Configs, Prompts, Custom Voices, and Tools are versioned. This
821
+ versioning system supports iterative development, allowing you to
822
+ progressively refine configurations and revert to previous versions
823
+ if needed.
824
+
825
+
826
+ Version numbers are integer values representing different iterations
827
+ of the Config. Each update to the Config increments its version
828
+ number.
829
+ display-name: Update config description
830
+ request:
831
+ name: PostedConfigVersionDescription
832
+ body:
833
+ properties:
834
+ version_description:
835
+ type: optional<string>
836
+ docs: An optional description of the Config version.
837
+ content-type: application/json
838
+ response:
839
+ docs: Success
840
+ type: root.ReturnConfig
841
+ errors:
842
+ - root.BadRequestError
843
+ examples:
844
+ - path-parameters:
845
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
846
+ version: 1
847
+ request:
848
+ version_description: This is an updated version_description.
849
+ response:
850
+ body:
851
+ id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
852
+ version: 1
853
+ version_description: This is an updated version_description.
854
+ name: Weather Assistant Config
855
+ created_on: 1715275452390
856
+ modified_on: 1715275452390
857
+ evi_version: '2'
858
+ prompt:
859
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
860
+ version: 0
861
+ version_type: FIXED
862
+ version_description: ''
863
+ name: Weather Assistant Prompt
864
+ created_on: 1715267200693
865
+ modified_on: 1715267200693
866
+ text: >-
867
+ <role>You are an AI weather assistant providing users with
868
+ accurate and up-to-date weather information. Respond to user
869
+ queries concisely and clearly. Use simple language and avoid
870
+ technical jargon. Provide temperature, precipitation, wind
871
+ conditions, and any weather alerts. Include helpful tips if
872
+ severe weather is expected.</role>
873
+ voice:
874
+ provider: HUME_AI
875
+ name: SAMPLE VOICE
876
+ custom_voice:
877
+ id: 00aa8ee9-c50e-4ea1-9af0-7b08ad451704
878
+ version: 1
879
+ name: SAMPLE VOICE
880
+ created_on: 1724704587367
881
+ modified_on: 1725489961583
882
+ base_voice: KORA
883
+ parameter_model: 20241004-11parameter
884
+ parameters:
885
+ gender: 0
886
+ articulation: -10
887
+ assertiveness: 20
888
+ buoyancy: -30
889
+ confidence: -40
890
+ enthusiasm: 50
891
+ nasality: 45
892
+ relaxedness: -35
893
+ smoothness: 25
894
+ tepidity: 15
895
+ tightness: 5
896
+ language_model:
897
+ model_provider: ANTHROPIC
898
+ model_resource: claude-3-5-sonnet-20240620
899
+ temperature: 1
900
+ ellm_model:
901
+ allow_short_responses: false
902
+ tools: []
903
+ builtin_tools: []
904
+ event_messages:
905
+ on_new_chat:
906
+ enabled: false
907
+ text: ''
908
+ on_inactivity_timeout:
909
+ enabled: false
910
+ text: ''
911
+ on_max_duration_timeout:
912
+ enabled: false
913
+ text: ''
914
+ timeouts:
915
+ inactivity:
916
+ enabled: true
917
+ duration_secs: 600
918
+ max_duration:
919
+ enabled: true
920
+ duration_secs: 1800
921
+ source:
922
+ openapi: stenographer-openapi.json