hume 0.9.13 → 0.9.15

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 (60) hide show
  1. package/.mock/definition/expression-measurement/batch/__package__.yml +61 -76
  2. package/.mock/definition/tts/__package__.yml +113 -15
  3. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
  4. package/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
  5. package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  6. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  7. package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  8. package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  9. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  10. package/api/resources/index.d.ts +1 -1
  11. package/api/resources/index.js +2 -2
  12. package/api/resources/tts/client/Client.d.ts +11 -0
  13. package/api/resources/tts/client/Client.js +124 -2
  14. package/api/resources/tts/resources/voices/client/Client.js +1 -1
  15. package/api/resources/tts/types/PostedTts.d.ts +10 -0
  16. package/api/resources/tts/types/Snippet.d.ts +0 -2
  17. package/core/index.d.ts +1 -0
  18. package/core/index.js +1 -0
  19. package/core/streaming-fetcher/Stream.d.ts +48 -0
  20. package/core/streaming-fetcher/Stream.js +170 -0
  21. package/core/streaming-fetcher/index.d.ts +1 -0
  22. package/core/streaming-fetcher/index.js +5 -0
  23. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
  24. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
  25. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
  26. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  27. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  28. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  29. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  30. package/dist/api/resources/index.d.ts +1 -1
  31. package/dist/api/resources/index.js +2 -2
  32. package/dist/api/resources/tts/client/Client.d.ts +11 -0
  33. package/dist/api/resources/tts/client/Client.js +124 -2
  34. package/dist/api/resources/tts/resources/voices/client/Client.js +1 -1
  35. package/dist/api/resources/tts/types/PostedTts.d.ts +10 -0
  36. package/dist/api/resources/tts/types/Snippet.d.ts +0 -2
  37. package/dist/core/index.d.ts +1 -0
  38. package/dist/core/index.js +1 -0
  39. package/dist/core/streaming-fetcher/Stream.d.ts +48 -0
  40. package/dist/core/streaming-fetcher/Stream.js +170 -0
  41. package/dist/core/streaming-fetcher/index.d.ts +1 -0
  42. package/dist/core/streaming-fetcher/index.js +5 -0
  43. package/dist/serialization/resources/index.d.ts +1 -1
  44. package/dist/serialization/resources/index.js +2 -2
  45. package/dist/serialization/resources/tts/types/PostedTts.d.ts +1 -0
  46. package/dist/serialization/resources/tts/types/PostedTts.js +1 -0
  47. package/dist/serialization/resources/tts/types/Snippet.d.ts +0 -1
  48. package/dist/serialization/resources/tts/types/Snippet.js +0 -1
  49. package/dist/version.d.ts +1 -1
  50. package/dist/version.js +1 -1
  51. package/package.json +1 -1
  52. package/reference.md +716 -553
  53. package/serialization/resources/index.d.ts +1 -1
  54. package/serialization/resources/index.js +2 -2
  55. package/serialization/resources/tts/types/PostedTts.d.ts +1 -0
  56. package/serialization/resources/tts/types/PostedTts.js +1 -0
  57. package/serialization/resources/tts/types/Snippet.d.ts +0 -1
  58. package/serialization/resources/tts/types/Snippet.js +0 -1
  59. package/version.d.ts +1 -1
  60. package/version.js +1 -1
