hume 0.9.6 → 0.9.7

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 (72) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +66 -42
  2. package/.mock/definition/empathic-voice/chatGroups.yml +10 -0
  3. package/.mock/definition/empathic-voice/chats.yml +6 -0
  4. package/.mock/definition/empathic-voice/configs.yml +18 -6
  5. package/.mock/definition/empathic-voice/customVoices.yml +12 -3
  6. package/.mock/definition/empathic-voice/prompts.yml +18 -0
  7. package/.mock/definition/empathic-voice/tools.yml +18 -0
  8. package/.mock/definition/expression-measurement/batch/__package__.yml +12 -0
  9. package/.mock/definition/expression-measurement/stream/__package__.yml +19 -0
  10. package/.mock/fern.config.json +1 -1
  11. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
  12. package/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
  13. package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  14. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  15. package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  16. package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  17. package/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +10 -16
  18. package/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +10 -16
  19. package/api/resources/empathicVoice/types/SessionSettings.d.ts +8 -2
  20. package/api/resources/empathicVoice/types/SessionSettingsVariablesValue.d.ts +4 -0
  21. package/api/resources/empathicVoice/types/SessionSettingsVariablesValue.js +5 -0
  22. package/api/resources/empathicVoice/types/index.d.ts +1 -0
  23. package/api/resources/empathicVoice/types/index.js +1 -0
  24. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  25. package/api/resources/index.d.ts +1 -1
  26. package/api/resources/index.js +2 -2
  27. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
  28. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
  29. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  30. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  31. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  32. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  33. package/dist/api/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +10 -16
  34. package/dist/api/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +10 -16
  35. package/dist/api/resources/empathicVoice/types/SessionSettings.d.ts +8 -2
  36. package/dist/api/resources/empathicVoice/types/SessionSettingsVariablesValue.d.ts +4 -0
  37. package/dist/api/resources/empathicVoice/types/SessionSettingsVariablesValue.js +5 -0
  38. package/dist/api/resources/empathicVoice/types/index.d.ts +1 -0
  39. package/dist/api/resources/empathicVoice/types/index.js +1 -0
  40. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  41. package/dist/api/resources/index.d.ts +1 -1
  42. package/dist/api/resources/index.js +2 -2
  43. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +0 -1
  44. package/dist/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +0 -1
  45. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +0 -1
  46. package/dist/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +0 -1
  47. package/dist/serialization/resources/empathicVoice/types/SessionSettings.d.ts +2 -1
  48. package/dist/serialization/resources/empathicVoice/types/SessionSettings.js +2 -1
  49. package/dist/serialization/resources/empathicVoice/types/SessionSettingsVariablesValue.d.ts +10 -0
  50. package/dist/serialization/resources/empathicVoice/types/SessionSettingsVariablesValue.js +35 -0
  51. package/dist/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  52. package/dist/serialization/resources/empathicVoice/types/index.js +1 -0
  53. package/dist/serialization/resources/index.d.ts +1 -1
  54. package/dist/serialization/resources/index.js +2 -2
  55. package/dist/version.d.ts +1 -1
  56. package/dist/version.js +1 -1
  57. package/package.json +1 -1
  58. package/reference.md +536 -536
  59. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.d.ts +0 -1
  60. package/serialization/resources/empathicVoice/types/PostedCustomVoiceParameters.js +0 -1
  61. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.d.ts +0 -1
  62. package/serialization/resources/empathicVoice/types/ReturnCustomVoiceParameters.js +0 -1
  63. package/serialization/resources/empathicVoice/types/SessionSettings.d.ts +2 -1
  64. package/serialization/resources/empathicVoice/types/SessionSettings.js +2 -1
  65. package/serialization/resources/empathicVoice/types/SessionSettingsVariablesValue.d.ts +10 -0
  66. package/serialization/resources/empathicVoice/types/SessionSettingsVariablesValue.js +35 -0
  67. package/serialization/resources/empathicVoice/types/index.d.ts +1 -0
  68. package/serialization/resources/empathicVoice/types/index.js +1 -0
  69. package/serialization/resources/index.d.ts +1 -1
  70. package/serialization/resources/index.js +2 -2
  71. package/version.d.ts +1 -1
  72. package/version.js +1 -1
package/reference.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Reference
2
2
 
3
- ## ExpressionMeasurement Batch
3
+ ## EmpathicVoice Tools
4
4
 
5
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
5
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -14,7 +14,9 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Sort and filter jobs.
17
+ Fetches a paginated list of **Tools**.
18
+
19
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
18
20
 
19
21
  </dd>
20
22
  </dl>
@@ -30,7 +32,10 @@ Sort and filter jobs.
30
32
  <dd>
31
33
 
32
34
  ```typescript
33
- await client.expressionMeasurement.batch.listJobs();
35
+ await client.empathicVoice.tools.listTools({
36
+ pageNumber: 0,
37
+ pageSize: 2,
38
+ });
34
39
  ```
35
40
 
36
41
  </dd>
@@ -46,7 +51,7 @@ await client.expressionMeasurement.batch.listJobs();
46
51
  <dl>
47
52
  <dd>
48
53
 
49
- **request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
54
+ **request:** `Hume.empathicVoice.ToolsListToolsRequest`
50
55
 
51
56
  </dd>
52
57
  </dl>
@@ -54,7 +59,7 @@ await client.expressionMeasurement.batch.listJobs();
54
59
  <dl>
55
60
  <dd>
56
61
 
57
- **requestOptions:** `Batch.RequestOptions`
62
+ **requestOptions:** `Tools.RequestOptions`
58
63
 
59
64
  </dd>
60
65
  </dl>
@@ -65,7 +70,7 @@ await client.expressionMeasurement.batch.listJobs();
65
70
  </dl>
66
71
  </details>
67
72
 
68
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
73
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
69
74
  <dl>
70
75
  <dd>
71
76
 
@@ -77,7 +82,9 @@ await client.expressionMeasurement.batch.listJobs();
77
82
  <dl>
78
83
  <dd>
79
84
 
80
- Start a new measurement inference job.
85
+ Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
86
+
87
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
81
88
 
82
89
  </dd>
83
90
  </dl>
@@ -93,9 +100,13 @@ Start a new measurement inference job.
93
100
  <dd>
94
101
 
95
102
  ```typescript
96
- await client.expressionMeasurement.batch.startInferenceJob({
97
- urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
98
- notify: true,
103
+ await client.empathicVoice.tools.createTool({
104
+ name: "get_current_weather",
105
+ parameters:
106
+ '{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
107
+ versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
108
+ description: "This tool is for getting the current weather.",
109
+ fallbackContent: "Unable to fetch current weather.",
99
110
  });
100
111
  ```
101
112
 
@@ -112,7 +123,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
112
123
  <dl>
113
124
  <dd>
114
125
 
115
- **request:** `Hume.InferenceBaseRequest`
126
+ **request:** `Hume.empathicVoice.PostedUserDefinedTool`
116
127
 
117
128
  </dd>
118
129
  </dl>
@@ -120,7 +131,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
120
131
  <dl>
121
132
  <dd>
122
133
 
123
- **requestOptions:** `Batch.RequestOptions`
134
+ **requestOptions:** `Tools.RequestOptions`
124
135
 
125
136
  </dd>
126
137
  </dl>
@@ -131,7 +142,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
131
142
  </dl>
132
143
  </details>
133
144
 
134
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
145
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools</code></summary>
135
146
  <dl>
136
147
  <dd>
137
148
 
