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,533 +1,530 @@
1
1
  imports:
2
- root: __package__.yml
2
+ root: __package__.yml
3
3
  service:
4
- auth: false
5
- base-path: ""
6
- endpoints:
7
- list-prompts:
8
- path: /v0/evi/prompts
9
- method: GET
10
- auth: true
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ list-prompts:
8
+ path: /v0/evi/prompts
9
+ method: GET
10
+ auth: true
11
+ docs: >-
12
+ Fetches a paginated list of **Prompts**.
13
+
14
+
15
+ See our [prompting
16
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
17
+ crafting your system prompt.
18
+ pagination:
19
+ offset: $request.page_number
20
+ results: $response.prompts_page
21
+ display-name: List prompts
22
+ request:
23
+ name: PromptsListPromptsRequest
24
+ query-parameters:
25
+ page_number:
26
+ type: optional<integer>
11
27
  docs: >-
12
- Fetches a paginated list of **Prompts**.
13
-
14
-
15
- See our [prompting
16
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
17
- crafting your system prompt.
18
- pagination:
19
- offset: $request.page_number
20
- results: $response.prompts_page
21
- display-name: List prompts
22
- request:
23
- name: PromptsListPromptsRequest
24
- query-parameters:
25
- page_number:
26
- type: optional<integer>
27
- docs: >-
28
- Specifies the page number to retrieve, enabling pagination.
29
-
30
-
31
- This parameter uses zero-based indexing. For example, setting
32
- `page_number` to 0 retrieves the first page of results (items 0-9
33
- if `page_size` is 10), setting `page_number` to 1 retrieves the
34
- second page (items 10-19), and so on. Defaults to 0, which
35
- retrieves the first page.
36
- page_size:
37
- type: optional<integer>
38
- docs: >-
39
- Specifies the maximum number of results to include per page,
40
- enabling pagination. The value must be between 1 and 100,
41
- inclusive.
42
-
43
-
44
- For example, if `page_size` is set to 10, each page will include
45
- up to 10 items. Defaults to 10.
46
- restrict_to_most_recent:
47
- type: optional<boolean>
48
- docs: >-
49
- By default, `restrict_to_most_recent` is set to true, returning
50
- only the latest version of each prompt. To include all versions of
51
- each prompt in the list, set `restrict_to_most_recent` to false.
52
- name:
53
- type: optional<string>
54
- docs: Filter to only include prompts with this name.
55
- response:
56
- docs: Success
57
- type: root.ReturnPagedPrompts
58
- errors:
59
- - root.BadRequestError
60
- examples:
61
- - query-parameters:
62
- page_number: 0
63
- page_size: 2
64
- response:
65
- body:
66
- page_number: 0
67
- page_size: 2
68
- total_pages: 1
69
- prompts_page:
70
- - id: af699d45-2985-42cc-91b9-af9e5da3bac5
71
- version: 0
72
- version_type: FIXED
73
- version_description: ""
74
- name: Weather Assistant Prompt
75
- created_on: 1715267200693
76
- modified_on: 1715267200693
77
- text: >-
78
- <role>You are an AI weather assistant providing users with
79
- accurate and up-to-date weather information. Respond to user
80
- queries concisely and clearly. Use simple language and avoid
81
- technical jargon. Provide temperature, precipitation, wind
82
- conditions, and any weather alerts. Include helpful tips if
83
- severe weather is expected.</role>
84
- - id: 616b2b4c-a096-4445-9c23-64058b564fc2
85
- version: 0
86
- version_type: FIXED
87
- version_description: ""
88
- name: Web Search Assistant Prompt
89
- created_on: 1715267200693
90
- modified_on: 1715267200693
91
- text: >-
92
- <role>You are an AI web search assistant designed to help
93
- users find accurate and relevant information on the web.
94
- Respond to user queries promptly, using the built-in web
95
- search tool to retrieve up-to-date results. Present
96
- information clearly and concisely, summarizing key points
97
- where necessary. Use simple language and avoid technical
98
- jargon. If needed, provide helpful tips for refining search
99
- queries to obtain better results.</role>
100
- create-prompt:
101
- path: /v0/evi/prompts
102
- method: POST
103
- auth: true
104
- docs: >-
105
- Creates a **Prompt** that can be added to an [EVI
106
- configuration](/reference/empathic-voice-interface-evi/configs/create-config).
107
-
108
-
109
- See our [prompting
110
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
111
- crafting your system prompt.
112
- display-name: Create prompt
113
- request:
114
- name: PostedPrompt
115
- body:
116
- properties:
117
- name:
118
- type: string
119
- docs: Name applied to all versions of a particular Prompt.
120
- version_description:
121
- type: optional<string>
122
- docs: An optional description of the Prompt version.
123
- text:
124
- type: string
125
- docs: >-
126
- Instructions used to shape EVI’s behavior, responses, and style.
127
-
128
-
129
- You can use the Prompt to define a specific goal or role for
130
- EVI, specifying how it should act or what it should focus on
131
- during the conversation. For example, EVI can be instructed to
132
- act as a customer support representative, a fitness coach, or a
133
- travel advisor, each with its own set of behaviors and response
134
- styles.
135
-
136
-
137
- For help writing a system prompt, see our [Prompting
138
- Guide](/docs/empathic-voice-interface-evi/prompting).
139
- content-type: application/json
140
- response:
141
- docs: Created
142
- type: optional<root.ReturnPrompt>
143
- errors:
144
- - root.BadRequestError
145
- examples:
146
- - request:
147
- name: Weather Assistant Prompt
148
- text: >-
149
- <role>You are an AI weather assistant providing users with
150
- accurate and up-to-date weather information. Respond to user
151
- queries concisely and clearly. Use simple language and avoid
152
- technical jargon. Provide temperature, precipitation, wind
153
- conditions, and any weather alerts. Include helpful tips if severe
154
- weather is expected.</role>
155
- response:
156
- body:
157
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
158
- version: 0
159
- version_type: FIXED
160
- name: Weather Assistant Prompt
161
- created_on: 1722633247488
162
- modified_on: 1722633247488
163
- text: >-
164
- <role>You are an AI weather assistant providing users with
165
- accurate and up-to-date weather information. Respond to user
166
- queries concisely and clearly. Use simple language and avoid
167
- technical jargon. Provide temperature, precipitation, wind
168
- conditions, and any weather alerts. Include helpful tips if
169
- severe weather is expected.</role>
170
- list-prompt-versions:
171
- path: /v0/evi/prompts/{id}
172
- method: GET
173
- auth: true
174
- docs: >-
175
- Fetches a list of a **Prompt's** versions.
176
-
177
-
178
- See our [prompting
179
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
180
- crafting your system prompt.
181
- path-parameters:
182
- id:
183
- type: string
184
- docs: Identifier for a Prompt. Formatted as a UUID.
185
- display-name: List prompt versions
186
- request:
187
- name: PromptsListPromptVersionsRequest
188
- query-parameters:
189
- page_number:
190
- type: optional<integer>
191
- docs: >-
192
- Specifies the page number to retrieve, enabling pagination.
193
-
194
-
195
- This parameter uses zero-based indexing. For example, setting
196
- `page_number` to 0 retrieves the first page of results (items 0-9
197
- if `page_size` is 10), setting `page_number` to 1 retrieves the
198
- second page (items 10-19), and so on. Defaults to 0, which
199
- retrieves the first page.
200
- page_size:
201
- type: optional<integer>
202
- docs: >-
203
- Specifies the maximum number of results to include per page,
204
- enabling pagination. The value must be between 1 and 100,
205
- inclusive.
206
-
207
-
208
- For example, if `page_size` is set to 10, each page will include
209
- up to 10 items. Defaults to 10.
210
- restrict_to_most_recent:
211
- type: optional<boolean>
212
- docs: >-
213
- By default, `restrict_to_most_recent` is set to true, returning
214
- only the latest version of each prompt. To include all versions of
215
- each prompt in the list, set `restrict_to_most_recent` to false.
216
- response:
217
- docs: Success
218
- type: root.ReturnPagedPrompts
219
- errors:
220
- - root.BadRequestError
221
- examples:
222
- - path-parameters:
223
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
224
- response:
225
- body:
226
- page_number: 0
227
- page_size: 10
228
- total_pages: 1
229
- prompts_page:
230
- - id: af699d45-2985-42cc-91b9-af9e5da3bac5
231
- version: 0
232
- version_type: FIXED
233
- version_description: ""
234
- name: Weather Assistant Prompt
235
- created_on: 1722633247488
236
- modified_on: 1722633247488
237
- text: >-
238
- <role>You are an AI weather assistant providing users with
239
- accurate and up-to-date weather information. Respond to user
240
- queries concisely and clearly. Use simple language and avoid
241
- technical jargon. Provide temperature, precipitation, wind
242
- conditions, and any weather alerts. Include helpful tips if
243
- severe weather is expected.</role>
244
- create-prompt-verison:
245
- path: /v0/evi/prompts/{id}
246
- method: POST
247
- auth: true
248
- docs: >-
249
- Updates a **Prompt** by creating a new version of the **Prompt**.
250
-
251
-
252
- See our [prompting
253
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
254
- crafting your system prompt.
255
- path-parameters:
256
- id:
257
- type: string
258
- docs: Identifier for a Prompt. Formatted as a UUID.
259
- display-name: Create prompt version
260
- request:
261
- name: PostedPromptVersion
262
- body:
263
- properties:
264
- version_description:
265
- type: optional<string>
266
- docs: An optional description of the Prompt version.
267
- text:
268
- type: string
269
- docs: >-
270
- Instructions used to shape EVI’s behavior, responses, and style
271
- for this version of the Prompt.
272
-
273
-
274
- You can use the Prompt to define a specific goal or role for
275
- EVI, specifying how it should act or what it should focus on
276
- during the conversation. For example, EVI can be instructed to
277
- act as a customer support representative, a fitness coach, or a
278
- travel advisor, each with its own set of behaviors and response
279
- styles.
280
-
281
-
282
- For help writing a system prompt, see our [Prompting
283
- Guide](/docs/empathic-voice-interface-evi/prompting).
284
- content-type: application/json
285
- response:
286
- docs: Created
287
- type: optional<root.ReturnPrompt>
288
- errors:
289
- - root.BadRequestError
290
- examples:
291
- - path-parameters:
292
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
293
- request:
294
- text: >-
295
- <role>You are an updated version of an AI weather assistant
296
- providing users with accurate and up-to-date weather information.
297
- Respond to user queries concisely and clearly. Use simple language
298
- and avoid technical jargon. Provide temperature, precipitation,
299
- wind conditions, and any weather alerts. Include helpful tips if
300
- severe weather is expected.</role>
301
- version_description: This is an updated version of the Weather Assistant Prompt.
302
- response:
303
- body:
304
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
305
- version: 1
306
- version_type: FIXED
307
- version_description: This is an updated version of the Weather Assistant Prompt.
308
- name: Weather Assistant Prompt
309
- created_on: 1722633247488
310
- modified_on: 1722635140150
311
- text: >-
312
- <role>You are an updated version of an AI weather assistant
313
- providing users with accurate and up-to-date weather
314
- information. Respond to user queries concisely and clearly. Use
315
- simple language and avoid technical jargon. Provide temperature,
316
- precipitation, wind conditions, and any weather alerts. Include
317
- helpful tips if severe weather is expected.</role>
318
- delete-prompt:
319
- path: /v0/evi/prompts/{id}
320
- method: DELETE
321
- auth: true
322
- docs: >-
323
- Deletes a **Prompt** and its versions.
324
-
325
-
326
- See our [prompting
327
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
328
- crafting your system prompt.
329
- path-parameters:
330
- id:
331
- type: string
332
- docs: Identifier for a Prompt. Formatted as a UUID.
333
- display-name: Delete prompt
334
- errors:
335
- - root.BadRequestError
336
- examples:
337
- - path-parameters:
338
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
339
- update-prompt-name:
340
- path: /v0/evi/prompts/{id}
341
- method: PATCH
342
- auth: true
28
+ Specifies the page number to retrieve, enabling pagination.
29
+
30
+
31
+ This parameter uses zero-based indexing. For example, setting
32
+ `page_number` to 0 retrieves the first page of results (items 0-9
33
+ if `page_size` is 10), setting `page_number` to 1 retrieves the
34
+ second page (items 10-19), and so on. Defaults to 0, which
35
+ retrieves the first page.
36
+ page_size:
37
+ type: optional<integer>
343
38
  docs: >-
344
- Updates the name of a **Prompt**.
345
-
346
-
347
- See our [prompting
348
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
349
- crafting your system prompt.
350
- path-parameters:
351
- id:
352
- type: string
353
- docs: Identifier for a Prompt. Formatted as a UUID.
354
- display-name: Update prompt name
355
- request:
356
- name: PostedPromptName
357
- body:
358
- properties:
359
- name:
360
- type: string
361
- docs: Name applied to all versions of a particular Prompt.
362
- content-type: application/json
363
- response:
364
- docs: Success
365
- type: text
366
- errors:
367
- - root.BadRequestError
368
- examples:
369
- - path-parameters:
370
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
371
- request:
372
- name: Updated Weather Assistant Prompt Name
373
- get-prompt-version:
374
- path: /v0/evi/prompts/{id}/version/{version}
375
- method: GET
376
- auth: true
39
+ Specifies the maximum number of results to include per page,
40
+ enabling pagination. The value must be between 1 and 100,
41
+ inclusive.
42
+
43
+
44
+ For example, if `page_size` is set to 10, each page will include
45
+ up to 10 items. Defaults to 10.
46
+ restrict_to_most_recent:
47
+ type: optional<boolean>
48
+ docs: Only include the most recent version of each prompt in the list.
49
+ name:
50
+ type: optional<string>
51
+ docs: Filter to only include prompts with name.
52
+ response:
53
+ docs: Success
54
+ type: root.ReturnPagedPrompts
55
+ errors:
56
+ - root.BadRequestError
57
+ examples:
58
+ - query-parameters:
59
+ page_number: 0
60
+ page_size: 2
61
+ response:
62
+ body:
63
+ page_number: 0
64
+ page_size: 2
65
+ total_pages: 1
66
+ prompts_page:
67
+ - id: af699d45-2985-42cc-91b9-af9e5da3bac5
68
+ version: 0
69
+ version_type: FIXED
70
+ version_description: ''
71
+ name: Weather Assistant Prompt
72
+ created_on: 1715267200693
73
+ modified_on: 1715267200693
74
+ text: >-
75
+ <role>You are an AI weather assistant providing users with
76
+ accurate and up-to-date weather information. Respond to user
77
+ queries concisely and clearly. Use simple language and avoid
78
+ technical jargon. Provide temperature, precipitation, wind
79
+ conditions, and any weather alerts. Include helpful tips if
80
+ severe weather is expected.</role>
81
+ - id: 616b2b4c-a096-4445-9c23-64058b564fc2
82
+ version: 0
83
+ version_type: FIXED
84
+ version_description: ''
85
+ name: Web Search Assistant Prompt
86
+ created_on: 1715267200693
87
+ modified_on: 1715267200693
88
+ text: >-
89
+ <role>You are an AI web search assistant designed to help
90
+ users find accurate and relevant information on the web.
91
+ Respond to user queries promptly, using the built-in web
92
+ search tool to retrieve up-to-date results. Present
93
+ information clearly and concisely, summarizing key points
94
+ where necessary. Use simple language and avoid technical
95
+ jargon. If needed, provide helpful tips for refining search
96
+ queries to obtain better results.</role>
97
+ create-prompt:
98
+ path: /v0/evi/prompts
99
+ method: POST
100
+ auth: true
101
+ docs: >-
102
+ Creates a **Prompt** that can be added to an [EVI
103
+ configuration](/reference/empathic-voice-interface-evi/configs/create-config).
104
+
105
+
106
+ See our [prompting
107
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
108
+ crafting your system prompt.
109
+ display-name: Create prompt
110
+ request:
111
+ name: PostedPrompt
112
+ body:
113
+ properties:
114
+ name:
115
+ type: string
116
+ docs: Name applied to all versions of a particular Prompt.
117
+ version_description:
118
+ type: optional<string>
119
+ docs: An optional description of the Prompt version.
120
+ text:
121
+ type: string
122
+ docs: >-
123
+ Instructions used to shape EVI’s behavior, responses, and style.
124
+
125
+
126
+ You can use the Prompt to define a specific goal or role for
127
+ EVI, specifying how it should act or what it should focus on
128
+ during the conversation. For example, EVI can be instructed to
129
+ act as a customer support representative, a fitness coach, or a
130
+ travel advisor, each with its own set of behaviors and response
131
+ styles.
132
+
133
+
134
+ For help writing a system prompt, see our [Prompting
135
+ Guide](/docs/empathic-voice-interface-evi/prompting).
136
+ content-type: application/json
137
+ response:
138
+ docs: Created
139
+ type: optional<root.ReturnPrompt>
140
+ errors:
141
+ - root.BadRequestError
142
+ examples:
143
+ - request:
144
+ name: Weather Assistant Prompt
145
+ text: >-
146
+ <role>You are an AI weather assistant providing users with
147
+ accurate and up-to-date weather information. Respond to user
148
+ queries concisely and clearly. Use simple language and avoid
149
+ technical jargon. Provide temperature, precipitation, wind
150
+ conditions, and any weather alerts. Include helpful tips if severe
151
+ weather is expected.</role>
152
+ response:
153
+ body:
154
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
155
+ version: 0
156
+ version_type: FIXED
157
+ name: Weather Assistant Prompt
158
+ created_on: 1722633247488
159
+ modified_on: 1722633247488
160
+ text: >-
161
+ <role>You are an AI weather assistant providing users with
162
+ accurate and up-to-date weather information. Respond to user
163
+ queries concisely and clearly. Use simple language and avoid
164
+ technical jargon. Provide temperature, precipitation, wind
165
+ conditions, and any weather alerts. Include helpful tips if
166
+ severe weather is expected.</role>
167
+ list-prompt-versions:
168
+ path: /v0/evi/prompts/{id}
169
+ method: GET
170
+ auth: true
171
+ docs: >-
172
+ Fetches a list of a **Prompt's** versions.
173
+
174
+
175
+ See our [prompting
176
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
177
+ crafting your system prompt.
178
+ path-parameters:
179
+ id:
180
+ type: string
181
+ docs: Identifier for a Prompt. Formatted as a UUID.
182
+ display-name: List prompt versions
183
+ request:
184
+ name: PromptsListPromptVersionsRequest
185
+ query-parameters:
186
+ page_number:
187
+ type: optional<integer>
377
188
  docs: >-
378
- Fetches a specified version of a **Prompt**.
379
-
380
-
381
- See our [prompting
382
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
383
- crafting your system prompt.
384
- path-parameters:
385
- id:
386
- type: string
387
- docs: Identifier for a Prompt. Formatted as a UUID.
388
- version:
389
- type: integer
390
- docs: >-
391
- Version number for a Prompt.
392
-
393
-
394
- Prompts, Configs, Custom Voices, and Tools are versioned. This
395
- versioning system supports iterative development, allowing you to
396
- progressively refine prompts and revert to previous versions if
397
- needed.
398
-
399
-
400
- Version numbers are integer values representing different iterations
401
- of the Prompt. Each update to the Prompt increments its version
402
- number.
403
- display-name: Get prompt version
404
- response:
405
- docs: Success
406
- type: optional<root.ReturnPrompt>
407
- errors:
408
- - root.BadRequestError
409
- examples:
410
- - path-parameters:
411
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
412
- version: 0
413
- response:
414
- body:
415
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
416
- version: 0
417
- version_type: FIXED
418
- version_description: ""
419
- name: Weather Assistant Prompt
420
- created_on: 1722633247488
421
- modified_on: 1722633247488
422
- text: >-
423
- <role>You are an AI weather assistant providing users with
424
- accurate and up-to-date weather information. Respond to user
425
- queries concisely and clearly. Use simple language and avoid
426
- technical jargon. Provide temperature, precipitation, wind
427
- conditions, and any weather alerts. Include helpful tips if
428
- severe weather is expected.</role>
429
- delete-prompt-version:
430
- path: /v0/evi/prompts/{id}/version/{version}
431
- method: DELETE
432
- auth: true
189
+ Specifies the page number to retrieve, enabling pagination.
190
+
191
+
192
+ This parameter uses zero-based indexing. For example, setting
193
+ `page_number` to 0 retrieves the first page of results (items 0-9
194
+ if `page_size` is 10), setting `page_number` to 1 retrieves the
195
+ second page (items 10-19), and so on. Defaults to 0, which
196
+ retrieves the first page.
197
+ page_size:
198
+ type: optional<integer>
433
199
  docs: >-
434
- Deletes a specified version of a **Prompt**.
435
-
436
-
437
- See our [prompting
438
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
439
- crafting your system prompt.
440
- path-parameters:
441
- id:
442
- type: string
443
- docs: Identifier for a Prompt. Formatted as a UUID.
444
- version:
445
- type: integer
446
- docs: >-
447
- Version number for a Prompt.
448
-
449
-
450
- Prompts, Configs, Custom Voices, and Tools are versioned. This
451
- versioning system supports iterative development, allowing you to
452
- progressively refine prompts and revert to previous versions if
453
- needed.
454
-
455
-
456
- Version numbers are integer values representing different iterations
457
- of the Prompt. Each update to the Prompt increments its version
458
- number.
459
- display-name: Delete prompt version
460
- errors:
461
- - root.BadRequestError
462
- examples:
463
- - path-parameters:
464
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
465
- version: 1
466
- update-prompt-description:
467
- path: /v0/evi/prompts/{id}/version/{version}
468
- method: PATCH
469
- auth: true
200
+ Specifies the maximum number of results to include per page,
201
+ enabling pagination. The value must be between 1 and 100,
202
+ inclusive.
203
+
204
+
205
+ For example, if `page_size` is set to 10, each page will include
206
+ up to 10 items. Defaults to 10.
207
+ restrict_to_most_recent:
208
+ type: optional<boolean>
470
209
  docs: >-
471
- Updates the description of a **Prompt**.
472
-
473
-
474
- See our [prompting
475
- guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
476
- crafting your system prompt.
477
- path-parameters:
478
- id:
479
- type: string
480
- docs: Identifier for a Prompt. Formatted as a UUID.
481
- version:
482
- type: integer
483
- docs: >-
484
- Version number for a Prompt.
485
-
486
-
487
- Prompts, Configs, Custom Voices, and Tools are versioned. This
488
- versioning system supports iterative development, allowing you to
489
- progressively refine prompts and revert to previous versions if
490
- needed.
491
-
492
-
493
- Version numbers are integer values representing different iterations
494
- of the Prompt. Each update to the Prompt increments its version
495
- number.
496
- display-name: Update prompt description
497
- request:
498
- name: PostedPromptVersionDescription
499
- body:
500
- properties:
501
- version_description:
502
- type: optional<string>
503
- docs: An optional description of the Prompt version.
504
- content-type: application/json
505
- response:
506
- docs: Success
507
- type: optional<root.ReturnPrompt>
508
- errors:
509
- - root.BadRequestError
510
- examples:
511
- - path-parameters:
512
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
513
- version: 1
514
- request:
515
- version_description: This is an updated version_description.
516
- response:
517
- body:
518
- id: af699d45-2985-42cc-91b9-af9e5da3bac5
519
- version: 1
520
- version_type: FIXED
521
- version_description: This is an updated version_description.
522
- name: string
523
- created_on: 1722633247488
524
- modified_on: 1722634770585
525
- text: >-
526
- <role>You are an AI weather assistant providing users with
527
- accurate and up-to-date weather information. Respond to user
528
- queries concisely and clearly. Use simple language and avoid
529
- technical jargon. Provide temperature, precipitation, wind
530
- conditions, and any weather alerts. Include helpful tips if
531
- severe weather is expected.</role>
532
- source:
533
- openapi: stenographer-openapi.json
210
+ By default, `restrict_to_most_recent` is set to true, returning
211
+ only the latest version of each prompt. To include all versions of
212
+ each prompt in the list, set `restrict_to_most_recent` to false.
213
+ response:
214
+ docs: Success
215
+ type: root.ReturnPagedPrompts
216
+ errors:
217
+ - root.BadRequestError
218
+ examples:
219
+ - path-parameters:
220
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
221
+ response:
222
+ body:
223
+ page_number: 0
224
+ page_size: 10
225
+ total_pages: 1
226
+ prompts_page:
227
+ - id: af699d45-2985-42cc-91b9-af9e5da3bac5
228
+ version: 0
229
+ version_type: FIXED
230
+ version_description: ''
231
+ name: Weather Assistant Prompt
232
+ created_on: 1722633247488
233
+ modified_on: 1722633247488
234
+ text: >-
235
+ <role>You are an AI weather assistant providing users with
236
+ accurate and up-to-date weather information. Respond to user
237
+ queries concisely and clearly. Use simple language and avoid
238
+ technical jargon. Provide temperature, precipitation, wind
239
+ conditions, and any weather alerts. Include helpful tips if
240
+ severe weather is expected.</role>
241
+ create-prompt-verison:
242
+ path: /v0/evi/prompts/{id}
243
+ method: POST
244
+ auth: true
245
+ docs: >-
246
+ Updates a **Prompt** by creating a new version of the **Prompt**.
247
+
248
+
249
+ See our [prompting
250
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
251
+ crafting your system prompt.
252
+ path-parameters:
253
+ id:
254
+ type: string
255
+ docs: Identifier for a Prompt. Formatted as a UUID.
256
+ display-name: Create prompt version
257
+ request:
258
+ name: PostedPromptVersion
259
+ body:
260
+ properties:
261
+ version_description:
262
+ type: optional<string>
263
+ docs: An optional description of the Prompt version.
264
+ text:
265
+ type: string
266
+ docs: >-
267
+ Instructions used to shape EVI’s behavior, responses, and style
268
+ for this version of the Prompt.
269
+
270
+
271
+ You can use the Prompt to define a specific goal or role for
272
+ EVI, specifying how it should act or what it should focus on
273
+ during the conversation. For example, EVI can be instructed to
274
+ act as a customer support representative, a fitness coach, or a
275
+ travel advisor, each with its own set of behaviors and response
276
+ styles.
277
+
278
+
279
+ For help writing a system prompt, see our [Prompting
280
+ Guide](/docs/empathic-voice-interface-evi/prompting).
281
+ content-type: application/json
282
+ response:
283
+ docs: Created
284
+ type: optional<root.ReturnPrompt>
285
+ errors:
286
+ - root.BadRequestError
287
+ examples:
288
+ - path-parameters:
289
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
290
+ request:
291
+ text: >-
292
+ <role>You are an updated version of an AI weather assistant
293
+ providing users with accurate and up-to-date weather information.
294
+ Respond to user queries concisely and clearly. Use simple language
295
+ and avoid technical jargon. Provide temperature, precipitation,
296
+ wind conditions, and any weather alerts. Include helpful tips if
297
+ severe weather is expected.</role>
298
+ version_description: This is an updated version of the Weather Assistant Prompt.
299
+ response:
300
+ body:
301
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
302
+ version: 1
303
+ version_type: FIXED
304
+ version_description: This is an updated version of the Weather Assistant Prompt.
305
+ name: Weather Assistant Prompt
306
+ created_on: 1722633247488
307
+ modified_on: 1722635140150
308
+ text: >-
309
+ <role>You are an updated version of an AI weather assistant
310
+ providing users with accurate and up-to-date weather
311
+ information. Respond to user queries concisely and clearly. Use
312
+ simple language and avoid technical jargon. Provide temperature,
313
+ precipitation, wind conditions, and any weather alerts. Include
314
+ helpful tips if severe weather is expected.</role>
315
+ delete-prompt:
316
+ path: /v0/evi/prompts/{id}
317
+ method: DELETE
318
+ auth: true
319
+ docs: >-
320
+ Deletes a **Prompt** and its versions.
321
+
322
+
323
+ See our [prompting
324
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
325
+ crafting your system prompt.
326
+ path-parameters:
327
+ id:
328
+ type: string
329
+ docs: Identifier for a Prompt. Formatted as a UUID.
330
+ display-name: Delete prompt
331
+ errors:
332
+ - root.BadRequestError
333
+ examples:
334
+ - path-parameters:
335
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
336
+ update-prompt-name:
337
+ path: /v0/evi/prompts/{id}
338
+ method: PATCH
339
+ auth: true
340
+ docs: >-
341
+ Updates the name of a **Prompt**.
342
+
343
+
344
+ See our [prompting
345
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
346
+ crafting your system prompt.
347
+ path-parameters:
348
+ id:
349
+ type: string
350
+ docs: Identifier for a Prompt. Formatted as a UUID.
351
+ display-name: Update prompt name
352
+ request:
353
+ name: PostedPromptName
354
+ body:
355
+ properties:
356
+ name:
357
+ type: string
358
+ docs: Name applied to all versions of a particular Prompt.
359
+ content-type: application/json
360
+ response:
361
+ docs: Success
362
+ type: text
363
+ errors:
364
+ - root.BadRequestError
365
+ examples:
366
+ - path-parameters:
367
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
368
+ request:
369
+ name: Updated Weather Assistant Prompt Name
370
+ get-prompt-version:
371
+ path: /v0/evi/prompts/{id}/version/{version}
372
+ method: GET
373
+ auth: true
374
+ docs: >-
375
+ Fetches a specified version of a **Prompt**.
376
+
377
+
378
+ See our [prompting
379
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
380
+ crafting your system prompt.
381
+ path-parameters:
382
+ id:
383
+ type: string
384
+ docs: Identifier for a Prompt. Formatted as a UUID.
385
+ version:
386
+ type: integer
387
+ docs: >-
388
+ Version number for a Prompt.
389
+
390
+
391
+ Prompts, Configs, Custom Voices, and Tools are versioned. This
392
+ versioning system supports iterative development, allowing you to
393
+ progressively refine prompts and revert to previous versions if
394
+ needed.
395
+
396
+
397
+ Version numbers are integer values representing different iterations
398
+ of the Prompt. Each update to the Prompt increments its version
399
+ number.
400
+ display-name: Get prompt version
401
+ response:
402
+ docs: Success
403
+ type: optional<root.ReturnPrompt>
404
+ errors:
405
+ - root.BadRequestError
406
+ examples:
407
+ - path-parameters:
408
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
409
+ version: 0
410
+ response:
411
+ body:
412
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
413
+ version: 0
414
+ version_type: FIXED
415
+ version_description: ''
416
+ name: Weather Assistant Prompt
417
+ created_on: 1722633247488
418
+ modified_on: 1722633247488
419
+ text: >-
420
+ <role>You are an AI weather assistant providing users with
421
+ accurate and up-to-date weather information. Respond to user
422
+ queries concisely and clearly. Use simple language and avoid
423
+ technical jargon. Provide temperature, precipitation, wind
424
+ conditions, and any weather alerts. Include helpful tips if
425
+ severe weather is expected.</role>
426
+ delete-prompt-version:
427
+ path: /v0/evi/prompts/{id}/version/{version}
428
+ method: DELETE
429
+ auth: true
430
+ docs: >-
431
+ Deletes a specified version of a **Prompt**.
432
+
433
+
434
+ See our [prompting
435
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
436
+ crafting your system prompt.
437
+ path-parameters:
438
+ id:
439
+ type: string
440
+ docs: Identifier for a Prompt. Formatted as a UUID.
441
+ version:
442
+ type: integer
443
+ docs: >-
444
+ Version number for a Prompt.
445
+
446
+
447
+ Prompts, Configs, Custom Voices, and Tools are versioned. This
448
+ versioning system supports iterative development, allowing you to
449
+ progressively refine prompts and revert to previous versions if
450
+ needed.
451
+
452
+
453
+ Version numbers are integer values representing different iterations
454
+ of the Prompt. Each update to the Prompt increments its version
455
+ number.
456
+ display-name: Delete prompt version
457
+ errors:
458
+ - root.BadRequestError
459
+ examples:
460
+ - path-parameters:
461
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
462
+ version: 1
463
+ update-prompt-description:
464
+ path: /v0/evi/prompts/{id}/version/{version}
465
+ method: PATCH
466
+ auth: true
467
+ docs: >-
468
+ Updates the description of a **Prompt**.
469
+
470
+
471
+ See our [prompting
472
+ guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on
473
+ crafting your system prompt.
474
+ path-parameters:
475
+ id:
476
+ type: string
477
+ docs: Identifier for a Prompt. Formatted as a UUID.
478
+ version:
479
+ type: integer
480
+ docs: >-
481
+ Version number for a Prompt.
482
+
483
+
484
+ Prompts, Configs, Custom Voices, and Tools are versioned. This
485
+ versioning system supports iterative development, allowing you to
486
+ progressively refine prompts and revert to previous versions if
487
+ needed.
488
+
489
+
490
+ Version numbers are integer values representing different iterations
491
+ of the Prompt. Each update to the Prompt increments its version
492
+ number.
493
+ display-name: Update prompt description
494
+ request:
495
+ name: PostedPromptVersionDescription
496
+ body:
497
+ properties:
498
+ version_description:
499
+ type: optional<string>
500
+ docs: An optional description of the Prompt version.
501
+ content-type: application/json
502
+ response:
503
+ docs: Success
504
+ type: optional<root.ReturnPrompt>
505
+ errors:
506
+ - root.BadRequestError
507
+ examples:
508
+ - path-parameters:
509
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
510
+ version: 1
511
+ request:
512
+ version_description: This is an updated version_description.
513
+ response:
514
+ body:
515
+ id: af699d45-2985-42cc-91b9-af9e5da3bac5
516
+ version: 1
517
+ version_type: FIXED
518
+ version_description: This is an updated version_description.
519
+ name: string
520
+ created_on: 1722633247488
521
+ modified_on: 1722634770585
522
+ text: >-
523
+ <role>You are an AI weather assistant providing users with
524
+ accurate and up-to-date weather information. Respond to user
525
+ queries concisely and clearly. Use simple language and avoid
526
+ technical jargon. Provide temperature, precipitation, wind
527
+ conditions, and any weather alerts. Include helpful tips if
528
+ severe weather is expected.</role>
529
+ source:
530
+ openapi: stenographer-openapi.json