package/reference.md CHANGED
@@ -168,9 +168,7 @@ await client.tts.synthesizeFile({
168
168
  </dl>
169
169
  </details>
170
170
 
171
- ## Tts Voices
172
-
173
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
171
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
174
172
  <dl>
175
173
  <dd>
176
174
 
@@ -182,7 +180,7 @@ await client.tts.synthesizeFile({
182
180
  <dl>
183
181
  <dd>
184
182
 
185
- Creates a new voice from a specified TTS generation ID and saves it to your **Voice Library**. This allows for consistent speech style and prosody across multiple requests.
183
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
186
184
 
187
185
  </dd>
188
186
  </dl>
@@ -198,9 +196,21 @@ Creates a new voice from a specified TTS generation ID and saves it to your **Vo
198
196
  <dd>
199
197
 
200
198
  ```typescript
201
- await client.tts.voices.create({
202
- generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
203
- name: "David Hume",
199
+ await client.tts.synthesizeFileStreaming({
200
+ utterances: [
201
+ {
202
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
203
+ description:
204
+ "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
205
+ },
206
+ ],
207
+ context: {
208
+ generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
209
+ },
210
+ format: {
211
+ type: "mp3",
212
+ },
213
+ numGenerations: 1,
204
214
  });
205
215
  ```
206
216
 
@@ -217,7 +227,7 @@ await client.tts.voices.create({
217
227
  <dl>
218
228
  <dd>
219
229
 
220
- **request:** `Hume.tts.PostedVoice`
230
+ **request:** `Hume.PostedTts`
221
231
 
222
232
  </dd>
223
233
  </dl>
@@ -225,7 +235,7 @@ await client.tts.voices.create({
225
235
  <dl>
226
236
  <dd>
227
237
 
228
- **requestOptions:** `Voices.RequestOptions`
238
+ **requestOptions:** `Tts.RequestOptions`
229
239
 
230
240
  </dd>
231
241
  </dl>
@@ -236,9 +246,7 @@ await client.tts.voices.create({
236
246
  </dl>
237
247
  </details>
238
248
 
239
- ## EmpathicVoice Tools
240
-
241
- <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>
249
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.Snippet></code></summary>
242
250
  <dl>
243
251
  <dd>
244
252
 
@@ -250,9 +258,9 @@ await client.tts.voices.create({
250
258
  <dl>
251
259
  <dd>
252
260
 
253
- Fetches a paginated list of **Tools**.
261
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
254
262
 
255
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
263
+ The response is a stream of JSON objects including audio encoded in base64.
256
264
 
257
265
  </dd>
258
266
  </dl>
@@ -268,9 +276,26 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
268
276
  <dd>
269
277
 
270
278
  ```typescript
271
- await client.empathicVoice.tools.listTools({
272
- pageNumber: 0,
273
- pageSize: 2,
279
+ await client.tts.synthesizeJsonStreaming({
280
+ utterances: [
281
+ {
282
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
283
+ description:
284
+ "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
285
+ },
286
+ ],
287
+ context: {
288
+ utterances: [
289
+ {
290
+ text: "How can people see beauty so differently?",
291
+ description:
292
+ "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
293
+ },
294
+ ],
295
+ },
296
+ format: {
297
+ type: "mp3",
298
+ },
274
299
  });
275
300
  ```
276
301
 
@@ -287,7 +312,7 @@ await client.empathicVoice.tools.listTools({
287
312
  <dl>
288
313
  <dd>
289
314
 
290
- **request:** `Hume.empathicVoice.ToolsListToolsRequest`
315
+ **request:** `Hume.PostedTts`
291
316
 
292
317
  </dd>
293
318
  </dl>
@@ -295,7 +320,7 @@ await client.empathicVoice.tools.listTools({
295
320
  <dl>
296
321
  <dd>
297
322
 
298
- **requestOptions:** `Tools.RequestOptions`
323
+ **requestOptions:** `Tts.RequestOptions`
299
324
 
300
325
  </dd>
301
326
  </dl>
@@ -306,7 +331,9 @@ await client.empathicVoice.tools.listTools({
306
331
  </dl>
307
332
  </details>
308
333
 
309
- <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>
334
+ ## Tts Voices
335
+
336
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
310
337
  <dl>
311
338
  <dd>
312
339
 
@@ -318,9 +345,7 @@ await client.empathicVoice.tools.listTools({
318
345
  <dl>
319
346
  <dd>
320
347
 
321
- Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
322
-
323
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
348
+ Creates a new voice from a specified TTS generation ID and saves it to your **Voice Library**. This allows for consistent speech style and prosody across multiple requests.
324
349
 
325
350
  </dd>
326
351
  </dl>
@@ -336,13 +361,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
336
361
  <dd>
337
362
 
338
363
  ```typescript
339
- await client.empathicVoice.tools.createTool({
340
- name: "get_current_weather",
341
- parameters:
342
- '{ "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"] }',
343
- versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
344
- description: "This tool is for getting the current weather.",
345
- fallbackContent: "Unable to fetch current weather.",
364
+ await client.tts.voices.create({
365
+ generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
366
+ name: "David Hume",
346
367
  });
347
368
  ```
348
369
 
@@ -359,7 +380,7 @@ await client.empathicVoice.tools.createTool({
359
380
  <dl>
360
381
  <dd>
361
382
 
362
- **request:** `Hume.empathicVoice.PostedUserDefinedTool`
383
+ **request:** `Hume.tts.PostedVoice`
363
384
 
364
385
  </dd>
365
386
  </dl>
@@ -367,7 +388,7 @@ await client.empathicVoice.tools.createTool({
367
388
  <dl>
368
389
  <dd>
369
390
 
370
- **requestOptions:** `Tools.RequestOptions`
391
+ **requestOptions:** `Voices.RequestOptions`
371
392
 
372
393
  </dd>
373
394
  </dl>
@@ -378,7 +399,9 @@ await client.empathicVoice.tools.createTool({
378
399
  </dl>
379
400
  </details>
380
401
 
381
- <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>
402
+ ## ExpressionMeasurement Batch
403
+
404
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
382
405
  <dl>
383
406
  <dd>
384
407
 
@@ -390,9 +413,7 @@ await client.empathicVoice.tools.createTool({
390
413
  <dl>
391
414
  <dd>
392
415
 
393
- Fetches a list of a **Tool's** versions.
394
-
395
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
416
+ Sort and filter jobs.
396
417
 
397
418
  </dd>
398
419
  </dl>
@@ -408,7 +429,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
408
429
  <dd>
409
430
 
410
431
  ```typescript
411
- await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
432
+ await client.expressionMeasurement.batch.listJobs();
412
433
  ```
413
434
 
414
435
  </dd>
@@ -424,15 +445,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
424
445
  <dl>
425
446
  <dd>
426
447
 
427
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
428
-
429
- </dd>
430
- </dl>
431
-
432
- <dl>
433
- <dd>
434
-
435
- **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
448
+ **request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
436
449
 
437
450
  </dd>
438
451
  </dl>
@@ -440,7 +453,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
440
453
  <dl>
441
454
  <dd>
442
455
 
443
- **requestOptions:** `Tools.RequestOptions`
456
+ **requestOptions:** `Batch.RequestOptions`
444
457
 
445
458
  </dd>
446
459
  </dl>
@@ -451,7 +464,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
451
464
  </dl>
452
465
  </details>
453
466
 
454
- <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>
467
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
455
468
  <dl>
456
469
  <dd>
457
470
 
@@ -463,9 +476,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
463
476
  <dl>
464
477
  <dd>
465
478
 
466
- Updates a **Tool** by creating a new version of the **Tool**.
467
-
468
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
479
+ Start a new measurement inference job.
469
480
 
470
481
  </dd>
471
482
  </dl>
@@ -481,12 +492,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
481
492
  <dd>
482
493
 
483
494
  ```typescript
484
- await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
485
- parameters:
486
- '{ "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"] }',
487
- versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
488
- fallbackContent: "Unable to fetch current weather.",
489
- description: "This tool is for getting the current weather.",
495
+ await client.expressionMeasurement.batch.startInferenceJob({
496
+ urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
497
+ notify: true,
490
498
  });
491
499
  ```
492
500
 
@@ -503,15 +511,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
503
511
  <dl>
504
512
  <dd>
505
513
 
506
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
507
-
508
- </dd>
509
- </dl>
510
-
511
- <dl>
512
- <dd>
513
-
514
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
514
+ **request:** `Hume.InferenceBaseRequest`
515
515
 
516
516
  </dd>
517
517
  </dl>
@@ -519,7 +519,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
519
519
  <dl>
520
520
  <dd>
521
521
 
522
- **requestOptions:** `Tools.RequestOptions`
522
+ **requestOptions:** `Batch.RequestOptions`
523
523
 
524
524
  </dd>
525
525
  </dl>
@@ -530,7 +530,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
530
530
  </dl>
531
531
  </details>
532
532
 
533
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
533
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
534
534
  <dl>
535
535
  <dd>
536
536
 
@@ -542,9 +542,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
542
542
  <dl>
543
543
  <dd>
544
544
 
545
- Deletes a **Tool** and its versions.
546
-
547
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
545
+ Get the request details and state of a given job.
548
546
 
549
547
  </dd>
550
548
  </dl>
@@ -560,7 +558,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
560
558
  <dd>
561
559
 
562
560
  ```typescript
563
- await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
561
+ await client.expressionMeasurement.batch.getJobDetails("job_id");
564
562
  ```
565
563
 
566
564
  </dd>
@@ -576,7 +574,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
576
574
  <dl>
577
575
  <dd>
578
576
 
579
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
577
+ **id:** `string` — The unique identifier for the job.
580
578
 
581
579
  </dd>
582
580
  </dl>
@@ -584,7 +582,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
584
582
  <dl>
585
583
  <dd>
586
584
 
587
- **requestOptions:** `Tools.RequestOptions`
585
+ **requestOptions:** `Batch.RequestOptions`
588
586
 
589
587
  </dd>
590
588
  </dl>
@@ -595,7 +593,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
595
593
  </dl>
596
594
  </details>
597
595
 
598
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
596
+ <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
599
597
  <dl>
600
598
  <dd>
601
599
 
@@ -607,9 +605,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
607
605
  <dl>
608
606
  <dd>
609
607
 
610
- Updates the name of a **Tool**.
611
-
612
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
608
+ Get the JSON predictions of a completed inference job.
613
609
 
614
610
  </dd>
615
611
  </dl>
@@ -625,9 +621,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
625
621
  <dd>
626
622
 
627
623
  ```typescript
628
- await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
629
- name: "get_current_temperature",
630
- });
624
+ await client.expressionMeasurement.batch.getJobPredictions("job_id");
631
625
  ```
632
626
 
633
627
  </dd>
@@ -643,15 +637,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
643
637
  <dl>
644
638
  <dd>
645
639
 
646
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
647
-
648
- </dd>
649
- </dl>
650
-
651
- <dl>
652
- <dd>
653
-
654
- **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
640
+ **id:** `string` — The unique identifier for the job.
655
641
 
656
642
  </dd>
657
643
  </dl>
@@ -659,7 +645,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
659
645
  <dl>
660
646
  <dd>
661
647
 
662
- **requestOptions:** `Tools.RequestOptions`
648
+ **requestOptions:** `Batch.RequestOptions`
663
649
 
664
650
  </dd>
665
651
  </dl>
@@ -670,7 +656,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
670
656
  </dl>
671
657
  </details>
672
658
 
673
- <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>
659
+ <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>
674
660
  <dl>
675
661
  <dd>
676
662
 
@@ -682,9 +668,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
682
668
  <dl>
683
669
  <dd>
684
670
 
685
- Fetches a specified version of a **Tool**.
686
-
687
- Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
671
+ Start a new batch inference job.
688
672
 
689
673
  </dd>
690
674
  </dl>
@@ -700,7 +684,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
700
684
  <dd>
701
685
 
702
686
  ```typescript
703
- await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
687
+ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
688
+ [fs.createReadStream("/path/to/your/file")],
689
+ {}
690
+ );
704
691
  ```
705
692
 
706
693
  </dd>
@@ -716,7 +703,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
716
703
  <dl>
717
704
  <dd>
718
705
 
719
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
706
+ **file:** `File[] | fs.ReadStream[] | Blob[]`
720
707
 
721
708
  </dd>
722
709
  </dl>
@@ -724,13 +711,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
724
711
  <dl>
725
712
  <dd>
726
713
 
727
- **version:** `number`
728
-
729
- Version number for a Tool.
730
-
731
- 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.
732
-
733
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
714
+ **request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
734
715
 
735
716
  </dd>
736
717
  </dl>
@@ -738,7 +719,7 @@ Version numbers are integer values representing different iterations of the Tool
738
719
  <dl>
739
720
  <dd>
740
721
 
741
- **requestOptions:** `Tools.RequestOptions`
722
+ **requestOptions:** `Batch.RequestOptions`
742
723
 
743
724
  </dd>
744
725
  </dl>
@@ -749,7 +730,9 @@ Version numbers are integer values representing different iterations of the Tool
749
730
  </dl>
750
731
  </details>
751
732
 
752
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
733
+ ## EmpathicVoice Tools
734
+
735
+ <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>
753
736
  <dl>
754
737
  <dd>
755
738
 
@@ -761,7 +744,7 @@ Version numbers are integer values representing different iterations of the Tool
761
744
  <dl>
762
745
  <dd>
763
746
 
764
- Deletes a specified version of a **Tool**.
747
+ Fetches a paginated list of **Tools**.
765
748
 
766
749
  Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
767
750
 
@@ -779,7 +762,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
779
762
  <dd>
780
763
 
781
764
  ```typescript
782
- await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
765
+ await client.empathicVoice.tools.listTools({
766
+ pageNumber: 0,
767
+ pageSize: 2,
768
+ });
783
769
  ```
784
770
 
785
771
  </dd>
@@ -795,21 +781,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
795
781
  <dl>
796
782
  <dd>
797
783
 
798
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
799
-
800
- </dd>
801
- </dl>
802
-
803
- <dl>
804
- <dd>
805
-
806
- **version:** `number`
807
-
808
- Version number for a Tool.
809
-
810
- 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.
811
-
812
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
784
+ **request:** `Hume.empathicVoice.ToolsListToolsRequest`
813
785
 
814
786
  </dd>
815
787
  </dl>
@@ -828,7 +800,7 @@ Version numbers are integer values representing different iterations of the Tool
828
800
  </dl>
829
801
  </details>
830
802
 
831
- <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>
803
+ <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>
832
804
  <dl>
833
805
  <dd>
834
806
 
@@ -840,7 +812,7 @@ Version numbers are integer values representing different iterations of the Tool
840
812
  <dl>
841
813
  <dd>
842
814
 
843
- Updates the description of a specified **Tool** version.
815
+ Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
844
816
 
845
817
  Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
846
818
 
@@ -858,9 +830,13 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
858
830
  <dd>
859
831
 
860
832
  ```typescript
861
- await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
862
- versionDescription:
863
- "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
833
+ await client.empathicVoice.tools.createTool({
834
+ name: "get_current_weather",
835
+ parameters:
836
+ '{ "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"] }',
837
+ versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
838
+ description: "This tool is for getting the current weather.",
839
+ fallbackContent: "Unable to fetch current weather.",
864
840
  });
865
841
  ```
866
842
 
@@ -877,29 +853,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
877
853
  <dl>
878
854
  <dd>
879
855
 
880
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
881
-
882
- </dd>
883
- </dl>
884
-
885
- <dl>
886
- <dd>
887
-
888
- **version:** `number`
889
-
890
- Version number for a Tool.
891
-
892
- 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.
893
-
894
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
895
-
896
- </dd>
897
- </dl>
898
-
899
- <dl>
900
- <dd>
901
-
902
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
856
+ **request:** `Hume.empathicVoice.PostedUserDefinedTool`
903
857
 
904
858
  </dd>
905
859
  </dl>
@@ -918,9 +872,7 @@ Version numbers are integer values representing different iterations of the Tool
918
872
  </dl>
919
873
  </details>
920
874
 
921
- ## EmpathicVoice Prompts
922
-
923
- <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>
875
+ <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>
924
876
  <dl>
925
877
  <dd>
926
878
 
@@ -932,9 +884,9 @@ Version numbers are integer values representing different iterations of the Tool
932
884
  <dl>
933
885
  <dd>
934
886
 
935
- Fetches a paginated list of **Prompts**.
887
+ Fetches a list of a **Tool's** versions.
936
888
 
937
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
889
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
938
890
 
939
891
  </dd>
940
892
  </dl>
@@ -950,10 +902,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
950
902
  <dd>
951
903
 
952
904
  ```typescript
953
- await client.empathicVoice.prompts.listPrompts({
954
- pageNumber: 0,
955
- pageSize: 2,
956
- });
905
+ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
957
906
  ```
958
907
 
959
908
  </dd>
@@ -969,7 +918,7 @@ await client.empathicVoice.prompts.listPrompts({
969
918
  <dl>
970
919
  <dd>
971
920
 
972
- **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
921
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
973
922
 
974
923
  </dd>
975
924
  </dl>
@@ -977,7 +926,15 @@ await client.empathicVoice.prompts.listPrompts({
977
926
  <dl>
978
927
  <dd>
979
928
 
980
- **requestOptions:** `Prompts.RequestOptions`
929
+ **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
930
+
931
+ </dd>
932
+ </dl>
933
+
934
+ <dl>
935
+ <dd>
936
+
937
+ **requestOptions:** `Tools.RequestOptions`
981
938
 
982
939
  </dd>
983
940
  </dl>
@@ -988,7 +945,7 @@ await client.empathicVoice.prompts.listPrompts({
988
945
  </dl>
989
946
  </details>
990
947
 
991
- <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>
948
+ <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>
992
949
  <dl>
993
950
  <dd>
994
951
 
@@ -1000,9 +957,9 @@ await client.empathicVoice.prompts.listPrompts({
1000
957
  <dl>
1001
958
  <dd>
1002
959
 
1003
- Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
960
+ Updates a **Tool** by creating a new version of the **Tool**.
1004
961
 
1005
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
962
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1006
963
 
1007
964
  </dd>
1008
965
  </dl>
@@ -1018,9 +975,12 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1018
975
  <dd>
1019
976
 
1020
977
  ```typescript
1021
- await client.empathicVoice.prompts.createPrompt({
1022
- name: "Weather Assistant Prompt",
1023
- 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>",
978
+ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
979
+ parameters:
980
+ '{ "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"] }',
981
+ versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
982
+ fallbackContent: "Unable to fetch current weather.",
983
+ description: "This tool is for getting the current weather.",
1024
984
  });
1025
985
  ```
1026
986
 
@@ -1037,7 +997,7 @@ await client.empathicVoice.prompts.createPrompt({
1037
997
  <dl>
1038
998
  <dd>
1039
999
 
1040
- **request:** `Hume.empathicVoice.PostedPrompt`
1000
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1041
1001
 
1042
1002
  </dd>
1043
1003
  </dl>
@@ -1045,7 +1005,15 @@ await client.empathicVoice.prompts.createPrompt({
1045
1005
  <dl>
1046
1006
  <dd>
1047
1007
 
1048
- **requestOptions:** `Prompts.RequestOptions`
1008
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
1009
+
1010
+ </dd>
1011
+ </dl>
1012
+
1013
+ <dl>
1014
+ <dd>
1015
+
1016
+ **requestOptions:** `Tools.RequestOptions`
1049
1017
 
1050
1018
  </dd>
1051
1019
  </dl>
@@ -1056,7 +1024,7 @@ await client.empathicVoice.prompts.createPrompt({
1056
1024
  </dl>
1057
1025
  </details>
1058
1026
 
1059
- <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>
1027
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
1060
1028
  <dl>
1061
1029
  <dd>
1062
1030
 
@@ -1068,9 +1036,9 @@ await client.empathicVoice.prompts.createPrompt({
1068
1036
  <dl>
1069
1037
  <dd>
1070
1038
 
1071
- Fetches a list of a **Prompt's** versions.
1039
+ Deletes a **Tool** and its versions.
1072
1040
 
1073
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1041
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1074
1042
 
1075
1043
  </dd>
1076
1044
  </dl>
@@ -1086,7 +1054,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1086
1054
  <dd>
1087
1055
 
1088
1056
  ```typescript
1089
- await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1057
+ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
1090
1058
  ```
1091
1059
 
1092
1060
  </dd>
@@ -1102,15 +1070,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1102
1070
  <dl>
1103
1071
  <dd>
1104
1072
 
1105
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1106
-
1107
- </dd>
1108
- </dl>
1109
-
1110
- <dl>
1111
- <dd>
1112
-
1113
- **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1073
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1114
1074
 
1115
1075
  </dd>
1116
1076
  </dl>
@@ -1118,7 +1078,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1118
1078
  <dl>
1119
1079
  <dd>
1120
1080
 
1121
- **requestOptions:** `Prompts.RequestOptions`
1081
+ **requestOptions:** `Tools.RequestOptions`
1122
1082
 
1123
1083
  </dd>
1124
1084
  </dl>
@@ -1129,7 +1089,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1129
1089
  </dl>
1130
1090
  </details>
1131
1091
 
1132
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1092
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
1133
1093
  <dl>
1134
1094
  <dd>
1135
1095
 
@@ -1141,9 +1101,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1141
1101
  <dl>
1142
1102
  <dd>
1143
1103
 
1144
- Updates a **Prompt** by creating a new version of the **Prompt**.
1104
+ Updates the name of a **Tool**.
1145
1105
 
1146
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1106
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1147
1107
 
1148
1108
  </dd>
1149
1109
  </dl>
@@ -1159,9 +1119,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1159
1119
  <dd>
1160
1120
 
1161
1121
  ```typescript
1162
- await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1163
- 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>",
1164
- versionDescription: "This is an updated version of the Weather Assistant Prompt.",
1122
+ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
1123
+ name: "get_current_temperature",
1165
1124
  });
1166
1125
  ```
1167
1126
 
@@ -1178,7 +1137,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1178
1137
  <dl>
1179
1138
  <dd>
1180
1139
 
1181
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1140
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1182
1141
 
1183
1142
  </dd>
1184
1143
  </dl>
@@ -1186,7 +1145,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1186
1145
  <dl>
1187
1146
  <dd>
1188
1147
 
1189
- **request:** `Hume.empathicVoice.PostedPromptVersion`
1148
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
1190
1149
 
1191
1150
  </dd>
1192
1151
  </dl>
@@ -1194,7 +1153,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1194
1153
  <dl>
1195
1154
  <dd>
1196
1155
 
1197
- **requestOptions:** `Prompts.RequestOptions`
1156
+ **requestOptions:** `Tools.RequestOptions`
1198
1157
 
1199
1158
  </dd>
1200
1159
  </dl>
@@ -1205,7 +1164,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1205
1164
  </dl>
1206
1165
  </details>
1207
1166
 
1208
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1167
+ <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>
1209
1168
  <dl>
1210
1169
  <dd>
1211
1170
 
@@ -1217,9 +1176,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1217
1176
  <dl>
1218
1177
  <dd>
1219
1178
 
1220
- Deletes a **Prompt** and its versions.
1179
+ Fetches a specified version of a **Tool**.
1221
1180
 
1222
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1181
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1223
1182
 
1224
1183
  </dd>
1225
1184
  </dl>
@@ -1235,7 +1194,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1235
1194
  <dd>
1236
1195
 
1237
1196
  ```typescript
1238
- await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1197
+ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1239
1198
  ```
1240
1199
 
1241
1200
  </dd>
@@ -1251,7 +1210,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1251
1210
  <dl>
1252
1211
  <dd>
1253
1212
 
1254
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1213
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1255
1214
 
1256
1215
  </dd>
1257
1216
  </dl>
@@ -1259,7 +1218,21 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1259
1218
  <dl>
1260
1219
  <dd>
1261
1220
 
1262
- **requestOptions:** `Prompts.RequestOptions`
1221
+ **version:** `number`
1222
+
1223
+ Version number for a Tool.
1224
+
1225
+ 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.
1226
+
1227
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1228
+
1229
+ </dd>
1230
+ </dl>
1231
+
1232
+ <dl>
1233
+ <dd>
1234
+
1235
+ **requestOptions:** `Tools.RequestOptions`
1263
1236
 
1264
1237
  </dd>
1265
1238
  </dl>
@@ -1270,7 +1243,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1270
1243
  </dl>
1271
1244
  </details>
1272
1245
 
1273
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1246
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
1274
1247
  <dl>
1275
1248
  <dd>
1276
1249
 
@@ -1282,9 +1255,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1282
1255
  <dl>
1283
1256
  <dd>
1284
1257
 
1285
- Updates the name of a **Prompt**.
1258
+ Deletes a specified version of a **Tool**.
1286
1259
 
1287
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1260
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1288
1261
 
1289
1262
  </dd>
1290
1263
  </dl>
@@ -1300,9 +1273,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1300
1273
  <dd>
1301
1274
 
1302
1275
  ```typescript
1303
- await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1304
- name: "Updated Weather Assistant Prompt Name",
1305
- });
1276
+ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1306
1277
  ```
1307
1278
 
1308
1279
  </dd>
@@ -1318,7 +1289,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1318
1289
  <dl>
1319
1290
  <dd>
1320
1291
 
1321
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1292
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1322
1293
 
1323
1294
  </dd>
1324
1295
  </dl>
@@ -1326,7 +1297,13 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1326
1297
  <dl>
1327
1298
  <dd>
1328
1299
 
1329
- **request:** `Hume.empathicVoice.PostedPromptName`
1300
+ **version:** `number`
1301
+
1302
+ Version number for a Tool.
1303
+
1304
+ 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.
1305
+
1306
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1330
1307
 
1331
1308
  </dd>
1332
1309
  </dl>
@@ -1334,7 +1311,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1334
1311
  <dl>
1335
1312
  <dd>
1336
1313
 
1337
- **requestOptions:** `Prompts.RequestOptions`
1314
+ **requestOptions:** `Tools.RequestOptions`
1338
1315
 
1339
1316
  </dd>
1340
1317
  </dl>
@@ -1345,7 +1322,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1345
1322
  </dl>
1346
1323
  </details>
1347
1324
 
1348
- <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>
1325
+ <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>
1349
1326
  <dl>
1350
1327
  <dd>
1351
1328
 
@@ -1357,9 +1334,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1357
1334
  <dl>
1358
1335
  <dd>
1359
1336
 
1360
- Fetches a specified version of a **Prompt**.
1337
+ Updates the description of a specified **Tool** version.
1361
1338
 
1362
- See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1339
+ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1363
1340
 
1364
1341
  </dd>
1365
1342
  </dl>
@@ -1375,7 +1352,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1375
1352
  <dd>
1376
1353
 
1377
1354
  ```typescript
1378
- await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1355
+ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
1356
+ versionDescription:
1357
+ "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
1358
+ });
1379
1359
  ```
1380
1360
 
1381
1361
  </dd>
@@ -1391,7 +1371,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1391
1371
  <dl>
1392
1372
  <dd>
1393
1373
 
1394
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1374
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1395
1375
 
1396
1376
  </dd>
1397
1377
  </dl>
@@ -1401,11 +1381,11 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1401
1381
 
1402
1382
  **version:** `number`
1403
1383
 
1404
- Version number for a Prompt.
1384
+ Version number for a Tool.
1405
1385
 
1406
- 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.
1386
+ 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.
1407
1387
 
1408
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1388
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1409
1389
 
1410
1390
  </dd>
1411
1391
  </dl>
@@ -1413,7 +1393,15 @@ Version numbers are integer values representing different iterations of the Prom
1413
1393
  <dl>
1414
1394
  <dd>
1415
1395
 
1416
- **requestOptions:** `Prompts.RequestOptions`
1396
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
1397
+
1398
+ </dd>
1399
+ </dl>
1400
+
1401
+ <dl>
1402
+ <dd>
1403
+
1404
+ **requestOptions:** `Tools.RequestOptions`
1417
1405
 
1418
1406
  </dd>
1419
1407
  </dl>
@@ -1424,7 +1412,9 @@ Version numbers are integer values representing different iterations of the Prom
1424
1412
  </dl>
1425
1413
  </details>
1426
1414
 
1427
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1415
+ ## EmpathicVoice Prompts
1416
+
1417
+ <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>
1428
1418
  <dl>
1429
1419
  <dd>
1430
1420
 
@@ -1436,7 +1426,7 @@ Version numbers are integer values representing different iterations of the Prom
1436
1426
  <dl>
1437
1427
  <dd>
1438
1428
 
1439
- Deletes a specified version of a **Prompt**.
1429
+ Fetches a paginated list of **Prompts**.
1440
1430
 
1441
1431
  See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1442
1432
 
@@ -1454,7 +1444,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1454
1444
  <dd>
1455
1445
 
1456
1446
  ```typescript
1457
- await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1447
+ await client.empathicVoice.prompts.listPrompts({
1448
+ pageNumber: 0,
1449
+ pageSize: 2,
1450
+ });
1458
1451
  ```
1459
1452
 
1460
1453
  </dd>
@@ -1470,21 +1463,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1470
1463
  <dl>
1471
1464
  <dd>
1472
1465
 
1473
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1474
-
1475
- </dd>
1476
- </dl>
1477
-
1478
- <dl>
1479
- <dd>
1480
-
1481
- **version:** `number`
1482
-
1483
- Version number for a Prompt.
1484
-
1485
- 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.
1486
-
1487
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1466
+ **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1488
1467
 
1489
1468
  </dd>
1490
1469
  </dl>
@@ -1503,7 +1482,7 @@ Version numbers are integer values representing different iterations of the Prom
1503
1482
  </dl>
1504
1483
  </details>
1505
1484
 
1506
- <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>
1485
+ <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>
1507
1486
  <dl>
1508
1487
  <dd>
1509
1488
 
@@ -1515,7 +1494,7 @@ Version numbers are integer values representing different iterations of the Prom
1515
1494
  <dl>
1516
1495
  <dd>
1517
1496
 
1518
- Updates the description of a **Prompt**.
1497
+ Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
1519
1498
 
1520
1499
  See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1521
1500
 
@@ -1533,8 +1512,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
1533
1512
  <dd>
1534
1513
 
1535
1514
  ```typescript
1536
- await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1537
- versionDescription: "This is an updated version_description.",
1515
+ await client.empathicVoice.prompts.createPrompt({
1516
+ name: "Weather Assistant Prompt",
1517
+ 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>",
1538
1518
  });
1539
1519
  ```
1540
1520
 
@@ -1551,29 +1531,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1551
1531
  <dl>
1552
1532
  <dd>
1553
1533
 
1554
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1555
-
1556
- </dd>
1557
- </dl>
1558
-
1559
- <dl>
1560
- <dd>
1561
-
1562
- **version:** `number`
1563
-
1564
- Version number for a Prompt.
1565
-
1566
- 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.
1567
-
1568
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1569
-
1570
- </dd>
1571
- </dl>
1572
-
1573
- <dl>
1574
- <dd>
1575
-
1576
- **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1534
+ **request:** `Hume.empathicVoice.PostedPrompt`
1577
1535
 
1578
1536
  </dd>
1579
1537
  </dl>
@@ -1592,9 +1550,7 @@ Version numbers are integer values representing different iterations of the Prom
1592
1550
  </dl>
1593
1551
  </details>
1594
1552
 
1595
- ## EmpathicVoice CustomVoices
1596
-
1597
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
1553
+ <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>
1598
1554
  <dl>
1599
1555
  <dd>
1600
1556
 
@@ -1606,9 +1562,9 @@ Version numbers are integer values representing different iterations of the Prom
1606
1562
  <dl>
1607
1563
  <dd>
1608
1564
 
1609
- Fetches a paginated list of **Custom Voices**.
1565
+ Fetches a list of a **Prompt's** versions.
1610
1566
 
1611
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1567
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1612
1568
 
1613
1569
  </dd>
1614
1570
  </dl>
@@ -1624,7 +1580,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1624
1580
  <dd>
1625
1581
 
1626
1582
  ```typescript
1627
- await client.empathicVoice.customVoices.listCustomVoices();
1583
+ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1628
1584
  ```
1629
1585
 
1630
1586
  </dd>
@@ -1640,7 +1596,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
1640
1596
  <dl>
1641
1597
  <dd>
1642
1598
 
1643
- **request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
1599
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1644
1600
 
1645
1601
  </dd>
1646
1602
  </dl>
@@ -1648,7 +1604,15 @@ await client.empathicVoice.customVoices.listCustomVoices();
1648
1604
  <dl>
1649
1605
  <dd>
1650
1606
 
1651
- **requestOptions:** `CustomVoices.RequestOptions`
1607
+ **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1608
+
1609
+ </dd>
1610
+ </dl>
1611
+
1612
+ <dl>
1613
+ <dd>
1614
+
1615
+ **requestOptions:** `Prompts.RequestOptions`
1652
1616
 
1653
1617
  </dd>
1654
1618
  </dl>
@@ -1659,7 +1623,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
1659
1623
  </dl>
1660
1624
  </details>
1661
1625
 
1662
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
1626
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
1663
1627
  <dl>
1664
1628
  <dd>
1665
1629
 
@@ -1671,9 +1635,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
1671
1635
  <dl>
1672
1636
  <dd>
1673
1637
 
1674
- Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
1638
+ Updates a **Prompt** by creating a new version of the **Prompt**.
1675
1639
 
1676
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1640
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1677
1641
 
1678
1642
  </dd>
1679
1643
  </dl>
@@ -1689,10 +1653,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1689
1653
  <dd>
1690
1654
 
1691
1655
  ```typescript
1692
- await client.empathicVoice.customVoices.createCustomVoice({
1693
- name: "name",
1694
- baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1695
- parameterModel: "20241004-11parameter",
1656
+ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1657
+ 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>",
1658
+ versionDescription: "This is an updated version of the Weather Assistant Prompt.",
1696
1659
  });
1697
1660
  ```
1698
1661
 
@@ -1709,7 +1672,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
1709
1672
  <dl>
1710
1673
  <dd>
1711
1674
 
1712
- **request:** `Hume.PostedCustomVoice`
1675
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1713
1676
 
1714
1677
  </dd>
1715
1678
  </dl>
@@ -1717,7 +1680,15 @@ await client.empathicVoice.customVoices.createCustomVoice({
1717
1680
  <dl>
1718
1681
  <dd>
1719
1682
 
1720
- **requestOptions:** `CustomVoices.RequestOptions`
1683
+ **request:** `Hume.empathicVoice.PostedPromptVersion`
1684
+
1685
+ </dd>
1686
+ </dl>
1687
+
1688
+ <dl>
1689
+ <dd>
1690
+
1691
+ **requestOptions:** `Prompts.RequestOptions`
1721
1692
 
1722
1693
  </dd>
1723
1694
  </dl>
@@ -1728,7 +1699,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
1728
1699
  </dl>
1729
1700
  </details>
1730
1701
 
1731
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
1702
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1732
1703
  <dl>
1733
1704
  <dd>
1734
1705
 
@@ -1740,9 +1711,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
1740
1711
  <dl>
1741
1712
  <dd>
1742
1713
 
1743
- Fetches a specific **Custom Voice** by ID.
1714
+ Deletes a **Prompt** and its versions.
1744
1715
 
1745
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1716
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1746
1717
 
1747
1718
  </dd>
1748
1719
  </dl>
@@ -1758,7 +1729,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1758
1729
  <dd>
1759
1730
 
1760
1731
  ```typescript
1761
- await client.empathicVoice.customVoices.getCustomVoice("id");
1732
+ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1762
1733
  ```
1763
1734
 
1764
1735
  </dd>
@@ -1774,7 +1745,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1774
1745
  <dl>
1775
1746
  <dd>
1776
1747
 
1777
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1748
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1778
1749
 
1779
1750
  </dd>
1780
1751
  </dl>
@@ -1782,7 +1753,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1782
1753
  <dl>
1783
1754
  <dd>
1784
1755
 
1785
- **requestOptions:** `CustomVoices.RequestOptions`
1756
+ **requestOptions:** `Prompts.RequestOptions`
1786
1757
 
1787
1758
  </dd>
1788
1759
  </dl>
@@ -1793,7 +1764,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1793
1764
  </dl>
1794
1765
  </details>
1795
1766
 
1796
- <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>
1767
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1797
1768
  <dl>
1798
1769
  <dd>
1799
1770
 
@@ -1805,9 +1776,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
1805
1776
  <dl>
1806
1777
  <dd>
1807
1778
 
1808
- Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
1779
+ Updates the name of a **Prompt**.
1809
1780
 
1810
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1781
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1811
1782
 
1812
1783
  </dd>
1813
1784
  </dl>
@@ -1823,10 +1794,8 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1823
1794
  <dd>
1824
1795
 
1825
1796
  ```typescript
1826
- await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1827
- name: "name",
1828
- baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
1829
- parameterModel: "20241004-11parameter",
1797
+ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1798
+ name: "Updated Weather Assistant Prompt Name",
1830
1799
  });
1831
1800
  ```
1832
1801
 
@@ -1843,7 +1812,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1843
1812
  <dl>
1844
1813
  <dd>
1845
1814
 
1846
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1815
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1847
1816
 
1848
1817
  </dd>
1849
1818
  </dl>
@@ -1851,7 +1820,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1851
1820
  <dl>
1852
1821
  <dd>
1853
1822
 
1854
- **request:** `Hume.PostedCustomVoice`
1823
+ **request:** `Hume.empathicVoice.PostedPromptName`
1855
1824
 
1856
1825
  </dd>
1857
1826
  </dl>
@@ -1859,7 +1828,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1859
1828
  <dl>
1860
1829
  <dd>
1861
1830
 
1862
- **requestOptions:** `CustomVoices.RequestOptions`
1831
+ **requestOptions:** `Prompts.RequestOptions`
1863
1832
 
1864
1833
  </dd>
1865
1834
  </dl>
@@ -1870,7 +1839,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1870
1839
  </dl>
1871
1840
  </details>
1872
1841
 
1873
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
1842
+ <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>
1874
1843
  <dl>
1875
1844
  <dd>
1876
1845
 
@@ -1882,9 +1851,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
1882
1851
  <dl>
1883
1852
  <dd>
1884
1853
 
1885
- Deletes a **Custom Voice** and its versions.
1854
+ Fetches a specified version of a **Prompt**.
1886
1855
 
1887
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1856
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1888
1857
 
1889
1858
  </dd>
1890
1859
  </dl>
@@ -1900,7 +1869,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1900
1869
  <dd>
1901
1870
 
1902
1871
  ```typescript
1903
- await client.empathicVoice.customVoices.deleteCustomVoice("id");
1872
+ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1904
1873
  ```
1905
1874
 
1906
1875
  </dd>
@@ -1916,7 +1885,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
1916
1885
  <dl>
1917
1886
  <dd>
1918
1887
 
1919
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1888
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1920
1889
 
1921
1890
  </dd>
1922
1891
  </dl>
@@ -1924,7 +1893,21 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
1924
1893
  <dl>
1925
1894
  <dd>
1926
1895
 
1927
- **requestOptions:** `CustomVoices.RequestOptions`
1896
+ **version:** `number`
1897
+
1898
+ Version number for a Prompt.
1899
+
1900
+ 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.
1901
+
1902
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1903
+
1904
+ </dd>
1905
+ </dl>
1906
+
1907
+ <dl>
1908
+ <dd>
1909
+
1910
+ **requestOptions:** `Prompts.RequestOptions`
1928
1911
 
1929
1912
  </dd>
1930
1913
  </dl>
@@ -1935,7 +1918,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
1935
1918
  </dl>
1936
1919
  </details>
1937
1920
 
1938
- <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
1921
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1939
1922
  <dl>
1940
1923
  <dd>
1941
1924
 
@@ -1947,9 +1930,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
1947
1930
  <dl>
1948
1931
  <dd>
1949
1932
 
1950
- Updates the name of a **Custom Voice**.
1933
+ Deletes a specified version of a **Prompt**.
1951
1934
 
1952
- Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
1935
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
1953
1936
 
1954
1937
  </dd>
1955
1938
  </dl>
@@ -1965,9 +1948,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
1965
1948
  <dd>
1966
1949
 
1967
1950
  ```typescript
1968
- await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
1969
- name: "name",
1970
- });
1951
+ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1971
1952
  ```
1972
1953
 
1973
1954
  </dd>
@@ -1983,7 +1964,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
1983
1964
  <dl>
1984
1965
  <dd>
1985
1966
 
1986
- **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
1967
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1987
1968
 
1988
1969
  </dd>
1989
1970
  </dl>
@@ -1991,7 +1972,13 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
1991
1972
  <dl>
1992
1973
  <dd>
1993
1974
 
1994
- **request:** `Hume.empathicVoice.PostedCustomVoiceName`
1975
+ **version:** `number`
1976
+
1977
+ Version number for a Prompt.
1978
+
1979
+ 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.
1980
+
1981
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1995
1982
 
1996
1983
  </dd>
1997
1984
  </dl>
@@ -1999,7 +1986,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
1999
1986
  <dl>
2000
1987
  <dd>
2001
1988
 
2002
- **requestOptions:** `CustomVoices.RequestOptions`
1989
+ **requestOptions:** `Prompts.RequestOptions`
2003
1990
 
2004
1991
  </dd>
2005
1992
  </dl>
@@ -2010,9 +1997,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
2010
1997
  </dl>
2011
1998
  </details>
2012
1999
 
2013
- ## EmpathicVoice Configs
2014
-
2015
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
2000
+ <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>
2016
2001
  <dl>
2017
2002
  <dd>
2018
2003
 
@@ -2024,9 +2009,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
2024
2009
  <dl>
2025
2010
  <dd>
2026
2011
 
2027
- Fetches a paginated list of **Configs**.
2012
+ Updates the description of a **Prompt**.
2028
2013
 
2029
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2014
+ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
2030
2015
 
2031
2016
  </dd>
2032
2017
  </dl>
@@ -2042,9 +2027,8 @@ For more details on configuration options and how to configure EVI, see our [con
2042
2027
  <dd>
2043
2028
 
2044
2029
  ```typescript
2045
- await client.empathicVoice.configs.listConfigs({
2046
- pageNumber: 0,
2047
- pageSize: 1,
2030
+ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
2031
+ versionDescription: "This is an updated version_description.",
2048
2032
  });
2049
2033
  ```
2050
2034
 
@@ -2061,7 +2045,7 @@ await client.empathicVoice.configs.listConfigs({
2061
2045
  <dl>
2062
2046
  <dd>
2063
2047
 
2064
- **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
2048
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2065
2049
 
2066
2050
  </dd>
2067
2051
  </dl>
@@ -2069,7 +2053,29 @@ await client.empathicVoice.configs.listConfigs({
2069
2053
  <dl>
2070
2054
  <dd>
2071
2055
 
2072
- **requestOptions:** `Configs.RequestOptions`
2056
+ **version:** `number`
2057
+
2058
+ Version number for a Prompt.
2059
+
2060
+ 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.
2061
+
2062
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2063
+
2064
+ </dd>
2065
+ </dl>
2066
+
2067
+ <dl>
2068
+ <dd>
2069
+
2070
+ **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
2071
+
2072
+ </dd>
2073
+ </dl>
2074
+
2075
+ <dl>
2076
+ <dd>
2077
+
2078
+ **requestOptions:** `Prompts.RequestOptions`
2073
2079
 
2074
2080
  </dd>
2075
2081
  </dl>
@@ -2080,7 +2086,9 @@ await client.empathicVoice.configs.listConfigs({
2080
2086
  </dl>
2081
2087
  </details>
2082
2088
 
2083
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
2089
+ ## EmpathicVoice CustomVoices
2090
+
2091
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
2084
2092
  <dl>
2085
2093
  <dd>
2086
2094
 
@@ -2092,9 +2100,9 @@ await client.empathicVoice.configs.listConfigs({
2092
2100
  <dl>
2093
2101
  <dd>
2094
2102
 
2095
- Creates a **Config** which can be applied to EVI.
2103
+ Fetches a paginated list of **Custom Voices**.
2096
2104
 
2097
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2105
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2098
2106
 
2099
2107
  </dd>
2100
2108
  </dl>
@@ -2110,37 +2118,7 @@ For more details on configuration options and how to configure EVI, see our [con
2110
2118
  <dd>
2111
2119
 
2112
2120
  ```typescript
2113
- await client.empathicVoice.configs.createConfig({
2114
- name: "Weather Assistant Config",
2115
- prompt: {
2116
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2117
- version: 0,
2118
- },
2119
- eviVersion: "2",
2120
- voice: {
2121
- provider: Hume.PostedVoiceProvider.HumeAi,
2122
- name: "SAMPLE VOICE",
2123
- },
2124
- languageModel: {
2125
- modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2126
- modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2127
- temperature: 1,
2128
- },
2129
- eventMessages: {
2130
- onNewChat: {
2131
- enabled: false,
2132
- text: "",
2133
- },
2134
- onInactivityTimeout: {
2135
- enabled: false,
2136
- text: "",
2137
- },
2138
- onMaxDurationTimeout: {
2139
- enabled: false,
2140
- text: "",
2141
- },
2142
- },
2143
- });
2121
+ await client.empathicVoice.customVoices.listCustomVoices();
2144
2122
  ```
2145
2123
 
2146
2124
  </dd>
@@ -2156,7 +2134,7 @@ await client.empathicVoice.configs.createConfig({
2156
2134
  <dl>
2157
2135
  <dd>
2158
2136
 
2159
- **request:** `Hume.empathicVoice.PostedConfig`
2137
+ **request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
2160
2138
 
2161
2139
  </dd>
2162
2140
  </dl>
@@ -2164,7 +2142,7 @@ await client.empathicVoice.configs.createConfig({
2164
2142
  <dl>
2165
2143
  <dd>
2166
2144
 
2167
- **requestOptions:** `Configs.RequestOptions`
2145
+ **requestOptions:** `CustomVoices.RequestOptions`
2168
2146
 
2169
2147
  </dd>
2170
2148
  </dl>
@@ -2175,7 +2153,7 @@ await client.empathicVoice.configs.createConfig({
2175
2153
  </dl>
2176
2154
  </details>
2177
2155
 
2178
- <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>
2156
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
2179
2157
  <dl>
2180
2158
  <dd>
2181
2159
 
@@ -2187,9 +2165,9 @@ await client.empathicVoice.configs.createConfig({
2187
2165
  <dl>
2188
2166
  <dd>
2189
2167
 
2190
- Fetches a list of a **Config's** versions.
2168
+ Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
2191
2169
 
2192
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2170
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2193
2171
 
2194
2172
  </dd>
2195
2173
  </dl>
@@ -2205,7 +2183,11 @@ For more details on configuration options and how to configure EVI, see our [con
2205
2183
  <dd>
2206
2184
 
2207
2185
  ```typescript
2208
- await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2186
+ await client.empathicVoice.customVoices.createCustomVoice({
2187
+ name: "name",
2188
+ baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
2189
+ parameterModel: "20241004-11parameter",
2190
+ });
2209
2191
  ```
2210
2192
 
2211
2193
  </dd>
@@ -2221,7 +2203,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2221
2203
  <dl>
2222
2204
  <dd>
2223
2205
 
2224
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2206
+ **request:** `Hume.PostedCustomVoice`
2225
2207
 
2226
2208
  </dd>
2227
2209
  </dl>
@@ -2229,15 +2211,72 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2229
2211
  <dl>
2230
2212
  <dd>
2231
2213
 
2232
- **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
2214
+ **requestOptions:** `CustomVoices.RequestOptions`
2215
+
2216
+ </dd>
2217
+ </dl>
2218
+ </dd>
2219
+ </dl>
2233
2220
 
2234
2221
  </dd>
2235
2222
  </dl>
2223
+ </details>
2224
+
2225
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
2226
+ <dl>
2227
+ <dd>
2228
+
2229
+ #### 📝 Description
2236
2230
 
2237
2231
  <dl>
2238
2232
  <dd>
2239
2233
 
2240
- **requestOptions:** `Configs.RequestOptions`
2234
+ <dl>
2235
+ <dd>
2236
+
2237
+ Fetches a specific **Custom Voice** by ID.
2238
+
2239
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2240
+
2241
+ </dd>
2242
+ </dl>
2243
+ </dd>
2244
+ </dl>
2245
+
2246
+ #### 🔌 Usage
2247
+
2248
+ <dl>
2249
+ <dd>
2250
+
2251
+ <dl>
2252
+ <dd>
2253
+
2254
+ ```typescript
2255
+ await client.empathicVoice.customVoices.getCustomVoice("id");
2256
+ ```
2257
+
2258
+ </dd>
2259
+ </dl>
2260
+ </dd>
2261
+ </dl>
2262
+
2263
+ #### ⚙️ Parameters
2264
+
2265
+ <dl>
2266
+ <dd>
2267
+
2268
+ <dl>
2269
+ <dd>
2270
+
2271
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2272
+
2273
+ </dd>
2274
+ </dl>
2275
+
2276
+ <dl>
2277
+ <dd>
2278
+
2279
+ **requestOptions:** `CustomVoices.RequestOptions`
2241
2280
 
2242
2281
  </dd>
2243
2282
  </dl>
@@ -2248,7 +2287,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2248
2287
  </dl>
2249
2288
  </details>
2250
2289
 
2251
- <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>
2290
+ <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>
2252
2291
  <dl>
2253
2292
  <dd>
2254
2293
 
@@ -2260,9 +2299,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
2260
2299
  <dl>
2261
2300
  <dd>
2262
2301
 
2263
- Updates a **Config** by creating a new version of the **Config**.
2302
+ Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
2264
2303
 
2265
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2304
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2266
2305
 
2267
2306
  </dd>
2268
2307
  </dl>
@@ -2278,39 +2317,10 @@ For more details on configuration options and how to configure EVI, see our [con
2278
2317
  <dd>
2279
2318
 
2280
2319
  ```typescript
2281
- await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2282
- versionDescription: "This is an updated version of the Weather Assistant Config.",
2283
- eviVersion: "2",
2284
- prompt: {
2285
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2286
- version: 0,
2287
- },
2288
- voice: {
2289
- provider: Hume.PostedVoiceProvider.HumeAi,
2290
- name: "ITO",
2291
- },
2292
- languageModel: {
2293
- modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2294
- modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2295
- temperature: 1,
2296
- },
2297
- ellmModel: {
2298
- allowShortResponses: true,
2299
- },
2300
- eventMessages: {
2301
- onNewChat: {
2302
- enabled: false,
2303
- text: "",
2304
- },
2305
- onInactivityTimeout: {
2306
- enabled: false,
2307
- text: "",
2308
- },
2309
- onMaxDurationTimeout: {
2310
- enabled: false,
2311
- text: "",
2312
- },
2313
- },
2320
+ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
2321
+ name: "name",
2322
+ baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
2323
+ parameterModel: "20241004-11parameter",
2314
2324
  });
2315
2325
  ```
2316
2326
 
@@ -2327,7 +2337,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2327
2337
  <dl>
2328
2338
  <dd>
2329
2339
 
2330
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2340
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2331
2341
 
2332
2342
  </dd>
2333
2343
  </dl>
@@ -2335,7 +2345,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2335
2345
  <dl>
2336
2346
  <dd>
2337
2347
 
2338
- **request:** `Hume.empathicVoice.PostedConfigVersion`
2348
+ **request:** `Hume.PostedCustomVoice`
2339
2349
 
2340
2350
  </dd>
2341
2351
  </dl>
@@ -2343,7 +2353,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2343
2353
  <dl>
2344
2354
  <dd>
2345
2355
 
2346
- **requestOptions:** `Configs.RequestOptions`
2356
+ **requestOptions:** `CustomVoices.RequestOptions`
2347
2357
 
2348
2358
  </dd>
2349
2359
  </dl>
@@ -2354,7 +2364,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2354
2364
  </dl>
2355
2365
  </details>
2356
2366
 
2357
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
2367
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
2358
2368
  <dl>
2359
2369
  <dd>
2360
2370
 
@@ -2366,9 +2376,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2366
2376
  <dl>
2367
2377
  <dd>
2368
2378
 
2369
- Deletes a **Config** and its versions.
2379
+ Deletes a **Custom Voice** and its versions.
2370
2380
 
2371
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2381
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2372
2382
 
2373
2383
  </dd>
2374
2384
  </dl>
@@ -2384,7 +2394,7 @@ For more details on configuration options and how to configure EVI, see our [con
2384
2394
  <dd>
2385
2395
 
2386
2396
  ```typescript
2387
- await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2397
+ await client.empathicVoice.customVoices.deleteCustomVoice("id");
2388
2398
  ```
2389
2399
 
2390
2400
  </dd>
@@ -2400,7 +2410,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2400
2410
  <dl>
2401
2411
  <dd>
2402
2412
 
2403
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2413
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2404
2414
 
2405
2415
  </dd>
2406
2416
  </dl>
@@ -2408,7 +2418,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2408
2418
  <dl>
2409
2419
  <dd>
2410
2420
 
2411
- **requestOptions:** `Configs.RequestOptions`
2421
+ **requestOptions:** `CustomVoices.RequestOptions`
2412
2422
 
2413
2423
  </dd>
2414
2424
  </dl>
@@ -2419,7 +2429,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2419
2429
  </dl>
2420
2430
  </details>
2421
2431
 
2422
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2432
+ <details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
2423
2433
  <dl>
2424
2434
  <dd>
2425
2435
 
@@ -2431,9 +2441,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2431
2441
  <dl>
2432
2442
  <dd>
2433
2443
 
2434
- Updates the name of a **Config**.
2444
+ Updates the name of a **Custom Voice**.
2435
2445
 
2436
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2446
+ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
2437
2447
 
2438
2448
  </dd>
2439
2449
  </dl>
@@ -2449,8 +2459,8 @@ For more details on configuration options and how to configure EVI, see our [con
2449
2459
  <dd>
2450
2460
 
2451
2461
  ```typescript
2452
- await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2453
- name: "Updated Weather Assistant Config Name",
2462
+ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
2463
+ name: "name",
2454
2464
  });
2455
2465
  ```
2456
2466
 
@@ -2467,7 +2477,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2467
2477
  <dl>
2468
2478
  <dd>
2469
2479
 
2470
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2480
+ **id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
2471
2481
 
2472
2482
  </dd>
2473
2483
  </dl>
@@ -2475,7 +2485,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2475
2485
  <dl>
2476
2486
  <dd>
2477
2487
 
2478
- **request:** `Hume.empathicVoice.PostedConfigName`
2488
+ **request:** `Hume.empathicVoice.PostedCustomVoiceName`
2479
2489
 
2480
2490
  </dd>
2481
2491
  </dl>
@@ -2483,7 +2493,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2483
2493
  <dl>
2484
2494
  <dd>
2485
2495
 
2486
- **requestOptions:** `Configs.RequestOptions`
2496
+ **requestOptions:** `CustomVoices.RequestOptions`
2487
2497
 
2488
2498
  </dd>
2489
2499
  </dl>
@@ -2494,7 +2504,9 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2494
2504
  </dl>
2495
2505
  </details>
2496
2506
 
2497
- <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>
2507
+ ## EmpathicVoice Configs
2508
+
2509
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
2498
2510
  <dl>
2499
2511
  <dd>
2500
2512
 
@@ -2506,7 +2518,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2506
2518
  <dl>
2507
2519
  <dd>
2508
2520
 
2509
- Fetches a specified version of a **Config**.
2521
+ Fetches a paginated list of **Configs**.
2510
2522
 
2511
2523
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2512
2524
 
@@ -2524,7 +2536,10 @@ For more details on configuration options and how to configure EVI, see our [con
2524
2536
  <dd>
2525
2537
 
2526
2538
  ```typescript
2527
- await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2539
+ await client.empathicVoice.configs.listConfigs({
2540
+ pageNumber: 0,
2541
+ pageSize: 1,
2542
+ });
2528
2543
  ```
2529
2544
 
2530
2545
  </dd>
@@ -2540,7 +2555,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2540
2555
  <dl>
2541
2556
  <dd>
2542
2557
 
2543
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2558
+ **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
2544
2559
 
2545
2560
  </dd>
2546
2561
  </dl>
@@ -2548,13 +2563,94 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2548
2563
  <dl>
2549
2564
  <dd>
2550
2565
 
2551
- **version:** `number`
2566
+ **requestOptions:** `Configs.RequestOptions`
2552
2567
 
2553
- Version number for a Config.
2568
+ </dd>
2569
+ </dl>
2570
+ </dd>
2571
+ </dl>
2554
2572
 
2555
- 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.
2573
+ </dd>
2574
+ </dl>
2575
+ </details>
2556
2576
 
2557
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2577
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
2578
+ <dl>
2579
+ <dd>
2580
+
2581
+ #### 📝 Description
2582
+
2583
+ <dl>
2584
+ <dd>
2585
+
2586
+ <dl>
2587
+ <dd>
2588
+
2589
+ Creates a **Config** which can be applied to EVI.
2590
+
2591
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2592
+
2593
+ </dd>
2594
+ </dl>
2595
+ </dd>
2596
+ </dl>
2597
+
2598
+ #### 🔌 Usage
2599
+
2600
+ <dl>
2601
+ <dd>
2602
+
2603
+ <dl>
2604
+ <dd>
2605
+
2606
+ ```typescript
2607
+ await client.empathicVoice.configs.createConfig({
2608
+ name: "Weather Assistant Config",
2609
+ prompt: {
2610
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2611
+ version: 0,
2612
+ },
2613
+ eviVersion: "2",
2614
+ voice: {
2615
+ provider: Hume.PostedVoiceProvider.HumeAi,
2616
+ name: "SAMPLE VOICE",
2617
+ },
2618
+ languageModel: {
2619
+ modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2620
+ modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2621
+ temperature: 1,
2622
+ },
2623
+ eventMessages: {
2624
+ onNewChat: {
2625
+ enabled: false,
2626
+ text: "",
2627
+ },
2628
+ onInactivityTimeout: {
2629
+ enabled: false,
2630
+ text: "",
2631
+ },
2632
+ onMaxDurationTimeout: {
2633
+ enabled: false,
2634
+ text: "",
2635
+ },
2636
+ },
2637
+ });
2638
+ ```
2639
+
2640
+ </dd>
2641
+ </dl>
2642
+ </dd>
2643
+ </dl>
2644
+
2645
+ #### ⚙️ Parameters
2646
+
2647
+ <dl>
2648
+ <dd>
2649
+
2650
+ <dl>
2651
+ <dd>
2652
+
2653
+ **request:** `Hume.empathicVoice.PostedConfig`
2558
2654
 
2559
2655
  </dd>
2560
2656
  </dl>
@@ -2573,7 +2669,7 @@ Version numbers are integer values representing different iterations of the Conf
2573
2669
  </dl>
2574
2670
  </details>
2575
2671
 
2576
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2672
+ <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>
2577
2673
  <dl>
2578
2674
  <dd>
2579
2675
 
@@ -2585,7 +2681,7 @@ Version numbers are integer values representing different iterations of the Conf
2585
2681
  <dl>
2586
2682
  <dd>
2587
2683
 
2588
- Deletes a specified version of a **Config**.
2684
+ Fetches a list of a **Config's** versions.
2589
2685
 
2590
2686
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2591
2687
 
@@ -2603,7 +2699,7 @@ For more details on configuration options and how to configure EVI, see our [con
2603
2699
  <dd>
2604
2700
 
2605
2701
  ```typescript
2606
- await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2702
+ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2607
2703
  ```
2608
2704
 
2609
2705
  </dd>
@@ -2627,13 +2723,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2627
2723
  <dl>
2628
2724
  <dd>
2629
2725
 
2630
- **version:** `number`
2631
-
2632
- Version number for a Config.
2633
-
2634
- 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.
2635
-
2636
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2726
+ **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
2637
2727
 
2638
2728
  </dd>
2639
2729
  </dl>
@@ -2652,7 +2742,7 @@ Version numbers are integer values representing different iterations of the Conf
2652
2742
  </dl>
2653
2743
  </details>
2654
2744
 
2655
- <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>
2745
+ <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>
2656
2746
  <dl>
2657
2747
  <dd>
2658
2748
 
@@ -2664,7 +2754,7 @@ Version numbers are integer values representing different iterations of the Conf
2664
2754
  <dl>
2665
2755
  <dd>
2666
2756
 
2667
- Updates the description of a **Config**.
2757
+ Updates a **Config** by creating a new version of the **Config**.
2668
2758
 
2669
2759
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2670
2760
 
@@ -2682,8 +2772,39 @@ For more details on configuration options and how to configure EVI, see our [con
2682
2772
  <dd>
2683
2773
 
2684
2774
  ```typescript
2685
- await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2686
- versionDescription: "This is an updated version_description.",
2775
+ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2776
+ versionDescription: "This is an updated version of the Weather Assistant Config.",
2777
+ eviVersion: "2",
2778
+ prompt: {
2779
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2780
+ version: 0,
2781
+ },
2782
+ voice: {
2783
+ provider: Hume.PostedVoiceProvider.HumeAi,
2784
+ name: "ITO",
2785
+ },
2786
+ languageModel: {
2787
+ modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
2788
+ modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
2789
+ temperature: 1,
2790
+ },
2791
+ ellmModel: {
2792
+ allowShortResponses: true,
2793
+ },
2794
+ eventMessages: {
2795
+ onNewChat: {
2796
+ enabled: false,
2797
+ text: "",
2798
+ },
2799
+ onInactivityTimeout: {
2800
+ enabled: false,
2801
+ text: "",
2802
+ },
2803
+ onMaxDurationTimeout: {
2804
+ enabled: false,
2805
+ text: "",
2806
+ },
2807
+ },
2687
2808
  });
2688
2809
  ```
2689
2810
 
@@ -2708,21 +2829,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
2708
2829
  <dl>
2709
2830
  <dd>
2710
2831
 
2711
- **version:** `number`
2712
-
2713
- Version number for a Config.
2714
-
2715
- 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.
2716
-
2717
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2718
-
2719
- </dd>
2720
- </dl>
2721
-
2722
- <dl>
2723
- <dd>
2724
-
2725
- **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2832
+ **request:** `Hume.empathicVoice.PostedConfigVersion`
2726
2833
 
2727
2834
  </dd>
2728
2835
  </dl>
@@ -2741,9 +2848,7 @@ Version numbers are integer values representing different iterations of the Conf
2741
2848
  </dl>
2742
2849
  </details>
2743
2850
 
2744
- ## EmpathicVoice Chats
2745
-
2746
- <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>
2851
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
2747
2852
  <dl>
2748
2853
  <dd>
2749
2854
 
@@ -2755,7 +2860,9 @@ Version numbers are integer values representing different iterations of the Conf
2755
2860
  <dl>
2756
2861
  <dd>
2757
2862
 
2758
- Fetches a paginated list of **Chats**.
2863
+ Deletes a **Config** and its versions.
2864
+
2865
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2759
2866
 
2760
2867
  </dd>
2761
2868
  </dl>
@@ -2771,11 +2878,7 @@ Fetches a paginated list of **Chats**.
2771
2878
  <dd>
2772
2879
 
2773
2880
  ```typescript
2774
- await client.empathicVoice.chats.listChats({
2775
- pageNumber: 0,
2776
- pageSize: 1,
2777
- ascendingOrder: true,
2778
- });
2881
+ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2779
2882
  ```
2780
2883
 
2781
2884
  </dd>
@@ -2791,7 +2894,7 @@ await client.empathicVoice.chats.listChats({
2791
2894
  <dl>
2792
2895
  <dd>
2793
2896
 
2794
- **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2897
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2795
2898
 
2796
2899
  </dd>
2797
2900
  </dl>
@@ -2799,7 +2902,7 @@ await client.empathicVoice.chats.listChats({
2799
2902
  <dl>
2800
2903
  <dd>
2801
2904
 
2802
- **requestOptions:** `Chats.RequestOptions`
2905
+ **requestOptions:** `Configs.RequestOptions`
2803
2906
 
2804
2907
  </dd>
2805
2908
  </dl>
@@ -2810,7 +2913,7 @@ await client.empathicVoice.chats.listChats({
2810
2913
  </dl>
2811
2914
  </details>
2812
2915
 
2813
- <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>
2916
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2814
2917
  <dl>
2815
2918
  <dd>
2816
2919
 
@@ -2822,7 +2925,9 @@ await client.empathicVoice.chats.listChats({
2822
2925
  <dl>
2823
2926
  <dd>
2824
2927
 
2825
- Fetches a paginated list of **Chat** events.
2928
+ Updates the name of a **Config**.
2929
+
2930
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2826
2931
 
2827
2932
  </dd>
2828
2933
  </dl>
@@ -2838,10 +2943,8 @@ Fetches a paginated list of **Chat** events.
2838
2943
  <dd>
2839
2944
 
2840
2945
  ```typescript
2841
- await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2842
- pageNumber: 0,
2843
- pageSize: 3,
2844
- ascendingOrder: true,
2946
+ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2947
+ name: "Updated Weather Assistant Config Name",
2845
2948
  });
2846
2949
  ```
2847
2950
 
@@ -2858,7 +2961,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2858
2961
  <dl>
2859
2962
  <dd>
2860
2963
 
2861
- **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2964
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2862
2965
 
2863
2966
  </dd>
2864
2967
  </dl>
@@ -2866,7 +2969,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2866
2969
  <dl>
2867
2970
  <dd>
2868
2971
 
2869
- **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2972
+ **request:** `Hume.empathicVoice.PostedConfigName`
2870
2973
 
2871
2974
  </dd>
2872
2975
  </dl>
@@ -2874,7 +2977,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2874
2977
  <dl>
2875
2978
  <dd>
2876
2979
 
2877
- **requestOptions:** `Chats.RequestOptions`
2980
+ **requestOptions:** `Configs.RequestOptions`
2878
2981
 
2879
2982
  </dd>
2880
2983
  </dl>
@@ -2885,7 +2988,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2885
2988
  </dl>
2886
2989
  </details>
2887
2990
 
2888
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2991
+ <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>
2889
2992
  <dl>
2890
2993
  <dd>
2891
2994
 
@@ -2897,7 +3000,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
2897
3000
  <dl>
2898
3001
  <dd>
2899
3002
 
2900
- 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).
3003
+ Fetches a specified version of a **Config**.
3004
+
3005
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2901
3006
 
2902
3007
  </dd>
2903
3008
  </dl>
@@ -2913,7 +3018,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
2913
3018
  <dd>
2914
3019
 
2915
3020
  ```typescript
2916
- await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
3021
+ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2917
3022
  ```
2918
3023
 
2919
3024
  </dd>
@@ -2929,7 +3034,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2929
3034
  <dl>
2930
3035
  <dd>
2931
3036
 
2932
- **id:** `string` — Identifier for a chat. Formatted as a UUID.
3037
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2933
3038
 
2934
3039
  </dd>
2935
3040
  </dl>
@@ -2937,7 +3042,21 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2937
3042
  <dl>
2938
3043
  <dd>
2939
3044
 
2940
- **requestOptions:** `Chats.RequestOptions`
3045
+ **version:** `number`
3046
+
3047
+ Version number for a Config.
3048
+
3049
+ 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.
3050
+
3051
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
3052
+
3053
+ </dd>
3054
+ </dl>
3055
+
3056
+ <dl>
3057
+ <dd>
3058
+
3059
+ **requestOptions:** `Configs.RequestOptions`
2941
3060
 
2942
3061
  </dd>
2943
3062
  </dl>
@@ -2948,9 +3067,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2948
3067
  </dl>
2949
3068
  </details>
2950
3069
 
2951
- ## EmpathicVoice ChatGroups
2952
-
2953
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
3070
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2954
3071
  <dl>
2955
3072
  <dd>
2956
3073
 
@@ -2962,7 +3079,9 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2962
3079
  <dl>
2963
3080
  <dd>
2964
3081
 
2965
- Fetches a paginated list of **Chat Groups**.
3082
+ Deletes a specified version of a **Config**.
3083
+
3084
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
2966
3085
 
2967
3086
  </dd>
2968
3087
  </dl>
@@ -2978,12 +3097,7 @@ Fetches a paginated list of **Chat Groups**.
2978
3097
  <dd>
2979
3098
 
2980
3099
  ```typescript
2981
- await client.empathicVoice.chatGroups.listChatGroups({
2982
- pageNumber: 0,
2983
- pageSize: 1,
2984
- ascendingOrder: true,
2985
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2986
- });
3100
+ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2987
3101
  ```
2988
3102
 
2989
3103
  </dd>
@@ -2999,7 +3113,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
2999
3113
  <dl>
3000
3114
  <dd>
3001
3115
 
3002
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
3116
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
3003
3117
 
3004
3118
  </dd>
3005
3119
  </dl>
@@ -3007,7 +3121,21 @@ await client.empathicVoice.chatGroups.listChatGroups({
3007
3121
  <dl>
3008
3122
  <dd>
3009
3123
 
3010
- **requestOptions:** `ChatGroups.RequestOptions`
3124
+ **version:** `number`
3125
+
3126
+ Version number for a Config.
3127
+
3128
+ 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.
3129
+
3130
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
3131
+
3132
+ </dd>
3133
+ </dl>
3134
+
3135
+ <dl>
3136
+ <dd>
3137
+
3138
+ **requestOptions:** `Configs.RequestOptions`
3011
3139
 
3012
3140
  </dd>
3013
3141
  </dl>
@@ -3018,7 +3146,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
3018
3146
  </dl>
3019
3147
  </details>
3020
3148
 
3021
- <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>
3149
+ <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>
3022
3150
  <dl>
3023
3151
  <dd>
3024
3152
 
@@ -3030,7 +3158,9 @@ await client.empathicVoice.chatGroups.listChatGroups({
3030
3158
  <dl>
3031
3159
  <dd>
3032
3160
 
3033
- Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
3161
+ Updates the description of a **Config**.
3162
+
3163
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
3034
3164
 
3035
3165
  </dd>
3036
3166
  </dl>
@@ -3046,10 +3176,8 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
3046
3176
  <dd>
3047
3177
 
3048
3178
  ```typescript
3049
- await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3050
- pageNumber: 0,
3051
- pageSize: 1,
3052
- ascendingOrder: true,
3179
+ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
3180
+ versionDescription: "This is an updated version_description.",
3053
3181
  });
3054
3182
  ```
3055
3183
 
@@ -3066,7 +3194,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3066
3194
  <dl>
3067
3195
  <dd>
3068
3196
 
3069
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3197
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
3070
3198
 
3071
3199
  </dd>
3072
3200
  </dl>
@@ -3074,7 +3202,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3074
3202
  <dl>
3075
3203
  <dd>
3076
3204
 
3077
- **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
3205
+ **version:** `number`
3206
+
3207
+ Version number for a Config.
3208
+
3209
+ 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.
3210
+
3211
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
3078
3212
 
3079
3213
  </dd>
3080
3214
  </dl>
@@ -3082,7 +3216,15 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3082
3216
  <dl>
3083
3217
  <dd>
3084
3218
 
3085
- **requestOptions:** `ChatGroups.RequestOptions`
3219
+ **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
3220
+
3221
+ </dd>
3222
+ </dl>
3223
+
3224
+ <dl>
3225
+ <dd>
3226
+
3227
+ **requestOptions:** `Configs.RequestOptions`
3086
3228
 
3087
3229
  </dd>
3088
3230
  </dl>
@@ -3093,7 +3235,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3093
3235
  </dl>
3094
3236
  </details>
3095
3237
 
3096
- <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>
3238
+ ## EmpathicVoice Chats
3239
+
3240
+ <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>
3097
3241
  <dl>
3098
3242
  <dd>
3099
3243
 
@@ -3105,7 +3249,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3105
3249
  <dl>
3106
3250
  <dd>
3107
3251
 
3108
- Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3252
+ Fetches a paginated list of **Chats**.
3109
3253
 
3110
3254
  </dd>
3111
3255
  </dl>
@@ -3121,9 +3265,9 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3121
3265
  <dd>
3122
3266
 
3123
3267
  ```typescript
3124
- await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3268
+ await client.empathicVoice.chats.listChats({
3125
3269
  pageNumber: 0,
3126
- pageSize: 3,
3270
+ pageSize: 1,
3127
3271
  ascendingOrder: true,
3128
3272
  });
3129
3273
  ```
@@ -3141,15 +3285,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3141
3285
  <dl>
3142
3286
  <dd>
3143
3287
 
3144
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3145
-
3146
- </dd>
3147
- </dl>
3148
-
3149
- <dl>
3150
- <dd>
3151
-
3152
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
3288
+ **request:** `Hume.empathicVoice.ChatsListChatsRequest`
3153
3289
 
3154
3290
  </dd>
3155
3291
  </dl>
@@ -3157,7 +3293,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3157
3293
  <dl>
3158
3294
  <dd>
3159
3295
 
3160
- **requestOptions:** `ChatGroups.RequestOptions`
3296
+ **requestOptions:** `Chats.RequestOptions`
3161
3297
 
3162
3298
  </dd>
3163
3299
  </dl>
@@ -3168,7 +3304,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3168
3304
  </dl>
3169
3305
  </details>
3170
3306
 
3171
- <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>
3307
+ <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>
3172
3308
  <dl>
3173
3309
  <dd>
3174
3310
 
@@ -3180,7 +3316,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
3180
3316
  <dl>
3181
3317
  <dd>
3182
3318
 
3183
- 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).
3319
+ Fetches a paginated list of **Chat** events.
3184
3320
 
3185
3321
  </dd>
3186
3322
  </dl>
@@ -3196,9 +3332,9 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
3196
3332
  <dd>
3197
3333
 
3198
3334
  ```typescript
3199
- await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
3335
+ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
3200
3336
  pageNumber: 0,
3201
- pageSize: 10,
3337
+ pageSize: 3,
3202
3338
  ascendingOrder: true,
3203
3339
  });
3204
3340
  ```
@@ -3216,7 +3352,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3216
3352
  <dl>
3217
3353
  <dd>
3218
3354
 
3219
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3355
+ **id:** `string` — Identifier for a Chat. Formatted as a UUID.
3220
3356
 
3221
3357
  </dd>
3222
3358
  </dl>
@@ -3224,7 +3360,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3224
3360
  <dl>
3225
3361
  <dd>
3226
3362
 
3227
- **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
3363
+ **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
3228
3364
 
3229
3365
  </dd>
3230
3366
  </dl>
@@ -3232,7 +3368,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3232
3368
  <dl>
3233
3369
  <dd>
3234
3370
 
3235
- **requestOptions:** `ChatGroups.RequestOptions`
3371
+ **requestOptions:** `Chats.RequestOptions`
3236
3372
 
3237
3373
  </dd>
3238
3374
  </dl>
@@ -3243,9 +3379,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3243
3379
  </dl>
3244
3380
  </details>
3245
3381
 
3246
- ## ExpressionMeasurement Batch
3247
-
3248
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
3382
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
3249
3383
  <dl>
3250
3384
  <dd>
3251
3385
 
@@ -3257,7 +3391,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3257
3391
  <dl>
3258
3392
  <dd>
3259
3393
 
3260
- Sort and filter jobs.
3394
+ 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).
3261
3395
 
3262
3396
  </dd>
3263
3397
  </dl>
@@ -3273,7 +3407,7 @@ Sort and filter jobs.
3273
3407
  <dd>
3274
3408
 
3275
3409
  ```typescript
3276
- await client.expressionMeasurement.batch.listJobs();
3410
+ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
3277
3411
  ```
3278
3412
 
3279
3413
  </dd>
@@ -3289,7 +3423,7 @@ await client.expressionMeasurement.batch.listJobs();
3289
3423
  <dl>
3290
3424
  <dd>
3291
3425
 
3292
- **request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
3426
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
3293
3427
 
3294
3428
  </dd>
3295
3429
  </dl>
@@ -3297,7 +3431,7 @@ await client.expressionMeasurement.batch.listJobs();
3297
3431
  <dl>
3298
3432
  <dd>
3299
3433
 
3300
- **requestOptions:** `Batch.RequestOptions`
3434
+ **requestOptions:** `Chats.RequestOptions`
3301
3435
 
3302
3436
  </dd>
3303
3437
  </dl>
@@ -3308,7 +3442,9 @@ await client.expressionMeasurement.batch.listJobs();
3308
3442
  </dl>
3309
3443
  </details>
3310
3444
 
3311
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
3445
+ ## EmpathicVoice ChatGroups
3446
+
3447
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
3312
3448
  <dl>
3313
3449
  <dd>
3314
3450
 
@@ -3320,7 +3456,7 @@ await client.expressionMeasurement.batch.listJobs();
3320
3456
  <dl>
3321
3457
  <dd>
3322
3458
 
3323
- Start a new measurement inference job.
3459
+ Fetches a paginated list of **Chat Groups**.
3324
3460
 
3325
3461
  </dd>
3326
3462
  </dl>
@@ -3336,9 +3472,11 @@ Start a new measurement inference job.
3336
3472
  <dd>
3337
3473
 
3338
3474
  ```typescript
3339
- await client.expressionMeasurement.batch.startInferenceJob({
3340
- urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
3341
- notify: true,
3475
+ await client.empathicVoice.chatGroups.listChatGroups({
3476
+ pageNumber: 0,
3477
+ pageSize: 1,
3478
+ ascendingOrder: true,
3479
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
3342
3480
  });
3343
3481
  ```
3344
3482
 
@@ -3355,7 +3493,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
3355
3493
  <dl>
3356
3494
  <dd>
3357
3495
 
3358
- **request:** `Hume.InferenceBaseRequest`
3496
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
3359
3497
 
3360
3498
  </dd>
3361
3499
  </dl>
@@ -3363,7 +3501,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
3363
3501
  <dl>
3364
3502
  <dd>
3365
3503
 
3366
- **requestOptions:** `Batch.RequestOptions`
3504
+ **requestOptions:** `ChatGroups.RequestOptions`
3367
3505
 
3368
3506
  </dd>
3369
3507
  </dl>
@@ -3374,7 +3512,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
3374
3512
  </dl>
3375
3513
  </details>
3376
3514
 
3377
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
3515
+ <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>
3378
3516
  <dl>
3379
3517
  <dd>
3380
3518
 
@@ -3386,7 +3524,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
3386
3524
  <dl>
3387
3525
  <dd>
3388
3526
 
3389
- Get the request details and state of a given job.
3527
+ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
3390
3528
 
3391
3529
  </dd>
3392
3530
  </dl>
@@ -3402,7 +3540,11 @@ Get the request details and state of a given job.
3402
3540
  <dd>
3403
3541
 
3404
3542
  ```typescript
3405
- await client.expressionMeasurement.batch.getJobDetails("job_id");
3543
+ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3544
+ pageNumber: 0,
3545
+ pageSize: 1,
3546
+ ascendingOrder: true,
3547
+ });
3406
3548
  ```
3407
3549
 
3408
3550
  </dd>
@@ -3418,7 +3560,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
3418
3560
  <dl>
3419
3561
  <dd>
3420
3562
 
3421
- **id:** `string` — The unique identifier for the job.
3563
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3422
3564
 
3423
3565
  </dd>
3424
3566
  </dl>
@@ -3426,7 +3568,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
3426
3568
  <dl>
3427
3569
  <dd>
3428
3570
 
3429
- **requestOptions:** `Batch.RequestOptions`
3571
+ **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
3572
+
3573
+ </dd>
3574
+ </dl>
3575
+
3576
+ <dl>
3577
+ <dd>
3578
+
3579
+ **requestOptions:** `ChatGroups.RequestOptions`
3430
3580
 
3431
3581
  </dd>
3432
3582
  </dl>
@@ -3437,7 +3587,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
3437
3587
  </dl>
3438
3588
  </details>
3439
3589
 
3440
- <details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
3590
+ <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>
3441
3591
  <dl>
3442
3592
  <dd>
3443
3593
 
@@ -3449,7 +3599,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
3449
3599
  <dl>
3450
3600
  <dd>
3451
3601
 
3452
- Get the JSON predictions of a completed inference job.
3602
+ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3453
3603
 
3454
3604
  </dd>
3455
3605
  </dl>
@@ -3465,7 +3615,11 @@ Get the JSON predictions of a completed inference job.
3465
3615
  <dd>
3466
3616
 
3467
3617
  ```typescript
3468
- await client.expressionMeasurement.batch.getJobPredictions("job_id");
3618
+ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3619
+ pageNumber: 0,
3620
+ pageSize: 3,
3621
+ ascendingOrder: true,
3622
+ });
3469
3623
  ```
3470
3624
 
3471
3625
  </dd>
@@ -3481,7 +3635,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3481
3635
  <dl>
3482
3636
  <dd>
3483
3637
 
3484
- **id:** `string` — The unique identifier for the job.
3638
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3485
3639
 
3486
3640
  </dd>
3487
3641
  </dl>
@@ -3489,7 +3643,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3489
3643
  <dl>
3490
3644
  <dd>
3491
3645
 
3492
- **requestOptions:** `Batch.RequestOptions`
3646
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
3647
+
3648
+ </dd>
3649
+ </dl>
3650
+
3651
+ <dl>
3652
+ <dd>
3653
+
3654
+ **requestOptions:** `ChatGroups.RequestOptions`
3493
3655
 
3494
3656
  </dd>
3495
3657
  </dl>
@@ -3500,7 +3662,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3500
3662
  </dl>
3501
3663
  </details>
3502
3664
 
3503
- <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>
3665
+ <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>
3504
3666
  <dl>
3505
3667
  <dd>
3506
3668
 
@@ -3512,7 +3674,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
3512
3674
  <dl>
3513
3675
  <dd>
3514
3676
 
3515
- Start a new batch inference job.
3677
+ 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).
3516
3678
 
3517
3679
  </dd>
3518
3680
  </dl>
@@ -3528,10 +3690,11 @@ Start a new batch inference job.
3528
3690
  <dd>
3529
3691
 
3530
3692
  ```typescript
3531
- await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
3532
- [fs.createReadStream("/path/to/your/file")],
3533
- {}
3534
- );
3693
+ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
3694
+ pageNumber: 0,
3695
+ pageSize: 10,
3696
+ ascendingOrder: true,
3697
+ });
3535
3698
  ```
3536
3699
 
3537
3700
  </dd>
@@ -3547,7 +3710,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
3547
3710
  <dl>
3548
3711
  <dd>
3549
3712
 
3550
- **file:** `File[] | fs.ReadStream[] | Blob[]`
3713
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3551
3714
 
3552
3715
  </dd>
3553
3716
  </dl>
@@ -3555,7 +3718,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
3555
3718
  <dl>
3556
3719
  <dd>
3557
3720
 
3558
- **request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
3721
+ **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
3559
3722
 
3560
3723
  </dd>
3561
3724
  </dl>
@@ -3563,7 +3726,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
3563
3726
  <dl>
3564
3727
  <dd>
3565
3728
 
3566
- **requestOptions:** `Batch.RequestOptions`
3729
+ **requestOptions:** `ChatGroups.RequestOptions`
3567
3730
 
3568
3731
  </dd>
3569
3732
  </dl>