hume 0.5.17 → 0.6.1

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 (182) hide show
  1. package/.mock/definition/api.yml +12 -0
  2. package/.mock/definition/custom-models/__package__.yml +1392 -0
  3. package/.mock/definition/custom-models/datasets.yml +406 -0
  4. package/.mock/definition/custom-models/files.yml +263 -0
  5. package/.mock/definition/custom-models/jobs.yml +44 -0
  6. package/.mock/definition/custom-models/models.yml +303 -0
  7. package/.mock/definition/empathic-voice/__package__.yml +896 -0
  8. package/.mock/definition/empathic-voice/chat.yml +59 -0
  9. package/.mock/definition/empathic-voice/chatGroups.yml +80 -0
  10. package/.mock/definition/empathic-voice/chats.yml +86 -0
  11. package/.mock/definition/empathic-voice/configs.yml +413 -0
  12. package/.mock/definition/empathic-voice/prompts.yml +265 -0
  13. package/.mock/definition/empathic-voice/tools.yml +398 -0
  14. package/.mock/definition/expression-measurement/__package__.yml +1122 -0
  15. package/.mock/definition/expression-measurement/batch.yml +352 -0
  16. package/.mock/definition/expression-measurement/stream.yml +362 -0
  17. package/.mock/fern.config.json +4 -0
  18. package/Client.d.ts +1 -0
  19. package/api/resources/customModels/client/Client.d.ts +1 -0
  20. package/api/resources/customModels/resources/datasets/client/Client.d.ts +1 -0
  21. package/api/resources/customModels/resources/datasets/client/Client.js +38 -30
  22. package/api/resources/customModels/resources/files/client/Client.d.ts +1 -0
  23. package/api/resources/customModels/resources/files/client/Client.js +26 -20
  24. package/api/resources/customModels/resources/jobs/client/Client.d.ts +1 -0
  25. package/api/resources/customModels/resources/jobs/client/Client.js +6 -4
  26. package/api/resources/customModels/resources/models/client/Client.d.ts +1 -0
  27. package/api/resources/customModels/resources/models/client/Client.js +18 -12
  28. package/api/resources/empathicVoice/client/Client.d.ts +4 -0
  29. package/api/resources/empathicVoice/client/Client.js +5 -0
  30. package/api/resources/empathicVoice/resources/chat/types/SubscribeEvent.d.ts +1 -1
  31. package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +42 -0
  32. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +178 -0
  33. package/api/resources/empathicVoice/resources/chatGroups/client/index.d.ts +1 -0
  34. package/api/resources/empathicVoice/resources/chatGroups/client/index.js +17 -0
  35. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +21 -0
  36. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.js +5 -0
  37. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +17 -0
  38. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.js +5 -0
  39. package/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +2 -0
  40. package/api/resources/empathicVoice/resources/chatGroups/client/requests/index.js +2 -0
  41. package/api/resources/empathicVoice/resources/chatGroups/index.d.ts +1 -0
  42. package/api/resources/empathicVoice/resources/chatGroups/index.js +17 -0
  43. package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +1 -0
  44. package/api/resources/empathicVoice/resources/chats/client/Client.js +6 -4
  45. package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +1 -0
  46. package/api/resources/empathicVoice/resources/configs/client/Client.js +27 -18
  47. package/api/resources/empathicVoice/resources/index.d.ts +2 -0
  48. package/api/resources/empathicVoice/resources/index.js +3 -1
  49. package/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +1 -0
  50. package/api/resources/empathicVoice/resources/prompts/client/Client.js +27 -18
  51. package/api/resources/empathicVoice/resources/tools/client/Client.d.ts +1 -0
  52. package/api/resources/empathicVoice/resources/tools/client/Client.js +27 -18
  53. package/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  54. package/api/resources/empathicVoice/types/ChatMetadata.d.ts +15 -0
  55. package/api/resources/empathicVoice/types/ChatMetadata.js +5 -0
  56. package/api/resources/empathicVoice/types/ReturnChat.d.ts +2 -0
  57. package/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +2 -0
  58. package/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +19 -0
  59. package/api/resources/empathicVoice/types/ReturnChatGroup.js +5 -0
  60. package/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +24 -0
  61. package/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +5 -0
  62. package/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +19 -0
  63. package/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +5 -0
  64. package/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +2 -0
  65. package/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +15 -0
  66. package/api/resources/empathicVoice/types/ReturnPagedChatGroups.js +5 -0
  67. package/api/resources/empathicVoice/types/index.d.ts +5 -0
  68. package/api/resources/empathicVoice/types/index.js +5 -0
  69. package/api/resources/expressionMeasurement/client/Client.d.ts +1 -0
  70. package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +1 -0
  71. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +17 -12
  72. package/core/fetcher/Fetcher.d.ts +1 -0
  73. package/core/fetcher/Fetcher.js +106 -20
  74. package/core/form-data-utils/FormDataWrapper.d.ts +24 -0
  75. package/core/form-data-utils/FormDataWrapper.js +106 -0
  76. package/core/form-data-utils/index.d.ts +1 -0
  77. package/core/form-data-utils/index.js +17 -0
  78. package/core/index.d.ts +1 -0
  79. package/core/index.js +1 -0
  80. package/dist/Client.d.ts +1 -0
  81. package/dist/api/resources/customModels/client/Client.d.ts +1 -0
  82. package/dist/api/resources/customModels/resources/datasets/client/Client.d.ts +1 -0
  83. package/dist/api/resources/customModels/resources/datasets/client/Client.js +38 -30
  84. package/dist/api/resources/customModels/resources/files/client/Client.d.ts +1 -0
  85. package/dist/api/resources/customModels/resources/files/client/Client.js +26 -20
  86. package/dist/api/resources/customModels/resources/jobs/client/Client.d.ts +1 -0
  87. package/dist/api/resources/customModels/resources/jobs/client/Client.js +6 -4
  88. package/dist/api/resources/customModels/resources/models/client/Client.d.ts +1 -0
  89. package/dist/api/resources/customModels/resources/models/client/Client.js +18 -12
  90. package/dist/api/resources/empathicVoice/client/Client.d.ts +4 -0
  91. package/dist/api/resources/empathicVoice/client/Client.js +5 -0
  92. package/dist/api/resources/empathicVoice/resources/chat/types/SubscribeEvent.d.ts +1 -1
  93. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +42 -0
  94. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +178 -0
  95. package/dist/api/resources/empathicVoice/resources/chatGroups/client/index.d.ts +1 -0
  96. package/dist/api/resources/empathicVoice/resources/chatGroups/client/index.js +17 -0
  97. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +21 -0
  98. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.js +5 -0
  99. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +17 -0
  100. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.js +5 -0
  101. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/index.d.ts +2 -0
  102. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/index.js +2 -0
  103. package/dist/api/resources/empathicVoice/resources/chatGroups/index.d.ts +1 -0
  104. package/dist/api/resources/empathicVoice/resources/chatGroups/index.js +17 -0
  105. package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +1 -0
  106. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +6 -4
  107. package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +1 -0
  108. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +27 -18
  109. package/dist/api/resources/empathicVoice/resources/index.d.ts +2 -0
  110. package/dist/api/resources/empathicVoice/resources/index.js +3 -1
  111. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +1 -0
  112. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +27 -18
  113. package/dist/api/resources/empathicVoice/resources/tools/client/Client.d.ts +1 -0
  114. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +27 -18
  115. package/dist/api/resources/empathicVoice/types/AssistantMessage.d.ts +1 -1
  116. package/dist/api/resources/empathicVoice/types/ChatMetadata.d.ts +15 -0
  117. package/dist/api/resources/empathicVoice/types/ChatMetadata.js +5 -0
  118. package/dist/api/resources/empathicVoice/types/ReturnChat.d.ts +2 -0
  119. package/dist/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +2 -0
  120. package/dist/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +19 -0
  121. package/dist/api/resources/empathicVoice/types/ReturnChatGroup.js +5 -0
  122. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +24 -0
  123. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +5 -0
  124. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +19 -0
  125. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +5 -0
  126. package/dist/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +2 -0
  127. package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +15 -0
  128. package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroups.js +5 -0
  129. package/dist/api/resources/empathicVoice/types/index.d.ts +5 -0
  130. package/dist/api/resources/empathicVoice/types/index.js +5 -0
  131. package/dist/api/resources/expressionMeasurement/client/Client.d.ts +1 -0
  132. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +1 -0
  133. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +17 -12
  134. package/dist/core/fetcher/Fetcher.d.ts +1 -0
  135. package/dist/core/fetcher/Fetcher.js +106 -20
  136. package/dist/core/form-data-utils/FormDataWrapper.d.ts +24 -0
  137. package/dist/core/form-data-utils/FormDataWrapper.js +106 -0
  138. package/dist/core/form-data-utils/index.d.ts +1 -0
  139. package/dist/core/form-data-utils/index.js +17 -0
  140. package/dist/core/index.d.ts +1 -0
  141. package/dist/core/index.js +1 -0
  142. package/dist/serialization/resources/empathicVoice/resources/chat/types/SubscribeEvent.d.ts +2 -1
  143. package/dist/serialization/resources/empathicVoice/resources/chat/types/SubscribeEvent.js +2 -0
  144. package/dist/serialization/resources/empathicVoice/types/ChatMetadata.d.ts +15 -0
  145. package/dist/serialization/resources/empathicVoice/types/ChatMetadata.js +36 -0
  146. package/dist/serialization/resources/empathicVoice/types/ReturnChat.d.ts +1 -0
  147. package/dist/serialization/resources/empathicVoice/types/ReturnChat.js +1 -0
  148. package/dist/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +1 -0
  149. package/dist/serialization/resources/empathicVoice/types/ReturnChatEvent.js +1 -0
  150. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroup.d.ts +17 -0
  151. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroup.js +38 -0
  152. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +20 -0
  153. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +41 -0
  154. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +17 -0
  155. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +38 -0
  156. package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +1 -0
  157. package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +1 -0
  158. package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +15 -0
  159. package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +36 -0
  160. package/dist/serialization/resources/empathicVoice/types/index.d.ts +5 -0
  161. package/dist/serialization/resources/empathicVoice/types/index.js +5 -0
  162. package/package.json +3 -1
  163. package/serialization/resources/empathicVoice/resources/chat/types/SubscribeEvent.d.ts +2 -1
  164. package/serialization/resources/empathicVoice/resources/chat/types/SubscribeEvent.js +2 -0
  165. package/serialization/resources/empathicVoice/types/ChatMetadata.d.ts +15 -0
  166. package/serialization/resources/empathicVoice/types/ChatMetadata.js +36 -0
  167. package/serialization/resources/empathicVoice/types/ReturnChat.d.ts +1 -0
  168. package/serialization/resources/empathicVoice/types/ReturnChat.js +1 -0
  169. package/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +1 -0
  170. package/serialization/resources/empathicVoice/types/ReturnChatEvent.js +1 -0
  171. package/serialization/resources/empathicVoice/types/ReturnChatGroup.d.ts +17 -0
  172. package/serialization/resources/empathicVoice/types/ReturnChatGroup.js +38 -0
  173. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +20 -0
  174. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +41 -0
  175. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +17 -0
  176. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +38 -0
  177. package/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +1 -0
  178. package/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +1 -0
  179. package/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +15 -0
  180. package/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +36 -0
  181. package/serialization/resources/empathicVoice/types/index.d.ts +5 -0
  182. package/serialization/resources/empathicVoice/types/index.js +5 -0