@@ -143,7 +154,9 @@ await client.expressionMeasurement.batch.startInferenceJob({
143
154
  <dl>
144
155
  <dd>
145
156
 
146
- Get the request details and state of a given job.
157
+ Fetches a list of a **Tool's** versions.
158
+
159
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
147
160
 
148
161
  </dd>
149
162
  </dl>
@@ -159,7 +172,7 @@ Get the request details and state of a given job.
159
172
  <dd>
160
173
 
161
174
  ```typescript
162
- await client.expressionMeasurement.batch.getJobDetails("job_id");
175
+ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
163
176
  ```
164
177
 
165
178
  </dd>
@@ -175,7 +188,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
175
188
  <dl>
176
189
  <dd>
177
190
 
178
- **id:** `string` — The unique identifier for the job.
191
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
179
192
 
180
193
  </dd>
181
194
  </dl>
@@ -183,7 +196,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
183
196
  <dl>
184
197
  <dd>
185
198
 
186
- **requestOptions:** `Batch.RequestOptions`
199
+ **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
200
+
201
+ </dd>
202
+ </dl>
203
+
204
+ <dl>
205
+ <dd>
206
+
207
+ **requestOptions:** `Tools.RequestOptions`
187
208
 
188
209
  </dd>
189
210
  </dl>
@@ -194,7 +215,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
194
215
  </dl>
195
216
  </details>
196
217
 
197
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
218
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
198
219
  <dl>
199
220
  <dd>
200
221
 
@@ -206,7 +227,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
206
227
  <dl>
207
228
  <dd>
208
229
 
209
- Get the JSON predictions of a completed inference job.
230
+ Updates a **Tool** by creating a new version of the **Tool**.
231
+
232
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
210
233
 
211
234
  </dd>
212
235
  </dl>
@@ -222,7 +245,13 @@ Get the JSON predictions of a completed inference job.
222
245
  <dd>
223
246
 
224
247
  ```typescript
225
- await client.expressionMeasurement.batch.getJobPredictions("job_id");
248
+ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
249
+ parameters:
250
+ '{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit", "kelvin"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
251
+ versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
252
+ fallbackContent: "Unable to fetch current weather.",
253
+ description: "This tool is for getting the current weather.",
254
+ });
226
255
  ```
227
256
 
228
257
  </dd>
@@ -238,7 +267,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
238
267
  <dl>
239
268
  <dd>
240
269
 
241
- **id:** `string` — The unique identifier for the job.
270
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
242
271
 
243
272
  </dd>
244
273
  </dl>
@@ -246,7 +275,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
246
275
  <dl>
247
276
  <dd>
248
277
 
249
- **requestOptions:** `Batch.RequestOptions`
278
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
279
+
280
+ </dd>
281
+ </dl>
282
+
283
+ <dl>
284
+ <dd>
285
+
286
+ **requestOptions:** `Tools.RequestOptions`
250
287
 
251
288
  </dd>
252
289
  </dl>
@@ -257,7 +294,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
257
294
  </dl>
258
295
  </details>
259
296
 
260
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
297
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
261
298
  <dl>
262
299
  <dd>
263
300
 
@@ -269,7 +306,9 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
269
306
  <dl>
270
307
  <dd>
271
308
 
272
- Start a new batch inference job.
309
+ Deletes a **Tool** and its versions.
310
+
311
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
273
312
 
274
313
  </dd>
275
314
  </dl>
@@ -285,10 +324,7 @@ Start a new batch inference job.
285
324
  <dd>
286
325
 
287
326
  ```typescript
288
- await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
289
- [fs.createReadStream("/path/to/your/file")],
290
- {}
291
- );
327
+ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
292
328
  ```
293
329
 
294
330
  </dd>
@@ -304,15 +340,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
304
340
  <dl>
305
341
  <dd>
306
342
 
307
- **file:** `File[] | fs.ReadStream[] | Blob[]`
308
-
309
- </dd>
310
- </dl>
311
-
312
- <dl>
313
- <dd>
314
-
315
- **request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
343
+ **id:** `string` Identifier for a Tool. Formatted as a UUID.
316
344
 
317
345
  </dd>
318
346
  </dl>
@@ -320,7 +348,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
320
348
  <dl>
321
349
  <dd>
322
350
 
323
- **requestOptions:** `Batch.RequestOptions`
351
+ **requestOptions:** `Tools.RequestOptions`
324
352
 
325
353
  </dd>
326
354
  </dl>
@@ -331,9 +359,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
331
359
  </dl>
332
360
  </details>
333
361
 
334
- ## EmpathicVoice Tools
335
-
336
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
362
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
337
363
  <dl>
338
364
  <dd>
339
365
 
@@ -345,7 +371,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
345
371
  <dl>
346
372
  <dd>
347
373
 
348
- Fetches a paginated list of **Tools**.
374
+ Updates the name of a **Tool**.
349
375
 
350
376
  Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
351
377
 
@@ -363,9 +389,8 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
363
389
  <dd>
364
390
 
365
391
  ```typescript
366
- await client.empathicVoice.tools.listTools({
367
- pageNumber: 0,
368
- pageSize: 2,
392
+ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
393
+ name: "get_current_temperature",
369
394
  });
370
395
  ```
371
396
 
@@ -382,7 +407,15 @@ await client.empathicVoice.tools.listTools({
382
407
  <dl>
383
408
  <dd>
384
409
 
385
- **request:** `Hume.empathicVoice.ToolsListToolsRequest`
410
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
411
+
412
+ </dd>
413
+ </dl>
414
+
415
+ <dl>
416
+ <dd>
417
+
418
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
386
419
 
387
420
  </dd>
388
421
  </dl>
@@ -401,7 +434,7 @@ await client.empathicVoice.tools.listTools({
401
434
  </dl>
402
435
  </details>
403
436
 
404
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
437
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
405
438
  <dl>
406
439
  <dd>
407
440
 
@@ -413,7 +446,7 @@ await client.empathicVoice.tools.listTools({
413
446
  <dl>
414
447
  <dd>
415
448
 
416
- Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
449
+ Fetches a specified version of a **Tool**.
417
450
 
418
451
  Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
419
452
 
@@ -431,14 +464,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
431
464
  <dd>
432
465
 
433
466
  ```typescript
434
- await client.empathicVoice.tools.createTool({
435
- name: "get_current_weather",
436
- parameters:
437
- '{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
438
- versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
439
- description: "This tool is for getting the current weather.",
440
- fallbackContent: "Unable to fetch current weather.",
441
- });
467
+ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
442
468
  ```
443
469
 
444
470
  </dd>
@@ -454,7 +480,21 @@ await client.empathicVoice.tools.createTool({
454
480
  <dl>
455
481
  <dd>
456
482
 
457
- **request:** `Hume.empathicVoice.PostedUserDefinedTool`
483
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
484
+
485
+ </dd>
486
+ </dl>
487
+
488
+ <dl>
489
+ <dd>
490
+
491
+ **version:** `number`
492
+
493
+ Version number for a Tool.
494
+
495
+ Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
496
+
497
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
458
498
 
459
499
  </dd>
460
500
  </dl>
@@ -473,7 +513,7 @@ await client.empathicVoice.tools.createTool({
473
513
  </dl>
474
514
  </details>
475
515
 
476
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools</code></summary>
516
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
477
517
  <dl>
478
518
  <dd>
479
519
 
@@ -485,7 +525,7 @@ await client.empathicVoice.tools.createTool({
485
525
  <dl>
486
526
  <dd>
487
527
 
488
- Fetches a list of a **Tool's** versions.
528
+ Deletes a specified version of a **Tool**.
489
529
 
490
530
  Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
491
531
 
@@ -503,7 +543,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
503
543
  <dd>
504
544
 
505
545
  ```typescript
506
- await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
546
+ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
507
547
  ```
508
548
 
509
549
  </dd>
@@ -527,7 +567,13 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
527
567
  <dl>
528
568
  <dd>
529
569
 
530
- **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
570
+ **version:** `number`
571
+
572
+ Version number for a Tool.
573
+
574
+ Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
575
+
576
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
531
577
 
532
578
  </dd>
533
579
  </dl>
@@ -546,7 +592,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
546
592
  </dl>
547
593
  </details>
548
594
 
549
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
595
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
550
596
  <dl>
551
597
  <dd>
552
598
 
@@ -558,7 +604,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
558
604
  <dl>
559
605
  <dd>
560
606
 
561
- Updates a **Tool** by creating a new version of the **Tool**.
607
+ Updates the description of a specified **Tool** version.
562
608
 
563
609
  Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
564
610
 
@@ -576,12 +622,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
576
622
  <dd>
577
623
 
578
624
  ```typescript
579
- await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
580
- parameters:
581
- '{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit", "kelvin"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
582
- versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
583
- fallbackContent: "Unable to fetch current weather.",
584
- description: "This tool is for getting the current weather.",
625
+ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
626
+ versionDescription:
627
+ "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
585
628
  });
586
629
  ```
587
630
 
@@ -606,7 +649,21 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
606
649
  <dl>
607
650
  <dd>
608
651
 
609
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
652
+ **version:** `number`
653
+
654
+ Version number for a Tool.
655
+
656
+ Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
657
+
658
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
659
+
660
+ </dd>
661
+ </dl>
662
+
663
+ <dl>
664
+ <dd>
665
+
666
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
610
667
 
611
668
  </dd>
612
669
  </dl>
@@ -625,7 +682,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
625
682
  </dl>
626
683
  </details>
627
684
 
628
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
685
+ ## EmpathicVoice Prompts
686
+
687
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
629
688
  <dl>
630
689
  <dd>
631
690
 
@@ -637,9 +696,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
637
696
  <dl>
638
697
  <dd>
639
698
 
640
- Deletes a **Tool** and its versions.
699
+ Fetches a paginated list of **Prompts**.
641
700
 
642
- Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
701
+ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
643
702
 
644
703
  </dd>
645
704
  </dl>
@@ -655,7 +714,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
655
714
  <dd>
656
715
 
657
716
  ```typescript
658
- await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
717
+ await client.empathicVoice.prompts.listPrompts({
718
+ pageNumber: 0,
719
+ pageSize: 2,
720
+ });
659
721
  ```
660
722
 
661
723
  </dd>
@@ -671,7 +733,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
671
733
  <dl>
672
734
  <dd>
673
735
 
674
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
736
+ **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
675
737
 
676
738
  </dd>
677
739
  </dl>
@@ -679,7 +741,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
679
741
  <dl>
680
742
  <dd>
681
743
 
682
- **requestOptions:** `Tools.RequestOptions`
744
+ **requestOptions:** `Prompts.RequestOptions`
683
745
 
684
746
  </dd>
685
747
  </dl>
@@ -690,7 +752,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
690
752
  </dl>
691
753
  </details>
692
754
 
693
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
755
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
694
756
  <dl>
695
757
  <dd>
696
758
 
@@ -702,9 +764,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
702
764
  <dl>
703
765
  <dd>
704
766
 
705
- Updates the name of a **Tool**.
767
+ Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
706
768
 
707
- Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
769
+ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
708
770
 
709
771
  </dd>
710
772
  </dl>
@@ -720,8 +782,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
720
782
  <dd>
721
783
 
722
784
  ```typescript
723
- await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
724
- name: "get_current_temperature",
785
+ await client.empathicVoice.prompts.createPrompt({
786
+ name: "Weather Assistant Prompt",
787
+ text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
725
788
  });
726
789
  ```
727
790
 
@@ -738,15 +801,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
738
801
  <dl>
739
802
  <dd>
740
803
 
741
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
742
-
743
- </dd>
744
- </dl>
745
-
746
- <dl>
747
- <dd>
748
-
749
- **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
804
+ **request:** `Hume.empathicVoice.PostedPrompt`
750
805
 
751
806
  </dd>
752
807
  </dl>
@@ -754,7 +809,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
754
809
  <dl>
755
810
  <dd>
756
811
 
757
- **requestOptions:** `Tools.RequestOptions`
812
+ **requestOptions:** `Prompts.RequestOptions`
758
813
 
759
814
  </dd>
760
815
  </dl>
@@ -765,7 +820,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
765
820
  </dl>
766
821
  </details>
767
822
 
768
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
823
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
769
824
  <dl>
770
825
  <dd>
771
826
 
@@ -777,9 +832,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
777
832
  <dl>
778
833
  <dd>
779
834
 
780
- Fetches a specified version of a **Tool**.
835
+ Fetches a list of a **Prompt's** versions.
781
836
 
782
- Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
837
+ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
783
838
 
784
839
  </dd>
785
840
  </dl>
@@ -795,7 +850,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
795
850
  <dd>
796
851
 
797
852
  ```typescript
798
- await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
853
+ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
799
854
  ```
800
855
 
801
856
  </dd>
@@ -811,7 +866,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
811
866
  <dl>
812
867
  <dd>
813
868
 
814
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
869
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
815
870
 
816
871
  </dd>
817
872
  </dl>
@@ -819,21 +874,15 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
819
874
  <dl>
820
875
  <dd>
821
876
 
822
- **version:** `number`
823
-
824
- Version number for a Tool.
877
+ **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
825
878
 
826
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
827
-
828
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
829
-
830
- </dd>
831
- </dl>
879
+ </dd>
880
+ </dl>
832
881
 
833
882
  <dl>
834
883
  <dd>
835
884
 
836
- **requestOptions:** `Tools.RequestOptions`
885
+ **requestOptions:** `Prompts.RequestOptions`
837
886
 
838
887
  </dd>
839
888
  </dl>
@@ -844,7 +893,7 @@ Version numbers are integer values representing different iterations of the Tool
844
893
  </dl>
845
894
  </details>
846
895
 
847
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
896
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVerison</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
848
897
  <dl>
849
898
  <dd>
850
899
 
@@ -856,9 +905,9 @@ Version numbers are integer values representing different iterations of the Tool
856
905
  <dl>
857
906
  <dd>
858
907
 
859
- Deletes a specified version of a **Tool**.
908
+ Updates a **Prompt** by creating a new version of the **Prompt**.
860
909
 
861
- Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
910
+ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
862
911
 
863
912
  </dd>
864
913
  </dl>
@@ -874,7 +923,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
874
923
  <dd>
875
924
 
876
925
  ```typescript
877
- await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
926
+ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
927
+ text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
928
+ versionDescription: "This is an updated version of the Weather Assistant Prompt.",
929
+ });
878
930
  ```
879
931
 
880
932
  </dd>
@@ -890,7 +942,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
890
942
  <dl>
891
943
  <dd>
892
944
 
893
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
945
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
894
946
 
895
947
  </dd>
896
948
  </dl>
@@ -898,13 +950,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
898
950
  <dl>
899
951
  <dd>
900
952
 
901
- **version:** `number`
902
-
903
- Version number for a Tool.
904
-
905
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
906
-
907
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
953
+ **request:** `Hume.empathicVoice.PostedPromptVersion`
908
954
 
909
955
  </dd>
910
956
  </dl>
@@ -912,7 +958,7 @@ Version numbers are integer values representing different iterations of the Tool
912
958
  <dl>
913
959
  <dd>
914
960
 
915
- **requestOptions:** `Tools.RequestOptions`
961
+ **requestOptions:** `Prompts.RequestOptions`
916
962
 
917
963
  </dd>
918
964
  </dl>
@@ -923,7 +969,7 @@ Version numbers are integer values representing different iterations of the Tool
923
969
  </dl>
924
970
  </details>
925
971
 
926
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
972
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
927
973
  <dl>
928
974
  <dd>
929
975
 
@@ -935,9 +981,9 @@ Version numbers are integer values representing different iterations of the Tool
935
981
  <dl>
936
982
  <dd>
937
983
 
938
- Updates the description of a specified **Tool** version.
984
+ Deletes a **Prompt** and its versions.
939
985
 
940
- Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
986
+ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
941
987
 
942
988
  </dd>
943
989
  </dl>
@@ -953,10 +999,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
953
999
  <dd>
954
1000
 
955
1001
  ```typescript
956
- await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
957
- versionDescription:
958
- "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
959
- });
1002
+ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
960
1003
  ```
961
1004
 
962
1005
  </dd>
@@ -972,29 +1015,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
972
1015
  <dl>
973
1016
  <dd>
974
1017
 
975
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
976
-
977
- </dd>
978
- </dl>
979
-
980
- <dl>
981
- <dd>
982
-
983
- **version:** `number`
984
-
985
- Version number for a Tool.
986
-
987
- Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
988
-
989
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
990
-
991
- </dd>
992
- </dl>
993
-
994
- <dl>
995
- <dd>
996
-
997
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
1018
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
998
1019
 
999
1020
  </dd>
1000
1021
  </dl>
@@ -1002,7 +1023,7 @@ Version numbers are integer values representing different iterations of the Tool
1002
1023
  <dl>
1003
1024
  <dd>
1004
1025
 
1005
- **requestOptions:** `Tools.RequestOptions`
1026
+ **requestOptions:** `Prompts.RequestOptions`
1006
1027
 
1007
1028
  </dd>
1008
1029
  </dl>
@@ -1013,9 +1034,7 @@ Version numbers are integer values representing different iterations of the Tool
1013
1034
  </dl>
1014
1035
  </details>
1015
1036
 
1016
- ## EmpathicVoice Prompts
1017
-
1018
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
1037
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1019
1038
  <dl>
1020
1039
  <dd>
1021
1040
 
@@ -1027,7 +1046,7 @@ Version numbers are integer values representing different iterations of the Tool
1027
1046
  <dl>
1028
1047
  <dd>
1029
1048
 
1030
- Fetches a paginated list of **Prompts**.
1049
+ Updates the name of a **Prompt**.
1031
1050
 
1032
1051
  See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1033
1052
 
@@ -1045,9 +1064,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1045
1064
  <dd>
1046
1065
 
1047
1066
  ```typescript
1048
- await client.empathicVoice.prompts.listPrompts({
1049
- pageNumber: 0,
1050
- pageSize: 2,
1067
+ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1068
+ name: "Updated Weather Assistant Prompt Name",
1051
1069
  });
1052
1070
  ```
1053
1071
 
@@ -1064,7 +1082,15 @@ await client.empathicVoice.prompts.listPrompts({
1064
1082
  <dl>
1065
1083
  <dd>
1066
1084
 
1067
- **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1085
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1086
+
1087
+ </dd>
1088
+ </dl>
1089
+
1090
+ <dl>
1091
+ <dd>
1092
+
1093
+ **request:** `Hume.empathicVoice.PostedPromptName`
1068
1094
 
1069
1095
  </dd>
1070
1096
  </dl>
@@ -1083,7 +1109,7 @@ await client.empathicVoice.prompts.listPrompts({
1083
1109
  </dl>
1084
1110
  </details>
1085
1111
 
1086
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1112
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
1087
1113
  <dl>
1088
1114
  <dd>
1089
1115
 
@@ -1095,7 +1121,7 @@ await client.empathicVoice.prompts.listPrompts({
1095
1121
  <dl>
1096
1122
  <dd>
1097
1123
 
1098
- Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
1124
+ Fetches a specified version of a **Prompt**.
1099
1125
 
1100
1126
  See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1101
1127
 
@@ -1113,10 +1139,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1113
1139
  <dd>
1114
1140
 
1115
1141
  ```typescript
1116
- await client.empathicVoice.prompts.createPrompt({
1117
- name: "Weather Assistant Prompt",
1118
- text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
1119
- });
1142
+ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1120
1143
  ```
1121
1144
 
1122
1145
  </dd>
@@ -1132,7 +1155,21 @@ await client.empathicVoice.prompts.createPrompt({
1132
1155
  <dl>
1133
1156
  <dd>
1134
1157
 
1135
- **request:** `Hume.empathicVoice.PostedPrompt`
1158
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1159
+
1160
+ </dd>
1161
+ </dl>
1162
+
1163
+ <dl>
1164
+ <dd>
1165
+
1166
+ **version:** `number`
1167
+
1168
+ Version number for a Prompt.
1169
+
1170
+ Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1171
+
1172
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1136
1173
 
1137
1174
  </dd>
1138
1175
  </dl>
@@ -1151,7 +1188,7 @@ await client.empathicVoice.prompts.createPrompt({
1151
1188
  </dl>
1152
1189
  </details>
1153
1190
 
1154
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
1191
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1155
1192
  <dl>
1156
1193
  <dd>
1157
1194
 
@@ -1163,7 +1200,7 @@ await client.empathicVoice.prompts.createPrompt({
1163
1200
  <dl>
1164
1201
  <dd>
1165
1202
 
1166
- Fetches a list of a **Prompt's** versions.
1203
+ Deletes a specified version of a **Prompt**.
1167
1204
 
1168
1205
  See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1169
1206
 
@@ -1181,7 +1218,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1181
1218
  <dd>
1182
1219
 
1183
1220
  ```typescript
1184
- await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1221
+ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1185
1222
  ```
1186
1223
 
1187
1224
  </dd>
@@ -1205,7 +1242,13 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1205
1242
  <dl>
1206
1243
  <dd>
1207
1244
 
1208
- **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1245
+ **version:** `number`
1246
+
1247
+ Version number for a Prompt.
1248
+
1249
+ Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1250
+
1251
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1209
1252
 
1210
1253
  </dd>
1211
1254
  </dl>
@@ -1224,7 +1267,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1224
1267
  </dl>
1225
1268
  </details>
1226
1269
 
1227
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVerison</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1270
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1228
1271
  <dl>
1229
1272
  <dd>
1230
1273
 
@@ -1236,7 +1279,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1236
1279
  <dl>
1237
1280
  <dd>
1238
1281
 
1239
- Updates a **Prompt** by creating a new version of the **Prompt**.
1282
+ Updates the description of a **Prompt**.
1240
1283
 
1241
1284
  See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1242
1285
 
@@ -1254,9 +1297,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1254
1297
  <dd>
1255
1298
 
1256
1299
  ```typescript
1257
- await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1258
- text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
1259
- versionDescription: "This is an updated version of the Weather Assistant Prompt.",
1300
+ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1301
+ versionDescription: "This is an updated version_description.",
1260
1302
  });
1261
1303
  ```
1262
1304
 
@@ -1281,7 +1323,21 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
1281
1323
  <dl>
1282
1324
  <dd>
1283
1325
 
1284
- **request:** `Hume.empathicVoice.PostedPromptVersion`
1326
+ **version:** `number`
1327
+
1328
+ Version number for a Prompt.
1329
+
1330
+ Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1331
+
1332
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1333
+
1334
+ </dd>
1335
+ </dl>
1336
+
1337
+ <dl>
1338
+ <dd>
1339
+
1340
+ **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1285
1341
 
1286
1342
  </dd>
1287
1343
  </dl>
@@ -1300,7 +1356,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
1300
1356
  </dl>
1301
1357
  </details>
1302
1358
 
1303
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1359
+ ## EmpathicVoice CustomVoices
1360
+
1361
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
1304
1362
  <dl>
1305
1363
  <dd>
1306
1364
 
@@ -1312,9 +1370,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
1312
1370
  <dl>
1313
1371
  <dd>
1314
1372
 
1315
- Deletes a **Prompt** and its versions.
1373
+ Fetches a paginated list of **Custom Voices**.
1316
1374
 
1317
- See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1375
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1318
1376
 
1319
1377
  </dd>
1320
1378
  </dl>
@@ -1330,7 +1388,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1330
1388
  <dd>
1331
1389
 
1332
1390
  ```typescript
1333
- await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1391
+ await client.empathicVoice.customVoices.listCustomVoices();
1334
1392
  ```
1335
1393
 
1336
1394
  </dd>
@@ -1346,7 +1404,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1346
1404
  <dl>
1347
1405
  <dd>
1348
1406
 
1349
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1407
+ **request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
1350
1408
 
1351
1409
  </dd>
1352
1410
  </dl>
@@ -1354,7 +1412,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1354
1412
  <dl>
1355
1413
  <dd>
1356
1414
 
1357
- **requestOptions:** `Prompts.RequestOptions`
1415
+ **requestOptions:** `CustomVoices.RequestOptions`
1358
1416
 
1359
1417
  </dd>
1360
1418
  </dl>
@@ -1365,7 +1423,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1365
1423
  </dl>
1366
1424
  </details>
1367
1425
 
1368
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1426
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
1369
1427
  <dl>
1370
1428
  <dd>
1371
1429
 
@@ -1377,9 +1435,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1377
1435
  <dl>
1378
1436
  <dd>
1379
1437
 
1380
- Updates the name of a **Prompt**.
1438
+ Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
1381
1439
 
1382
- See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1440
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1383
1441
 
1384
1442
  </dd>
1385
1443
  </dl>
@@ -1395,8 +1453,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1395
1453
  <dd>
1396
1454
 
1397
1455
  ```typescript
1398
- await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1399
- name: "Updated Weather Assistant Prompt Name",
1456
+ await client.empathicVoice.customVoices.createCustomVoice({
1457
+ name: "name",
1458
+ baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1459
+ parameterModel: "20241004-11parameter",
1400
1460
  });
1401
1461
  ```
1402
1462
 
@@ -1413,15 +1473,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1413
1473
  <dl>
1414
1474
  <dd>
1415
1475
 
1416
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1417
-
1418
- </dd>
1419
- </dl>
1420
-
1421
- <dl>
1422
- <dd>
1423
-
1424
- **request:** `Hume.empathicVoice.PostedPromptName`
1476
+ **request:** `Hume.PostedCustomVoice`
1425
1477
 
1426
1478
  </dd>
1427
1479
  </dl>
@@ -1429,7 +1481,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1429
1481
  <dl>
1430
1482
  <dd>
1431
1483
 
1432
- **requestOptions:** `Prompts.RequestOptions`
1484
+ **requestOptions:** `CustomVoices.RequestOptions`
1433
1485
 
1434
1486
  </dd>
1435
1487
  </dl>
@@ -1440,7 +1492,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1440
1492
  </dl>
1441
1493
  </details>
1442
1494
 
1443
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
1495
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
1444
1496
  <dl>
1445
1497
  <dd>
1446
1498
 
@@ -1452,9 +1504,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1452
1504
  <dl>
1453
1505
  <dd>
1454
1506
 
1455
- Fetches a specified version of a **Prompt**.
1507
+ Fetches a specific **Custom Voice** by ID.
1456
1508
 
1457
- See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1509
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1458
1510
 
1459
1511
  </dd>
1460
1512
  </dl>
@@ -1470,7 +1522,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1470
1522
  <dd>
1471
1523
 
1472
1524
  ```typescript
1473
- await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1525
+ await client.empathicVoice.customVoices.getCustomVoice("id");
1474
1526
  ```
1475
1527
 
1476
1528
  </dd>
@@ -1486,21 +1538,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1486
1538
  <dl>
1487
1539
  <dd>
1488
1540
 
1489
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1490
-
1491
- </dd>
1492
- </dl>
1493
-
1494
- <dl>
1495
- <dd>
1496
-
1497
- **version:** `number`
1498
-
1499
- Version number for a Prompt.
1500
-
1501
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1502
-
1503
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1541
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1504
1542
 
1505
1543
  </dd>
1506
1544
  </dl>
@@ -1508,7 +1546,7 @@ Version numbers are integer values representing different iterations of the Prom
1508
1546
  <dl>
1509
1547
  <dd>
1510
1548
 
1511
- **requestOptions:** `Prompts.RequestOptions`
1549
+ **requestOptions:** `CustomVoices.RequestOptions`
1512
1550
 
1513
1551
  </dd>
1514
1552
  </dl>
@@ -1519,7 +1557,7 @@ Version numbers are integer values representing different iterations of the Prom
1519
1557
  </dl>
1520
1558
  </details>
1521
1559
 
1522
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1560
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoiceVersion</a>(id, { ...params }) -> Hume.ReturnCustomVoice</code></summary>
1523
1561
  <dl>
1524
1562
  <dd>
1525
1563
 
@@ -1531,9 +1569,9 @@ Version numbers are integer values representing different iterations of the Prom
1531
1569
  <dl>
1532
1570
  <dd>
1533
1571
 
1534
- Deletes a specified version of a **Prompt**.
1572
+ Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
1535
1573
 
1536
- See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1574
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1537
1575
 
1538
1576
  </dd>
1539
1577
  </dl>
@@ -1549,7 +1587,11 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1549
1587
  <dd>
1550
1588
 
1551
1589
  ```typescript
1552
- await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1590
+ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1591
+ name: "name",
1592
+ baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1593
+ parameterModel: "20241004-11parameter",
1594
+ });
1553
1595
  ```
1554
1596
 
1555
1597
  </dd>
@@ -1565,7 +1607,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1565
1607
  <dl>
1566
1608
  <dd>
1567
1609
 
1568
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1610
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1569
1611
 
1570
1612
  </dd>
1571
1613
  </dl>
@@ -1573,13 +1615,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1573
1615
  <dl>
1574
1616
  <dd>
1575
1617
 
1576
- **version:** `number`
1577
-
1578
- Version number for a Prompt.
1579
-
1580
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1581
-
1582
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1618
+ **request:** `Hume.PostedCustomVoice`
1583
1619
 
1584
1620
  </dd>
1585
1621
  </dl>
@@ -1587,7 +1623,7 @@ Version numbers are integer values representing different iterations of the Prom
1587
1623
  <dl>
1588
1624
  <dd>
1589
1625
 
1590
- **requestOptions:** `Prompts.RequestOptions`
1626
+ **requestOptions:** `CustomVoices.RequestOptions`
1591
1627
 
1592
1628
  </dd>
1593
1629
  </dl>
@@ -1598,7 +1634,7 @@ Version numbers are integer values representing different iterations of the Prom
1598
1634
  </dl>
1599
1635
  </details>
1600
1636
 
1601
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1637
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
1602
1638
  <dl>
1603
1639
  <dd>
1604
1640
 
@@ -1610,9 +1646,9 @@ Version numbers are integer values representing different iterations of the Prom
1610
1646
  <dl>
1611
1647
  <dd>
1612
1648
 
1613
- Updates the description of a **Prompt**.
1649
+ Deletes a **Custom Voice** and its versions.
1614
1650
 
1615
- See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
1651
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1616
1652
 
1617
1653
  </dd>
1618
1654
  </dl>
@@ -1628,9 +1664,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
1628
1664
  <dd>
1629
1665
 
1630
1666
  ```typescript
1631
- await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1632
- versionDescription: "This is an updated version_description.",
1633
- });
1667
+ await client.empathicVoice.customVoices.deleteCustomVoice("id");
1634
1668
  ```
1635
1669
 
1636
1670
  </dd>
@@ -1646,7 +1680,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1646
1680
  <dl>
1647
1681
  <dd>
1648
1682
 
1649
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1683
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1650
1684
 
1651
1685
  </dd>
1652
1686
  </dl>
@@ -1654,29 +1688,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1654
1688
  <dl>
1655
1689
  <dd>
1656
1690
 
1657
- **version:** `number`
1658
-
1659
- Version number for a Prompt.
1660
-
1661
- Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
1662
-
1663
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1664
-
1665
- </dd>
1666
- </dl>
1667
-
1668
- <dl>
1669
- <dd>
1670
-
1671
- **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1672
-
1673
- </dd>
1674
- </dl>
1675
-
1676
- <dl>
1677
- <dd>
1678
-
1679
- **requestOptions:** `Prompts.RequestOptions`
1691
+ **requestOptions:** `CustomVoices.RequestOptions`
1680
1692
 
1681
1693
  </dd>
1682
1694
  </dl>
@@ -1687,9 +1699,9 @@ Version numbers are integer values representing different iterations of the Prom
1687
1699
  </dl>
1688
1700
  </details>
1689
1701
 
1690
- ## EmpathicVoice CustomVoices
1702
+ ## EmpathicVoice Configs
1691
1703
 
1692
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
1704
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
1693
1705
  <dl>
1694
1706
  <dd>
1695
1707
 
@@ -1701,9 +1713,9 @@ Version numbers are integer values representing different iterations of the Prom
1701
1713
  <dl>
1702
1714
  <dd>
1703
1715
 
1704
- Fetches a paginated list of **Custom Voices**.
1716
+ Fetches a paginated list of **Configs**.
1705
1717
 
1706
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1718
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
1707
1719
 
1708
1720
  </dd>
1709
1721
  </dl>
@@ -1719,7 +1731,10 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
1719
1731
  <dd>
1720
1732
 
1721
1733
  ```typescript
1722
- await client.empathicVoice.customVoices.listCustomVoices();
1734
+ await client.empathicVoice.configs.listConfigs({
1735
+ pageNumber: 0,
1736
+ pageSize: 1,
1737
+ });
1723
1738
  ```
1724
1739
 
1725
1740
  </dd>
@@ -1735,7 +1750,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
1735
1750
  <dl>
1736
1751
  <dd>
1737
1752
 
1738
- **request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
1753
+ **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
1739
1754
 
1740
1755
  </dd>
1741
1756
  </dl>
@@ -1743,7 +1758,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
1743
1758
  <dl>
1744
1759
  <dd>
1745
1760
 
1746
- **requestOptions:** `CustomVoices.RequestOptions`
1761
+ **requestOptions:** `Configs.RequestOptions`
1747
1762
 
1748
1763
  </dd>
1749
1764
  </dl>
@@ -1754,7 +1769,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
1754
1769
  </dl>
1755
1770
  </details>
1756
1771
 
1757
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
1772
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
1758
1773
  <dl>
1759
1774
  <dd>
1760
1775
 
@@ -1766,9 +1781,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
1766
1781
  <dl>
1767
1782
  <dd>
1768
1783
 
1769
- Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
1784
+ Creates a **Config** which can be applied to EVI.
1770
1785
 
1771
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1786
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
1772
1787
 
1773
1788
  </dd>
1774
1789
  </dl>
@@ -1784,10 +1799,36 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
1784
1799
  <dd>
1785
1800
 
1786
1801
  ```typescript
1787
- await client.empathicVoice.customVoices.createCustomVoice({
1788
- name: "name",
1789
- baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1790
- parameterModel: "20241004-11parameter",
1802
+ await client.empathicVoice.configs.createConfig({
1803
+ name: "Weather Assistant Config",
1804
+ prompt: {
1805
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1806
+ version: 0,
1807
+ },
1808
+ eviVersion: "2",
1809
+ voice: {
1810
+ provider: Hume.PostedVoiceProvider.HumeAi,
1811
+ name: "SAMPLE VOICE",
1812
+ },
1813
+ languageModel: {
1814
+ modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
1815
+ modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
1816
+ temperature: 1,
1817
+ },
1818
+ eventMessages: {
1819
+ onNewChat: {
1820
+ enabled: false,
1821
+ text: "",
1822
+ },
1823
+ onInactivityTimeout: {
1824
+ enabled: false,
1825
+ text: "",
1826
+ },
1827
+ onMaxDurationTimeout: {
1828
+ enabled: false,
1829
+ text: "",
1830
+ },
1831
+ },
1791
1832
  });
1792
1833
  ```
1793
1834
 
@@ -1804,7 +1845,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
1804
1845
  <dl>
1805
1846
  <dd>
1806
1847
 
1807
- **request:** `Hume.PostedCustomVoice`
1848
+ **request:** `Hume.empathicVoice.PostedConfig`
1808
1849
 
1809
1850
  </dd>
1810
1851
  </dl>
@@ -1812,7 +1853,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
1812
1853
  <dl>
1813
1854
  <dd>
1814
1855
 
1815
- **requestOptions:** `CustomVoices.RequestOptions`
1856
+ **requestOptions:** `Configs.RequestOptions`
1816
1857
 
1817
1858
  </dd>
1818
1859
  </dl>
@@ -1823,7 +1864,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
1823
1864
  </dl>
1824
1865
  </details>
1825
1866
 
1826
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
1867
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> Hume.ReturnPagedConfigs</code></summary>
1827
1868
  <dl>
1828
1869
  <dd>
1829
1870
 
@@ -1835,9 +1876,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
1835
1876
  <dl>
1836
1877
  <dd>
1837
1878
 
1838
- Fetches a specific **Custom Voice** by ID.
1879
+ Fetches a list of a **Config's** versions.
1839
1880
 
1840
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1881
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
1841
1882
 
1842
1883
  </dd>
1843
1884
  </dl>
@@ -1853,7 +1894,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
1853
1894
  <dd>
1854
1895
 
1855
1896
  ```typescript
1856
- await client.empathicVoice.customVoices.getCustomVoice("id");
1897
+ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1857
1898
  ```
1858
1899
 
1859
1900
  </dd>
@@ -1869,7 +1910,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1869
1910
  <dl>
1870
1911
  <dd>
1871
1912
 
1872
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1913
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1873
1914
 
1874
1915
  </dd>
1875
1916
  </dl>
@@ -1877,7 +1918,15 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1877
1918
  <dl>
1878
1919
  <dd>
1879
1920
 
1880
- **requestOptions:** `CustomVoices.RequestOptions`
1921
+ **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
1922
+
1923
+ </dd>
1924
+ </dl>
1925
+
1926
+ <dl>
1927
+ <dd>
1928
+
1929
+ **requestOptions:** `Configs.RequestOptions`
1881
1930
 
1882
1931
  </dd>
1883
1932
  </dl>
@@ -1888,7 +1937,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1888
1937
  </dl>
1889
1938
  </details>
1890
1939
 
1891
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoiceVersion</a>(id, { ...params }) -> Hume.ReturnCustomVoice</code></summary>
1940
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
1892
1941
  <dl>
1893
1942
  <dd>
1894
1943
 
@@ -1900,9 +1949,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1900
1949
  <dl>
1901
1950
  <dd>
1902
1951
 
1903
- Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
1952
+ Updates a **Config** by creating a new version of the **Config**.
1904
1953
 
1905
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
1954
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
1906
1955
 
1907
1956
  </dd>
1908
1957
  </dl>
@@ -1918,10 +1967,39 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
1918
1967
  <dd>
1919
1968
 
1920
1969
  ```typescript
1921
- await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1922
- name: "name",
1923
- baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1924
- parameterModel: "20241004-11parameter",
1970
+ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1971
+ versionDescription: "This is an updated version of the Weather Assistant Config.",
1972
+ eviVersion: "2",
1973
+ prompt: {
1974
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1975
+ version: 0,
1976
+ },
1977
+ voice: {
1978
+ provider: Hume.PostedVoiceProvider.HumeAi,
1979
+ name: "ITO",
1980
+ },
1981
+ languageModel: {
1982
+ modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
1983
+ modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
1984
+ temperature: 1,
1985
+ },
1986
+ ellmModel: {
1987
+ allowShortResponses: true,
1988
+ },
1989
+ eventMessages: {
1990
+ onNewChat: {
1991
+ enabled: false,
1992
+ text: "",
1993
+ },
1994
+ onInactivityTimeout: {
1995
+ enabled: false,
1996
+ text: "",
1997
+ },
1998
+ onMaxDurationTimeout: {
1999
+ enabled: false,
2000
+ text: "",
2001
+ },
2002
+ },
1925
2003
  });
1926
2004
  ```
1927
2005
 
@@ -1938,7 +2016,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1938
2016
  <dl>
1939
2017
  <dd>
1940
2018
 
1941
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2019
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1942
2020
 
1943
2021
  </dd>
1944
2022
  </dl>
@@ -1946,7 +2024,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1946
2024
  <dl>
1947
2025
  <dd>
1948
2026
 
1949
- **request:** `Hume.PostedCustomVoice`
2027
+ **request:** `Hume.empathicVoice.PostedConfigVersion`
1950
2028
 
1951
2029
  </dd>
1952
2030
  </dl>
@@ -1954,7 +2032,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1954
2032
  <dl>
1955
2033
  <dd>
1956
2034
 
1957
- **requestOptions:** `CustomVoices.RequestOptions`
2035
+ **requestOptions:** `Configs.RequestOptions`
1958
2036
 
1959
2037
  </dd>
1960
2038
  </dl>
@@ -1965,7 +2043,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1965
2043
  </dl>
1966
2044
  </details>
1967
2045
 
1968
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
2046
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
1969
2047
  <dl>
1970
2048
  <dd>
1971
2049
 
@@ -1977,9 +2055,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1977
2055
  <dl>
1978
2056
  <dd>
1979
2057
 
1980
- Deletes a **Custom Voice** and its versions.
2058
+ Deletes a **Config** and its versions.
1981
2059
 
1982
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
2060
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
1983
2061
 
1984
2062
  </dd>
1985
2063
  </dl>
@@ -1995,7 +2073,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
1995
2073
  <dd>
1996
2074
 
1997
2075
  ```typescript
1998
- await client.empathicVoice.customVoices.deleteCustomVoice("id");
2076
+ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1999
2077
  ```
2000
2078
 
2001
2079
  </dd>
@@ -2011,7 +2089,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
2011
2089
  <dl>
2012
2090
  <dd>
2013
2091
 
2014
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2092
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2015
2093
 
2016
2094
  </dd>
2017
2095
  </dl>
@@ -2019,7 +2097,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
2019
2097
  <dl>
2020
2098
  <dd>
2021
2099
 
2022
- **requestOptions:** `CustomVoices.RequestOptions`
2100
+ **requestOptions:** `Configs.RequestOptions`
2023
2101
 
2024
2102
  </dd>
2025
2103
  </dl>
@@ -2030,9 +2108,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
2030
2108
  </dl>
2031
2109
  </details>
2032
2110
 
2033
- ## EmpathicVoice Configs
2034
-
2035
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
2111
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2036
2112
  <dl>
2037
2113
  <dd>
2038
2114
 
@@ -2044,7 +2120,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
2044
2120
  <dl>
2045
2121
  <dd>
2046
2122
 
2047
- Fetches a paginated list of **Configs**.
2123
+ Updates the name of a **Config**.
2048
2124
 
2049
2125
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2050
2126
 
@@ -2062,9 +2138,8 @@ For more details on configuration options and how to configure EVI, see our [con
2062
2138
  <dd>
2063
2139
 
2064
2140
  ```typescript
2065
- await client.empathicVoice.configs.listConfigs({
2066
- pageNumber: 0,
2067
- pageSize: 1,
2141
+ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2142
+ name: "Updated Weather Assistant Config Name",
2068
2143
  });
2069
2144
  ```
2070
2145
 
@@ -2081,7 +2156,15 @@ await client.empathicVoice.configs.listConfigs({
2081
2156
  <dl>
2082
2157
  <dd>
2083
2158
 
2084
- **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
2159
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2160
+
2161
+ </dd>
2162
+ </dl>
2163
+
2164
+ <dl>
2165
+ <dd>
2166
+
2167
+ **request:** `Hume.empathicVoice.PostedConfigName`
2085
2168
 
2086
2169
  </dd>
2087
2170
  </dl>
@@ -2100,7 +2183,7 @@ await client.empathicVoice.configs.listConfigs({
2100
2183
  </dl>
2101
2184
  </details>
2102
2185
 
2103
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
2186
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
2104
2187
  <dl>
2105
2188
  <dd>
2106
2189
 
@@ -2112,7 +2195,7 @@ await client.empathicVoice.configs.listConfigs({
2112
2195
  <dl>
2113
2196
  <dd>
2114
2197
 
2115
- Creates a **Config** which can be applied to EVI.
2198
+ Fetches a specified version of a **Config**.
2116
2199
 
2117
2200
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2118
2201
 
@@ -2130,37 +2213,7 @@ For more details on configuration options and how to configure EVI, see our [con
2130
2213
  <dd>
2131
2214
 
2132
2215
  ```typescript
2133
- await client.empathicVoice.configs.createConfig({
2134
- name: "Weather Assistant Config",
2135
- prompt: {
2136
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2137
- version: 0,
2138
- },
2139
- eviVersion: "2",
2140
- voice: {
2141
- provider: Hume.PostedVoiceProvider.HumeAi,
2142
- name: "SAMPLE VOICE",
2143
- },
2144
- languageModel: {
2145
- modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2146
- modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2147
- temperature: 1,
2148
- },
2149
- eventMessages: {
2150
- onNewChat: {
2151
- enabled: false,
2152
- text: "",
2153
- },
2154
- onInactivityTimeout: {
2155
- enabled: false,
2156
- text: "",
2157
- },
2158
- onMaxDurationTimeout: {
2159
- enabled: false,
2160
- text: "",
2161
- },
2162
- },
2163
- });
2216
+ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2164
2217
  ```
2165
2218
 
2166
2219
  </dd>
@@ -2176,7 +2229,21 @@ await client.empathicVoice.configs.createConfig({
2176
2229
  <dl>
2177
2230
  <dd>
2178
2231
 
2179
- **request:** `Hume.empathicVoice.PostedConfig`
2232
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2233
+
2234
+ </dd>
2235
+ </dl>
2236
+
2237
+ <dl>
2238
+ <dd>
2239
+
2240
+ **version:** `number`
2241
+
2242
+ Version number for a Config.
2243
+
2244
+ Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2245
+
2246
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2180
2247
 
2181
2248
  </dd>
2182
2249
  </dl>
@@ -2195,7 +2262,7 @@ await client.empathicVoice.configs.createConfig({
2195
2262
  </dl>
2196
2263
  </details>
2197
2264
 
2198
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> Hume.ReturnPagedConfigs</code></summary>
2265
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2199
2266
  <dl>
2200
2267
  <dd>
2201
2268
 
@@ -2207,7 +2274,7 @@ await client.empathicVoice.configs.createConfig({
2207
2274
  <dl>
2208
2275
  <dd>
2209
2276
 
2210
- Fetches a list of a **Config's** versions.
2277
+ Deletes a specified version of a **Config**.
2211
2278
 
2212
2279
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2213
2280
 
@@ -2225,7 +2292,7 @@ For more details on configuration options and how to configure EVI, see our [con
2225
2292
  <dd>
2226
2293
 
2227
2294
  ```typescript
2228
- await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2295
+ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2229
2296
  ```
2230
2297
 
2231
2298
  </dd>
@@ -2249,7 +2316,13 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2249
2316
  <dl>
2250
2317
  <dd>
2251
2318
 
2252
- **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
2319
+ **version:** `number`
2320
+
2321
+ Version number for a Config.
2322
+
2323
+ Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2324
+
2325
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2253
2326
 
2254
2327
  </dd>
2255
2328
  </dl>
@@ -2268,7 +2341,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2268
2341
  </dl>
2269
2342
  </details>
2270
2343
 
2271
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
2344
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
2272
2345
  <dl>
2273
2346
  <dd>
2274
2347
 
@@ -2280,7 +2353,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2280
2353
  <dl>
2281
2354
  <dd>
2282
2355
 
2283
- Updates a **Config** by creating a new version of the **Config**.
2356
+ Updates the description of a **Config**.
2284
2357
 
2285
2358
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2286
2359
 
@@ -2298,39 +2371,8 @@ For more details on configuration options and how to configure EVI, see our [con
2298
2371
  <dd>
2299
2372
 
2300
2373
  ```typescript
2301
- await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2302
- versionDescription: "This is an updated version of the Weather Assistant Config.",
2303
- eviVersion: "2",
2304
- prompt: {
2305
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2306
- version: 0,
2307
- },
2308
- voice: {
2309
- provider: Hume.PostedVoiceProvider.HumeAi,
2310
- name: "ITO",
2311
- },
2312
- languageModel: {
2313
- modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2314
- modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2315
- temperature: 1,
2316
- },
2317
- ellmModel: {
2318
- allowShortResponses: true,
2319
- },
2320
- eventMessages: {
2321
- onNewChat: {
2322
- enabled: false,
2323
- text: "",
2324
- },
2325
- onInactivityTimeout: {
2326
- enabled: false,
2327
- text: "",
2328
- },
2329
- onMaxDurationTimeout: {
2330
- enabled: false,
2331
- text: "",
2332
- },
2333
- },
2374
+ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2375
+ versionDescription: "This is an updated version_description.",
2334
2376
  });
2335
2377
  ```
2336
2378
 
@@ -2355,7 +2397,21 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2355
2397
  <dl>
2356
2398
  <dd>
2357
2399
 
2358
- **request:** `Hume.empathicVoice.PostedConfigVersion`
2400
+ **version:** `number`
2401
+
2402
+ Version number for a Config.
2403
+
2404
+ Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2405
+
2406
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2407
+
2408
+ </dd>
2409
+ </dl>
2410
+
2411
+ <dl>
2412
+ <dd>
2413
+
2414
+ **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2359
2415
 
2360
2416
  </dd>
2361
2417
  </dl>
@@ -2374,7 +2430,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2374
2430
  </dl>
2375
2431
  </details>
2376
2432
 
2377
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
2433
+ ## EmpathicVoice Chats
2434
+
2435
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
2378
2436
  <dl>
2379
2437
  <dd>
2380
2438
 
@@ -2386,9 +2444,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2386
2444
  <dl>
2387
2445
  <dd>
2388
2446
 
2389
- Deletes a **Config** and its versions.
2390
-
2391
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2447
+ Fetches a paginated list of **Chats**.
2392
2448
 
2393
2449
  </dd>
2394
2450
  </dl>
@@ -2404,7 +2460,11 @@ For more details on configuration options and how to configure EVI, see our [con
2404
2460
  <dd>
2405
2461
 
2406
2462
  ```typescript
2407
- await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2463
+ await client.empathicVoice.chats.listChats({
2464
+ pageNumber: 0,
2465
+ pageSize: 1,
2466
+ ascendingOrder: true,
2467
+ });
2408
2468
  ```
2409
2469
 
2410
2470
  </dd>
@@ -2420,7 +2480,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2420
2480
  <dl>
2421
2481
  <dd>
2422
2482
 
2423
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2483
+ **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2424
2484
 
2425
2485
  </dd>
2426
2486
  </dl>
@@ -2428,7 +2488,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2428
2488
  <dl>
2429
2489
  <dd>
2430
2490
 
2431
- **requestOptions:** `Configs.RequestOptions`
2491
+ **requestOptions:** `Chats.RequestOptions`
2432
2492
 
2433
2493
  </dd>
2434
2494
  </dl>
@@ -2439,7 +2499,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2439
2499
  </dl>
2440
2500
  </details>
2441
2501
 
2442
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2502
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
2443
2503
  <dl>
2444
2504
  <dd>
2445
2505
 
@@ -2451,9 +2511,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2451
2511
  <dl>
2452
2512
  <dd>
2453
2513
 
2454
- Updates the name of a **Config**.
2455
-
2456
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2514
+ Fetches a paginated list of **Chat** events.
2457
2515
 
2458
2516
  </dd>
2459
2517
  </dl>
@@ -2469,8 +2527,10 @@ For more details on configuration options and how to configure EVI, see our [con
2469
2527
  <dd>
2470
2528
 
2471
2529
  ```typescript
2472
- await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2473
- name: "Updated Weather Assistant Config Name",
2530
+ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2531
+ pageNumber: 0,
2532
+ pageSize: 3,
2533
+ ascendingOrder: true,
2474
2534
  });
2475
2535
  ```
2476
2536
 
@@ -2487,7 +2547,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2487
2547
  <dl>
2488
2548
  <dd>
2489
2549
 
2490
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2550
+ **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2491
2551
 
2492
2552
  </dd>
2493
2553
  </dl>
@@ -2495,7 +2555,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2495
2555
  <dl>
2496
2556
  <dd>
2497
2557
 
2498
- **request:** `Hume.empathicVoice.PostedConfigName`
2558
+ **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2499
2559
 
2500
2560
  </dd>
2501
2561
  </dl>
@@ -2503,7 +2563,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2503
2563
  <dl>
2504
2564
  <dd>
2505
2565
 
2506
- **requestOptions:** `Configs.RequestOptions`
2566
+ **requestOptions:** `Chats.RequestOptions`
2507
2567
 
2508
2568
  </dd>
2509
2569
  </dl>
@@ -2514,7 +2574,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2514
2574
  </dl>
2515
2575
  </details>
2516
2576
 
2517
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
2577
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2518
2578
  <dl>
2519
2579
  <dd>
2520
2580
 
@@ -2526,9 +2586,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2526
2586
  <dl>
2527
2587
  <dd>
2528
2588
 
2529
- Fetches a specified version of a **Config**.
2530
-
2531
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2589
+ Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
2532
2590
 
2533
2591
  </dd>
2534
2592
  </dl>
@@ -2544,7 +2602,7 @@ For more details on configuration options and how to configure EVI, see our [con
2544
2602
  <dd>
2545
2603
 
2546
2604
  ```typescript
2547
- await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2605
+ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
2548
2606
  ```
2549
2607
 
2550
2608
  </dd>
@@ -2560,21 +2618,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2560
2618
  <dl>
2561
2619
  <dd>
2562
2620
 
2563
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2564
-
2565
- </dd>
2566
- </dl>
2567
-
2568
- <dl>
2569
- <dd>
2570
-
2571
- **version:** `number`
2572
-
2573
- Version number for a Config.
2574
-
2575
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2576
-
2577
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2621
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
2578
2622
 
2579
2623
  </dd>
2580
2624
  </dl>
@@ -2582,7 +2626,7 @@ Version numbers are integer values representing different iterations of the Conf
2582
2626
  <dl>
2583
2627
  <dd>
2584
2628
 
2585
- **requestOptions:** `Configs.RequestOptions`
2629
+ **requestOptions:** `Chats.RequestOptions`
2586
2630
 
2587
2631
  </dd>
2588
2632
  </dl>
@@ -2593,7 +2637,9 @@ Version numbers are integer values representing different iterations of the Conf
2593
2637
  </dl>
2594
2638
  </details>
2595
2639
 
2596
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2640
+ ## EmpathicVoice ChatGroups
2641
+
2642
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
2597
2643
  <dl>
2598
2644
  <dd>
2599
2645
 
@@ -2605,9 +2651,7 @@ Version numbers are integer values representing different iterations of the Conf
2605
2651
  <dl>
2606
2652
  <dd>
2607
2653
 
2608
- Deletes a specified version of a **Config**.
2609
-
2610
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2654
+ Fetches a paginated list of **Chat Groups**.
2611
2655
 
2612
2656
  </dd>
2613
2657
  </dl>
@@ -2623,7 +2667,12 @@ For more details on configuration options and how to configure EVI, see our [con
2623
2667
  <dd>
2624
2668
 
2625
2669
  ```typescript
2626
- await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2670
+ await client.empathicVoice.chatGroups.listChatGroups({
2671
+ pageNumber: 0,
2672
+ pageSize: 1,
2673
+ ascendingOrder: true,
2674
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2675
+ });
2627
2676
  ```
2628
2677
 
2629
2678
  </dd>
@@ -2639,21 +2688,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2639
2688
  <dl>
2640
2689
  <dd>
2641
2690
 
2642
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2643
-
2644
- </dd>
2645
- </dl>
2646
-
2647
- <dl>
2648
- <dd>
2649
-
2650
- **version:** `number`
2651
-
2652
- Version number for a Config.
2653
-
2654
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2655
-
2656
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2691
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
2657
2692
 
2658
2693
  </dd>
2659
2694
  </dl>
@@ -2661,7 +2696,7 @@ Version numbers are integer values representing different iterations of the Conf
2661
2696
  <dl>
2662
2697
  <dd>
2663
2698
 
2664
- **requestOptions:** `Configs.RequestOptions`
2699
+ **requestOptions:** `ChatGroups.RequestOptions`
2665
2700
 
2666
2701
  </dd>
2667
2702
  </dl>
@@ -2672,7 +2707,7 @@ Version numbers are integer values representing different iterations of the Conf
2672
2707
  </dl>
2673
2708
  </details>
2674
2709
 
2675
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
2710
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
2676
2711
  <dl>
2677
2712
  <dd>
2678
2713
 
@@ -2684,9 +2719,7 @@ Version numbers are integer values representing different iterations of the Conf
2684
2719
  <dl>
2685
2720
  <dd>
2686
2721
 
2687
- Updates the description of a **Config**.
2688
-
2689
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2722
+ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
2690
2723
 
2691
2724
  </dd>
2692
2725
  </dl>
@@ -2702,8 +2735,10 @@ For more details on configuration options and how to configure EVI, see our [con
2702
2735
  <dd>
2703
2736
 
2704
2737
  ```typescript
2705
- await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2706
- versionDescription: "This is an updated version_description.",
2738
+ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2739
+ pageNumber: 0,
2740
+ pageSize: 1,
2741
+ ascendingOrder: true,
2707
2742
  });
2708
2743
  ```
2709
2744
 
@@ -2720,21 +2755,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
2720
2755
  <dl>
2721
2756
  <dd>
2722
2757
 
2723
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2724
-
2725
- </dd>
2726
- </dl>
2727
-
2728
- <dl>
2729
- <dd>
2730
-
2731
- **version:** `number`
2732
-
2733
- Version number for a Config.
2734
-
2735
- Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
2736
-
2737
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2758
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2738
2759
 
2739
2760
  </dd>
2740
2761
  </dl>
@@ -2742,7 +2763,7 @@ Version numbers are integer values representing different iterations of the Conf
2742
2763
  <dl>
2743
2764
  <dd>
2744
2765
 
2745
- **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2766
+ **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
2746
2767
 
2747
2768
  </dd>
2748
2769
  </dl>
@@ -2750,7 +2771,7 @@ Version numbers are integer values representing different iterations of the Conf
2750
2771
  <dl>
2751
2772
  <dd>
2752
2773
 
2753
- **requestOptions:** `Configs.RequestOptions`
2774
+ **requestOptions:** `ChatGroups.RequestOptions`
2754
2775
 
2755
2776
  </dd>
2756
2777
  </dl>
@@ -2761,9 +2782,7 @@ Version numbers are integer values representing different iterations of the Conf
2761
2782
  </dl>
2762
2783
  </details>
2763
2784
 
2764
- ## EmpathicVoice Chats
2765
-
2766
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
2785
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents</code></summary>
2767
2786
  <dl>
2768
2787
  <dd>
2769
2788
 
@@ -2775,7 +2794,7 @@ Version numbers are integer values representing different iterations of the Conf
2775
2794
  <dl>
2776
2795
  <dd>
2777
2796
 
2778
- Fetches a paginated list of **Chats**.
2797
+ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
2779
2798
 
2780
2799
  </dd>
2781
2800
  </dl>
@@ -2791,9 +2810,9 @@ Fetches a paginated list of **Chats**.
2791
2810
  <dd>
2792
2811
 
2793
2812
  ```typescript
2794
- await client.empathicVoice.chats.listChats({
2813
+ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2795
2814
  pageNumber: 0,
2796
- pageSize: 1,
2815
+ pageSize: 3,
2797
2816
  ascendingOrder: true,
2798
2817
  });
2799
2818
  ```
@@ -2811,7 +2830,7 @@ await client.empathicVoice.chats.listChats({
2811
2830
  <dl>
2812
2831
  <dd>
2813
2832
 
2814
- **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2833
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2815
2834
 
2816
2835
  </dd>
2817
2836
  </dl>
@@ -2819,7 +2838,15 @@ await client.empathicVoice.chats.listChats({
2819
2838
  <dl>
2820
2839
  <dd>
2821
2840
 
2822
- **requestOptions:** `Chats.RequestOptions`
2841
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
2842
+
2843
+ </dd>
2844
+ </dl>
2845
+
2846
+ <dl>
2847
+ <dd>
2848
+
2849
+ **requestOptions:** `ChatGroups.RequestOptions`
2823
2850
 
2824
2851
  </dd>
2825
2852
  </dl>
@@ -2830,7 +2857,7 @@ await client.empathicVoice.chats.listChats({
2830
2857
  </dl>
2831
2858
  </details>
2832
2859
 
2833
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
2860
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
2834
2861
  <dl>
2835
2862
  <dd>
2836
2863
 
@@ -2842,7 +2869,7 @@ await client.empathicVoice.chats.listChats({
2842
2869
  <dl>
2843
2870
  <dd>
2844
2871
 
2845
- Fetches a paginated list of **Chat** events.
2872
+ Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
2846
2873
 
2847
2874
  </dd>
2848
2875
  </dl>
@@ -2858,9 +2885,9 @@ Fetches a paginated list of **Chat** events.
2858
2885
  <dd>
2859
2886
 
2860
2887
  ```typescript
2861
- await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2888
+ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
2862
2889
  pageNumber: 0,
2863
- pageSize: 3,
2890
+ pageSize: 10,
2864
2891
  ascendingOrder: true,
2865
2892
  });
2866
2893
  ```
@@ -2878,7 +2905,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2878
2905
  <dl>
2879
2906
  <dd>
2880
2907
 
2881
- **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2908
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
2882
2909
 
2883
2910
  </dd>
2884
2911
  </dl>
@@ -2886,7 +2913,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2886
2913
  <dl>
2887
2914
  <dd>
2888
2915
 
2889
- **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2916
+ **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
2890
2917
 
2891
2918
  </dd>
2892
2919
  </dl>
@@ -2894,7 +2921,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2894
2921
  <dl>
2895
2922
  <dd>
2896
2923
 
2897
- **requestOptions:** `Chats.RequestOptions`
2924
+ **requestOptions:** `ChatGroups.RequestOptions`
2898
2925
 
2899
2926
  </dd>
2900
2927
  </dl>
@@ -2905,7 +2932,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2905
2932
  </dl>
2906
2933
  </details>
2907
2934
 
2908
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2935
+ ## ExpressionMeasurement Batch
2936
+
2937
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
2909
2938
  <dl>
2910
2939
  <dd>
2911
2940
 
@@ -2917,7 +2946,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2917
2946
  <dl>
2918
2947
  <dd>
2919
2948
 
2920
- Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
2949
+ Sort and filter jobs.
2921
2950
 
2922
2951
  </dd>
2923
2952
  </dl>
@@ -2933,7 +2962,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
2933
2962
  <dd>
2934
2963
 
2935
2964
  ```typescript
2936
- await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
2965
+ await client.expressionMeasurement.batch.listJobs();
2937
2966
  ```
2938
2967
 
2939
2968
  </dd>
@@ -2949,7 +2978,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2949
2978
  <dl>
2950
2979
  <dd>
2951
2980
 
2952
- **id:** `string` — Identifier for a chat. Formatted as a UUID.
2981
+ **request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
2953
2982
 
2954
2983
  </dd>
2955
2984
  </dl>
@@ -2957,7 +2986,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2957
2986
  <dl>
2958
2987
  <dd>
2959
2988
 
2960
- **requestOptions:** `Chats.RequestOptions`
2989
+ **requestOptions:** `Batch.RequestOptions`
2961
2990
 
2962
2991
  </dd>
2963
2992
  </dl>
@@ -2968,9 +2997,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2968
2997
  </dl>
2969
2998
  </details>
2970
2999
 
2971
- ## EmpathicVoice ChatGroups
2972
-
2973
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
3000
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
2974
3001
  <dl>
2975
3002
  <dd>
2976
3003
 
@@ -2982,7 +3009,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2982
3009
  <dl>
2983
3010
  <dd>
2984
3011
 
2985
- Fetches a paginated list of **Chat Groups**.
3012
+ Start a new measurement inference job.
2986
3013
 
2987
3014
  </dd>
2988
3015
  </dl>
@@ -2998,11 +3025,9 @@ Fetches a paginated list of **Chat Groups**.
2998
3025
  <dd>
2999
3026
 
3000
3027
  ```typescript
3001
- await client.empathicVoice.chatGroups.listChatGroups({
3002
- pageNumber: 0,
3003
- pageSize: 1,
3004
- ascendingOrder: true,
3005
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
3028
+ await client.expressionMeasurement.batch.startInferenceJob({
3029
+ urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
3030
+ notify: true,
3006
3031
  });
3007
3032
  ```
3008
3033
 
@@ -3019,7 +3044,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
3019
3044
  <dl>
3020
3045
  <dd>
3021
3046
 
3022
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
3047
+ **request:** `Hume.InferenceBaseRequest`
3023
3048
 
3024
3049
  </dd>
3025
3050
  </dl>
@@ -3027,7 +3052,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
3027
3052
  <dl>
3028
3053
  <dd>
3029
3054
 
3030
- **requestOptions:** `ChatGroups.RequestOptions`
3055
+ **requestOptions:** `Batch.RequestOptions`
3031
3056
 
3032
3057
  </dd>
3033
3058
  </dl>
@@ -3038,7 +3063,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
3038
3063
  </dl>
3039
3064
  </details>
3040
3065
 
3041
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
3066
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
3042
3067
  <dl>
3043
3068
  <dd>
3044
3069
 
@@ -3050,7 +3075,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
3050
3075
  <dl>
3051
3076
  <dd>
3052
3077
 
3053
- Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
3078
+ Get the request details and state of a given job.
3054
3079
 
3055
3080
  </dd>
3056
3081
  </dl>
@@ -3066,11 +3091,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
3066
3091
  <dd>
3067
3092
 
3068
3093
  ```typescript
3069
- await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3070
- pageNumber: 0,
3071
- pageSize: 1,
3072
- ascendingOrder: true,
3073
- });
3094
+ await client.expressionMeasurement.batch.getJobDetails("job_id");
3074
3095
  ```
3075
3096
 
3076
3097
  </dd>
@@ -3086,15 +3107,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3086
3107
  <dl>
3087
3108
  <dd>
3088
3109
 
3089
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3090
-
3091
- </dd>
3092
- </dl>
3093
-
3094
- <dl>
3095
- <dd>
3096
-
3097
- **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
3110
+ **id:** `string` — The unique identifier for the job.
3098
3111
 
3099
3112
  </dd>
3100
3113
  </dl>
@@ -3102,7 +3115,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3102
3115
  <dl>
3103
3116
  <dd>
3104
3117
 
3105
- **requestOptions:** `ChatGroups.RequestOptions`
3118
+ **requestOptions:** `Batch.RequestOptions`
3106
3119
 
3107
3120
  </dd>
3108
3121
  </dl>
@@ -3113,7 +3126,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3113
3126
  </dl>
3114
3127
  </details>
3115
3128
 
3116
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents</code></summary>
3129
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
3117
3130
  <dl>
3118
3131
  <dd>
3119
3132
 
@@ -3125,7 +3138,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3125
3138
  <dl>
3126
3139
  <dd>
3127
3140
 
3128
- Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3141
+ Get the JSON predictions of a completed inference job.
3129
3142
 
3130
3143
  </dd>
3131
3144
  </dl>
@@ -3141,11 +3154,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3141
3154
  <dd>
3142
3155
 
3143
3156
  ```typescript
3144
- await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3145
- pageNumber: 0,
3146
- pageSize: 3,
3147
- ascendingOrder: true,
3148
- });
3157
+ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3149
3158
  ```
3150
3159
 
3151
3160
  </dd>
@@ -3161,15 +3170,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3161
3170
  <dl>
3162
3171
  <dd>
3163
3172
 
3164
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3165
-
3166
- </dd>
3167
- </dl>
3168
-
3169
- <dl>
3170
- <dd>
3171
-
3172
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
3173
+ **id:** `string` — The unique identifier for the job.
3173
3174
 
3174
3175
  </dd>
3175
3176
  </dl>
@@ -3177,7 +3178,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3177
3178
  <dl>
3178
3179
  <dd>
3179
3180
 
3180
- **requestOptions:** `ChatGroups.RequestOptions`
3181
+ **requestOptions:** `Batch.RequestOptions`
3181
3182
 
3182
3183
  </dd>
3183
3184
  </dl>
@@ -3188,7 +3189,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3188
3189
  </dl>
3189
3190
  </details>
3190
3191
 
3191
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
3192
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
3192
3193
  <dl>
3193
3194
  <dd>
3194
3195
 
@@ -3200,7 +3201,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3200
3201
  <dl>
3201
3202
  <dd>
3202
3203
 
3203
- Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
3204
+ Start a new batch inference job.
3204
3205
 
3205
3206
  </dd>
3206
3207
  </dl>
@@ -3216,11 +3217,10 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
3216
3217
  <dd>
3217
3218
 
3218
3219
  ```typescript
3219
- await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
3220
- pageNumber: 0,
3221
- pageSize: 10,
3222
- ascendingOrder: true,
3223
- });
3220
+ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
3221
+ [fs.createReadStream("/path/to/your/file")],
3222
+ {}
3223
+ );
3224
3224
  ```
3225
3225
 
3226
3226
  </dd>
@@ -3236,7 +3236,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3236
3236
  <dl>
3237
3237
  <dd>
3238
3238
 
3239
- **id:** `string` Identifier for a chat. Formatted as a UUID.
3239
+ **file:** `File[] | fs.ReadStream[] | Blob[]`
3240
3240
 
3241
3241
  </dd>
3242
3242
  </dl>
@@ -3244,7 +3244,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3244
3244
  <dl>
3245
3245
  <dd>
3246
3246
 
3247
- **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
3247
+ **request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
3248
3248
 
3249
3249
  </dd>
3250
3250
  </dl>
@@ -3252,7 +3252,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3252
3252
  <dl>
3253
3253
  <dd>
3254
3254
 
3255
- **requestOptions:** `ChatGroups.RequestOptions`
3255
+ **requestOptions:** `Batch.RequestOptions`
3256
3256
 
3257
3257
  </dd>
3258
3258
  </dl>