@@ -0,0 +1,265 @@
1
+ imports:
2
+ root: __package__.yml
3
+ service:
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ list-prompts:
8
+ path: /v0/evi/prompts
9
+ method: GET
10
+ auth: false
11
+ display-name: List prompts
12
+ request:
13
+ name: PromptsListPromptsRequest
14
+ query-parameters:
15
+ page_number:
16
+ type: optional<integer>
17
+ docs: The page number of the results to return.
18
+ page_size:
19
+ type: optional<integer>
20
+ docs: The maximum number of results to include per page.
21
+ restrict_to_most_recent:
22
+ type: optional<boolean>
23
+ docs: Only include the most recent version of each prompt in the list.
24
+ response:
25
+ docs: Success
26
+ type: root.ReturnPagedPrompts
27
+ examples:
28
+ - response:
29
+ body:
30
+ page_number: 1
31
+ page_size: 1
32
+ prompts_page:
33
+ - id: id
34
+ version: 1
35
+ version_type: version_type
36
+ version_description: version_description
37
+ name: name
38
+ created_on: 1
39
+ modified_on: 1
40
+ text: text
41
+ create-prompt:
42
+ path: /v0/evi/prompts
43
+ method: POST
44
+ auth: false
45
+ display-name: Create prompt
46
+ request:
47
+ name: PostedPrompt
48
+ body:
49
+ properties:
50
+ name:
51
+ type: string
52
+ docs: Name applied to all versions of a particular Prompt.
53
+ version_description:
54
+ type: optional<string>
55
+ docs: Description that is appended to a specific version of a Prompt.
56
+ text:
57
+ type: string
58
+ docs: Text used for this version of the Prompt.
59
+ response:
60
+ docs: Success
61
+ type: optional<root.ReturnPrompt>
62
+ examples:
63
+ - request:
64
+ name: name
65
+ text: text
66
+ response:
67
+ body:
68
+ id: id
69
+ version: 1
70
+ version_type: version_type
71
+ version_description: version_description
72
+ name: name
73
+ created_on: 1
74
+ modified_on: 1
75
+ text: text
76
+ list-prompt-versions:
77
+ path: /v0/evi/prompts/{id}
78
+ method: GET
79
+ auth: false
80
+ path-parameters:
81
+ id:
82
+ type: string
83
+ docs: Identifier for a tool. Formatted as a UUID.
84
+ display-name: List prompt versions
85
+ request:
86
+ name: PromptsListPromptVersionsRequest
87
+ query-parameters:
88
+ page_number:
89
+ type: optional<integer>
90
+ docs: The page number of the results to return.
91
+ page_size:
92
+ type: optional<integer>
93
+ docs: The maximum number of results to include per page.
94
+ restrict_to_most_recent:
95
+ type: optional<boolean>
96
+ docs: Only include the most recent version of each prompt in the list.
97
+ response:
98
+ docs: Success
99
+ type: root.ReturnPagedPrompts
100
+ examples:
101
+ - path-parameters:
102
+ id: id
103
+ response:
104
+ body:
105
+ page_number: 1
106
+ page_size: 1
107
+ prompts_page:
108
+ - id: id
109
+ version: 1
110
+ version_type: version_type
111
+ version_description: version_description
112
+ name: name
113
+ created_on: 1
114
+ modified_on: 1
115
+ text: text
116
+ create-prompt-verison:
117
+ path: /v0/evi/prompts/{id}
118
+ method: POST
119
+ auth: false
120
+ path-parameters:
121
+ id:
122
+ type: string
123
+ docs: Identifier for a prompt. Formatted as a UUID.
124
+ display-name: Create prompt version
125
+ request:
126
+ name: PostedPromptVersion
127
+ body:
128
+ properties:
129
+ version_description:
130
+ type: optional<string>
131
+ docs: Description that is appended to a specific version of a Prompt.
132
+ text:
133
+ type: string
134
+ docs: Text used for this version of the Prompt.
135
+ response:
136
+ docs: Success
137
+ type: optional<root.ReturnPrompt>
138
+ examples:
139
+ - path-parameters:
140
+ id: id
141
+ request:
142
+ text: text
143
+ response:
144
+ body:
145
+ id: id
146
+ version: 1
147
+ version_type: version_type
148
+ version_description: version_description
149
+ name: name
150
+ created_on: 1
151
+ modified_on: 1
152
+ text: text
153
+ delete-prompt:
154
+ path: /v0/evi/prompts/{id}
155
+ method: DELETE
156
+ auth: false
157
+ path-parameters:
158
+ id:
159
+ type: string
160
+ docs: Identifier for a prompt. Formatted as a UUID.
161
+ display-name: Delete prompt
162
+ examples:
163
+ - path-parameters:
164
+ id: id
165
+ update-prompt-name:
166
+ path: /v0/evi/prompts/{id}
167
+ method: PATCH
168
+ auth: false
169
+ path-parameters:
170
+ id:
171
+ type: string
172
+ docs: Identifier for a prompt. Formatted as a UUID.
173
+ display-name: Update prompt name
174
+ request:
175
+ name: PostedPromptName
176
+ body:
177
+ properties:
178
+ name:
179
+ type: string
180
+ docs: Name applied to all versions of a particular Prompt.
181
+ response:
182
+ docs: Success
183
+ type: text
184
+ get-prompt-version:
185
+ path: /v0/evi/prompts/{id}/version/{version}
186
+ method: GET
187
+ auth: false
188
+ path-parameters:
189
+ id:
190
+ type: string
191
+ docs: Identifier for a prompt. Formatted as a UUID.
192
+ version:
193
+ type: integer
194
+ docs: Version number for a prompt. Version numbers should be integers.
195
+ display-name: Get prompt version
196
+ response:
197
+ docs: Success
198
+ type: optional<root.ReturnPrompt>
199
+ examples:
200
+ - path-parameters:
201
+ id: id
202
+ version: 1
203
+ response:
204
+ body:
205
+ id: id
206
+ version: 1
207
+ version_type: version_type
208
+ version_description: version_description
209
+ name: name
210
+ created_on: 1
211
+ modified_on: 1
212
+ text: text
213
+ delete-prompt-version:
214
+ path: /v0/evi/prompts/{id}/version/{version}
215
+ method: DELETE
216
+ auth: false
217
+ path-parameters:
218
+ id:
219
+ type: string
220
+ docs: Identifier for a prompt. Formatted as a UUID.
221
+ version:
222
+ type: integer
223
+ docs: Version number for a prompt. Version numbers should be integers.
224
+ display-name: Delete prompt version
225
+ examples:
226
+ - path-parameters:
227
+ id: id
228
+ version: 1
229
+ update-prompt-description:
230
+ path: /v0/evi/prompts/{id}/version/{version}
231
+ method: PATCH
232
+ auth: false
233
+ path-parameters:
234
+ id:
235
+ type: string
236
+ docs: Identifier for a prompt. Formatted as a UUID.
237
+ version:
238
+ type: integer
239
+ docs: Version number for a prompt. Version numbers should be integers.
240
+ display-name: Update prompt description
241
+ request:
242
+ name: PostedPromptVersionDescription
243
+ body:
244
+ properties:
245
+ version_description:
246
+ type: optional<string>
247
+ docs: Description that is appended to a specific version of a Prompt.
248
+ response:
249
+ docs: Success
250
+ type: optional<root.ReturnPrompt>
251
+ examples:
252
+ - path-parameters:
253
+ id: id
254
+ version: 1
255
+ request: {}
256
+ response:
257
+ body:
258
+ id: id
259
+ version: 1
260
+ version_type: version_type
261
+ version_description: version_description
262
+ name: name
263
+ created_on: 1
264
+ modified_on: 1
265
+ text: text
@@ -0,0 +1,398 @@
1
+ imports:
2
+ root: __package__.yml
3
+ service:
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ list-tools:
8
+ path: /v0/evi/tools
9
+ method: GET
10
+ auth: false
11
+ display-name: List tools
12
+ request:
13
+ name: ToolsListToolsRequest
14
+ query-parameters:
15
+ page_number:
16
+ type: optional<integer>
17
+ docs: The page number of the results to return.
18
+ page_size:
19
+ type: optional<integer>
20
+ docs: The maximum number of results to include per page.
21
+ restrict_to_most_recent:
22
+ type: optional<boolean>
23
+ docs: Only include the most recent version of each tool in the list.
24
+ response:
25
+ docs: Success
26
+ type: root.ReturnPagedUserDefinedTools
27
+ examples:
28
+ - query-parameters:
29
+ page_number: 0
30
+ page_size: 2
31
+ response:
32
+ body:
33
+ page_number: 0
34
+ page_size: 2
35
+ tools_page:
36
+ - tool_type: FUNCTION
37
+ id: d20827af-5d8d-4f66-b6b9-ce2e3e1ea2b2
38
+ version: 0
39
+ version_type: FIXED
40
+ version_description: Fetches user's current location.
41
+ name: get_current_location
42
+ created_on: 1715267200693
43
+ modified_on: 1715267200693
44
+ fallback_content: Unable to fetch location.
45
+ description: Fetches user's current location.
46
+ parameters: >-
47
+ { "type": "object", "properties": { "location": { "type":
48
+ "string", "description": "The city and state, e.g. San
49
+ Francisco, CA" }}, "required": ["location"] }
50
+ - tool_type: FUNCTION
51
+ id: 4442f3ea-9038-40e3-a2ce-1522b7de770f
52
+ version: 0
53
+ version_type: FIXED
54
+ version_description: >-
55
+ Fetches current weather and uses celsius or fahrenheit based
56
+ on location of user.
57
+ name: get_current_weather
58
+ created_on: 1715266126705
59
+ modified_on: 1715266126705
60
+ fallback_content: Unable to fetch location.
61
+ description: >-
62
+ Fetches current weather and uses celsius or fahrenheit based
63
+ on location of user.
64
+ parameters: >-
65
+ { "type": "object", "properties": { "location": { "type":
66
+ "string", "description": "The city and state, e.g. San
67
+ Francisco, CA" }, "format": { "type": "string", "enum":
68
+ ["celsius", "fahrenheit"], "description": "The temperature
69
+ unit to use. Infer this from the users location." } },
70
+ "required": ["location", "format"] }
71
+ create-tool:
72
+ path: /v0/evi/tools
73
+ method: POST
74
+ auth: false
75
+ display-name: Create tool
76
+ request:
77
+ name: PostedUserDefinedTool
78
+ body:
79
+ properties:
80
+ name:
81
+ type: string
82
+ docs: Name applied to all versions of a particular Tool.
83
+ version_description:
84
+ type: optional<string>
85
+ docs: Description that is appended to a specific version of a Tool.
86
+ description:
87
+ type: optional<string>
88
+ docs: Text describing what the tool does.
89
+ parameters:
90
+ type: string
91
+ docs: >-
92
+ Stringified JSON defining the parameters used by this version of
93
+ the Tool.
94
+ fallback_content:
95
+ type: optional<string>
96
+ docs: Text to use if the tool fails to generate content.
97
+ response:
98
+ docs: Success
99
+ type: optional<root.ReturnUserDefinedTool>
100
+ examples:
101
+ - request:
102
+ name: get_current_weather
103
+ parameters: >-
104
+ { "type": "object", "properties": { "location": { "type":
105
+ "string", "description": "The city and state, e.g. San Francisco,
106
+ CA" }, "format": { "type": "string", "enum": ["celsius",
107
+ "fahrenheit"], "description": "The temperature unit to use. Infer
108
+ this from the users location." } }, "required": ["location",
109
+ "format"] }
110
+ version_description: >-
111
+ Fetches current weather and uses celsius or fahrenheit based on
112
+ location of user.
113
+ description: This tool is for getting the current weather.
114
+ fallback_content: Unable to fetch current weather.
115
+ response:
116
+ body:
117
+ tool_type: FUNCTION
118
+ id: aa9b71c4-723c-47ff-9f83-1a1829e74376
119
+ version: 0
120
+ version_type: FIXED
121
+ version_description: >-
122
+ Fetches current weather and uses celsius or fahrenheit based on
123
+ location of user.
124
+ name: get_current_weather
125
+ created_on: 1715275452390
126
+ modified_on: 1715275452390
127
+ fallback_content: Unable to fetch current weather.
128
+ description: This tool is for getting the current weather.
129
+ parameters: >-
130
+ { "type": "object", "properties": { "location": { "type":
131
+ "string", "description": "The city and state, e.g. San
132
+ Francisco, CA" }, "format": { "type": "string", "enum":
133
+ ["celsius", "fahrenheit"], "description": "The temperature unit
134
+ to use. Infer this from the users location." } }, "required":
135
+ ["location", "format"] }
136
+ list-tool-versions:
137
+ path: /v0/evi/tools/{id}
138
+ method: GET
139
+ auth: false
140
+ path-parameters:
141
+ id:
142
+ type: string
143
+ docs: Identifier for a tool. Formatted as a UUID.
144
+ display-name: List tool versions
145
+ request:
146
+ name: ToolsListToolVersionsRequest
147
+ query-parameters:
148
+ page_number:
149
+ type: optional<integer>
150
+ docs: The page number of the results to return.
151
+ page_size:
152
+ type: optional<integer>
153
+ docs: The maximum number of results to include per page.
154
+ restrict_to_most_recent:
155
+ type: optional<boolean>
156
+ docs: Only include the most recent version of each tool in the list.
157
+ response:
158
+ docs: Success
159
+ type: root.ReturnPagedUserDefinedTools
160
+ examples:
161
+ - path-parameters:
162
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
163
+ response:
164
+ body:
165
+ page_number: 0
166
+ page_size: 10
167
+ tools_page:
168
+ - tool_type: FUNCTION
169
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
170
+ version: 1
171
+ version_type: FIXED
172
+ version_description: >-
173
+ Fetches current weather and uses celsius, fahrenheit, or
174
+ kelvin based on location of user.
175
+ name: get_current_weather
176
+ created_on: 1715277014228
177
+ modified_on: 1715277602313
178
+ fallback_content: Unable to fetch current weather.
179
+ description: This tool is for getting the current weather.
180
+ parameters: >-
181
+ { "type": "object", "properties": { "location": { "type":
182
+ "string", "description": "The city and state, e.g. San
183
+ Francisco, CA" }, "format": { "type": "string", "enum":
184
+ ["celsius", "fahrenheit", "kelvin"], "description": "The
185
+ temperature unit to use. Infer this from the users
186
+ location." } }, "required": ["location", "format"] }
187
+ create-tool-version:
188
+ path: /v0/evi/tools/{id}
189
+ method: POST
190
+ auth: false
191
+ path-parameters:
192
+ id:
193
+ type: string
194
+ docs: Identifier for a tool. Formatted as a UUID.
195
+ display-name: Create tool version
196
+ request:
197
+ name: PostedUserDefinedToolVersion
198
+ body:
199
+ properties:
200
+ version_description:
201
+ type: optional<string>
202
+ docs: Description that is appended to a specific version of a Tool.
203
+ description:
204
+ type: optional<string>
205
+ docs: Text describing what the tool does.
206
+ parameters:
207
+ type: string
208
+ docs: >-
209
+ Stringified JSON defining the parameters used by this version of
210
+ the Tool.
211
+ fallback_content:
212
+ type: optional<string>
213
+ docs: Text to use if the tool fails to generate content.
214
+ response:
215
+ docs: Success
216
+ type: optional<root.ReturnUserDefinedTool>
217
+ examples:
218
+ - path-parameters:
219
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
220
+ request:
221
+ parameters: >-
222
+ { "type": "object", "properties": { "location": { "type":
223
+ "string", "description": "The city and state, e.g. San Francisco,
224
+ CA" }, "format": { "type": "string", "enum": ["celsius",
225
+ "fahrenheit", "kelvin"], "description": "The temperature unit to
226
+ use. Infer this from the users location." } }, "required":
227
+ ["location", "format"] }
228
+ version_description: >-
229
+ Fetches current weather and uses celsius, fahrenheit, or kelvin
230
+ based on location of user.
231
+ fallback_content: Unable to fetch current weather.
232
+ description: This tool is for getting the current weather.
233
+ response:
234
+ body:
235
+ tool_type: FUNCTION
236
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
237
+ version: 1
238
+ version_type: FIXED
239
+ version_description: >-
240
+ Fetches current weather and uses celsius, fahrenheit, or kelvin
241
+ based on location of user.
242
+ name: get_current_weather
243
+ created_on: 1715277014228
244
+ modified_on: 1715277602313
245
+ fallback_content: Unable to fetch current weather.
246
+ description: This tool is for getting the current weather.
247
+ parameters: >-
248
+ { "type": "object", "properties": { "location": { "type":
249
+ "string", "description": "The city and state, e.g. San
250
+ Francisco, CA" }, "format": { "type": "string", "enum":
251
+ ["celsius", "fahrenheit", "kelvin"], "description": "The
252
+ temperature unit to use. Infer this from the users location." }
253
+ }, "required": ["location", "format"] }
254
+ delete-tool:
255
+ path: /v0/evi/tools/{id}
256
+ method: DELETE
257
+ auth: false
258
+ path-parameters:
259
+ id:
260
+ type: string
261
+ docs: Identifier for a tool. Formatted as a UUID.
262
+ display-name: Delete tool
263
+ examples:
264
+ - path-parameters:
265
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
266
+ update-tool-name:
267
+ path: /v0/evi/tools/{id}
268
+ method: PATCH
269
+ auth: false
270
+ path-parameters:
271
+ id:
272
+ type: string
273
+ docs: Identifier for a tool. Formatted as a UUID.
274
+ display-name: Update tool name
275
+ request:
276
+ name: PostedUserDefinedToolName
277
+ body:
278
+ properties:
279
+ name:
280
+ type: string
281
+ docs: Name applied to all versions of a particular Tool.
282
+ response:
283
+ docs: Success
284
+ type: text
285
+ examples:
286
+ - path-parameters:
287
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
288
+ request:
289
+ name: get_current_temperature
290
+ get-tool-version:
291
+ path: /v0/evi/tools/{id}/version/{version}
292
+ method: GET
293
+ auth: false
294
+ path-parameters:
295
+ id:
296
+ type: string
297
+ docs: Identifier for a tool. Formatted as a UUID.
298
+ version:
299
+ type: integer
300
+ docs: Version number for a tool. Version numbers should be integers.
301
+ display-name: Get tool version
302
+ response:
303
+ docs: Success
304
+ type: optional<root.ReturnUserDefinedTool>
305
+ examples:
306
+ - path-parameters:
307
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
308
+ version: 1
309
+ response:
310
+ body:
311
+ tool_type: FUNCTION
312
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
313
+ version: 1
314
+ version_type: FIXED
315
+ version_description: >-
316
+ Fetches current weather and uses celsius, fahrenheit, or kelvin
317
+ based on location of user.
318
+ name: string
319
+ created_on: 1715277014228
320
+ modified_on: 1715277602313
321
+ fallback_content: Unable to fetch current weather.
322
+ description: This tool is for getting the current weather.
323
+ parameters: >-
324
+ { "type": "object", "properties": { "location": { "type":
325
+ "string", "description": "The city and state, e.g. San
326
+ Francisco, CA" }, "format": { "type": "string", "enum":
327
+ ["celsius", "fahrenheit", "kelvin"], "description": "The
328
+ temperature unit to use. Infer this from the users location." }
329
+ }, "required": ["location", "format"] }
330
+ delete-tool-version:
331
+ path: /v0/evi/tools/{id}/version/{version}
332
+ method: DELETE
333
+ auth: false
334
+ path-parameters:
335
+ id:
336
+ type: string
337
+ docs: Identifier for a tool. Formatted as a UUID.
338
+ version:
339
+ type: integer
340
+ docs: Version number for a tool. Version numbers should be integers.
341
+ display-name: Delete tool version
342
+ examples:
343
+ - path-parameters:
344
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
345
+ version: 1
346
+ update-tool-description:
347
+ path: /v0/evi/tools/{id}/version/{version}
348
+ method: PATCH
349
+ auth: false
350
+ path-parameters:
351
+ id:
352
+ type: string
353
+ docs: Identifier for a tool. Formatted as a UUID.
354
+ version:
355
+ type: integer
356
+ docs: Version number for a tool. Version numbers should be integers.
357
+ display-name: Update tool description
358
+ request:
359
+ name: PostedUserDefinedToolVersionDescription
360
+ body:
361
+ properties:
362
+ version_description:
363
+ type: optional<string>
364
+ docs: Description that is appended to a specific version of a Tool.
365
+ response:
366
+ docs: Success
367
+ type: optional<root.ReturnUserDefinedTool>
368
+ examples:
369
+ - path-parameters:
370
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
371
+ version: 1
372
+ request:
373
+ version_description: >-
374
+ Fetches current temperature, precipitation, wind speed, AQI, and
375
+ other weather conditions. Uses Celsius, Fahrenheit, or kelvin
376
+ depending on user's region.
377
+ response:
378
+ body:
379
+ tool_type: FUNCTION
380
+ id: 00183a3f-79ba-413d-9f3b-609864268bea
381
+ version: 1
382
+ version_type: FIXED
383
+ version_description: >-
384
+ Fetches current temperature, precipitation, wind speed, AQI, and
385
+ other weather conditions. Uses Celsius, Fahrenheit, or kelvin
386
+ depending on user's region.
387
+ name: string
388
+ created_on: 1715277014228
389
+ modified_on: 1715277602313
390
+ fallback_content: Unable to fetch current weather.
391
+ description: This tool is for getting the current weather.
392
+ parameters: >-
393
+ { "type": "object", "properties": { "location": { "type":
394
+ "string", "description": "The city and state, e.g. San
395
+ Francisco, CA" }, "format": { "type": "string", "enum":
396
+ ["celsius", "fahrenheit", "kelvin"], "description": "The
397
+ temperature unit to use. Infer this from the users location." }
398
+ }, "required": ["location", "format"] }