hume 0.9.13 → 0.9.14
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.
- package/.mock/definition/expression-measurement/batch/__package__.yml +61 -76
- package/.mock/definition/tts/__package__.yml +31 -11
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/api/resources/tts/client/Client.js +2 -2
- package/api/resources/tts/resources/voices/client/Client.js +1 -1
- package/api/resources/tts/types/PostedTts.d.ts +10 -0
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/api/resources/tts/client/Client.js +2 -2
- package/dist/api/resources/tts/resources/voices/client/Client.js +1 -1
- package/dist/api/resources/tts/types/PostedTts.d.ts +10 -0
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/serialization/resources/tts/types/PostedTts.d.ts +1 -0
- package/dist/serialization/resources/tts/types/PostedTts.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +554 -554
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/serialization/resources/tts/types/PostedTts.d.ts +1 -0
- package/serialization/resources/tts/types/PostedTts.js +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -236,9 +236,9 @@ await client.tts.voices.create({
|
|
|
236
236
|
</dl>
|
|
237
237
|
</details>
|
|
238
238
|
|
|
239
|
-
##
|
|
239
|
+
## ExpressionMeasurement Batch
|
|
240
240
|
|
|
241
|
-
<details><summary><code>client.
|
|
241
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
242
242
|
<dl>
|
|
243
243
|
<dd>
|
|
244
244
|
|
|
@@ -250,9 +250,7 @@ await client.tts.voices.create({
|
|
|
250
250
|
<dl>
|
|
251
251
|
<dd>
|
|
252
252
|
|
|
253
|
-
|
|
254
|
-
|
|
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.
|
|
253
|
+
Sort and filter jobs.
|
|
256
254
|
|
|
257
255
|
</dd>
|
|
258
256
|
</dl>
|
|
@@ -268,10 +266,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
268
266
|
<dd>
|
|
269
267
|
|
|
270
268
|
```typescript
|
|
271
|
-
await client.
|
|
272
|
-
pageNumber: 0,
|
|
273
|
-
pageSize: 2,
|
|
274
|
-
});
|
|
269
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
275
270
|
```
|
|
276
271
|
|
|
277
272
|
</dd>
|
|
@@ -287,7 +282,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
287
282
|
<dl>
|
|
288
283
|
<dd>
|
|
289
284
|
|
|
290
|
-
**request:** `Hume.
|
|
285
|
+
**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
|
|
291
286
|
|
|
292
287
|
</dd>
|
|
293
288
|
</dl>
|
|
@@ -295,7 +290,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
295
290
|
<dl>
|
|
296
291
|
<dd>
|
|
297
292
|
|
|
298
|
-
**requestOptions:** `
|
|
293
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
299
294
|
|
|
300
295
|
</dd>
|
|
301
296
|
</dl>
|
|
@@ -306,7 +301,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
306
301
|
</dl>
|
|
307
302
|
</details>
|
|
308
303
|
|
|
309
|
-
<details><summary><code>client.
|
|
304
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
|
|
310
305
|
<dl>
|
|
311
306
|
<dd>
|
|
312
307
|
|
|
@@ -318,9 +313,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
318
313
|
<dl>
|
|
319
314
|
<dd>
|
|
320
315
|
|
|
321
|
-
|
|
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.
|
|
316
|
+
Start a new measurement inference job.
|
|
324
317
|
|
|
325
318
|
</dd>
|
|
326
319
|
</dl>
|
|
@@ -336,13 +329,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
336
329
|
<dd>
|
|
337
330
|
|
|
338
331
|
```typescript
|
|
339
|
-
await client.
|
|
340
|
-
|
|
341
|
-
|
|
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.",
|
|
332
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
333
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
334
|
+
notify: true,
|
|
346
335
|
});
|
|
347
336
|
```
|
|
348
337
|
|
|
@@ -359,7 +348,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
359
348
|
<dl>
|
|
360
349
|
<dd>
|
|
361
350
|
|
|
362
|
-
**request:** `Hume.
|
|
351
|
+
**request:** `Hume.InferenceBaseRequest`
|
|
363
352
|
|
|
364
353
|
</dd>
|
|
365
354
|
</dl>
|
|
@@ -367,7 +356,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
367
356
|
<dl>
|
|
368
357
|
<dd>
|
|
369
358
|
|
|
370
|
-
**requestOptions:** `
|
|
359
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
371
360
|
|
|
372
361
|
</dd>
|
|
373
362
|
</dl>
|
|
@@ -378,7 +367,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
378
367
|
</dl>
|
|
379
368
|
</details>
|
|
380
369
|
|
|
381
|
-
<details><summary><code>client.
|
|
370
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
|
|
382
371
|
<dl>
|
|
383
372
|
<dd>
|
|
384
373
|
|
|
@@ -390,9 +379,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
390
379
|
<dl>
|
|
391
380
|
<dd>
|
|
392
381
|
|
|
393
|
-
|
|
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.
|
|
382
|
+
Get the request details and state of a given job.
|
|
396
383
|
|
|
397
384
|
</dd>
|
|
398
385
|
</dl>
|
|
@@ -408,7 +395,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
408
395
|
<dd>
|
|
409
396
|
|
|
410
397
|
```typescript
|
|
411
|
-
await client.
|
|
398
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
412
399
|
```
|
|
413
400
|
|
|
414
401
|
</dd>
|
|
@@ -424,15 +411,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
424
411
|
<dl>
|
|
425
412
|
<dd>
|
|
426
413
|
|
|
427
|
-
**id:** `string` —
|
|
428
|
-
|
|
429
|
-
</dd>
|
|
430
|
-
</dl>
|
|
431
|
-
|
|
432
|
-
<dl>
|
|
433
|
-
<dd>
|
|
434
|
-
|
|
435
|
-
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
414
|
+
**id:** `string` — The unique identifier for the job.
|
|
436
415
|
|
|
437
416
|
</dd>
|
|
438
417
|
</dl>
|
|
@@ -440,7 +419,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
440
419
|
<dl>
|
|
441
420
|
<dd>
|
|
442
421
|
|
|
443
|
-
**requestOptions:** `
|
|
422
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
444
423
|
|
|
445
424
|
</dd>
|
|
446
425
|
</dl>
|
|
@@ -451,7 +430,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
451
430
|
</dl>
|
|
452
431
|
</details>
|
|
453
432
|
|
|
454
|
-
<details><summary><code>client.
|
|
433
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
|
|
455
434
|
<dl>
|
|
456
435
|
<dd>
|
|
457
436
|
|
|
@@ -463,9 +442,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
463
442
|
<dl>
|
|
464
443
|
<dd>
|
|
465
444
|
|
|
466
|
-
|
|
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.
|
|
445
|
+
Get the JSON predictions of a completed inference job.
|
|
469
446
|
|
|
470
447
|
</dd>
|
|
471
448
|
</dl>
|
|
@@ -481,13 +458,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
481
458
|
<dd>
|
|
482
459
|
|
|
483
460
|
```typescript
|
|
484
|
-
await client.
|
|
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.",
|
|
490
|
-
});
|
|
461
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
491
462
|
```
|
|
492
463
|
|
|
493
464
|
</dd>
|
|
@@ -503,15 +474,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
503
474
|
<dl>
|
|
504
475
|
<dd>
|
|
505
476
|
|
|
506
|
-
**id:** `string` —
|
|
507
|
-
|
|
508
|
-
</dd>
|
|
509
|
-
</dl>
|
|
510
|
-
|
|
511
|
-
<dl>
|
|
512
|
-
<dd>
|
|
513
|
-
|
|
514
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
477
|
+
**id:** `string` — The unique identifier for the job.
|
|
515
478
|
|
|
516
479
|
</dd>
|
|
517
480
|
</dl>
|
|
@@ -519,7 +482,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
519
482
|
<dl>
|
|
520
483
|
<dd>
|
|
521
484
|
|
|
522
|
-
**requestOptions:** `
|
|
485
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
523
486
|
|
|
524
487
|
</dd>
|
|
525
488
|
</dl>
|
|
@@ -530,7 +493,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
530
493
|
</dl>
|
|
531
494
|
</details>
|
|
532
495
|
|
|
533
|
-
<details><summary><code>client.
|
|
496
|
+
<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>
|
|
534
497
|
<dl>
|
|
535
498
|
<dd>
|
|
536
499
|
|
|
@@ -542,9 +505,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
542
505
|
<dl>
|
|
543
506
|
<dd>
|
|
544
507
|
|
|
545
|
-
|
|
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.
|
|
508
|
+
Start a new batch inference job.
|
|
548
509
|
|
|
549
510
|
</dd>
|
|
550
511
|
</dl>
|
|
@@ -560,7 +521,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
560
521
|
<dd>
|
|
561
522
|
|
|
562
523
|
```typescript
|
|
563
|
-
await client.
|
|
524
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
525
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
526
|
+
{}
|
|
527
|
+
);
|
|
564
528
|
```
|
|
565
529
|
|
|
566
530
|
</dd>
|
|
@@ -576,7 +540,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
576
540
|
<dl>
|
|
577
541
|
<dd>
|
|
578
542
|
|
|
579
|
-
**
|
|
543
|
+
**file:** `File[] | fs.ReadStream[] | Blob[]`
|
|
580
544
|
|
|
581
545
|
</dd>
|
|
582
546
|
</dl>
|
|
@@ -584,7 +548,15 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
584
548
|
<dl>
|
|
585
549
|
<dd>
|
|
586
550
|
|
|
587
|
-
**
|
|
551
|
+
**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
|
|
552
|
+
|
|
553
|
+
</dd>
|
|
554
|
+
</dl>
|
|
555
|
+
|
|
556
|
+
<dl>
|
|
557
|
+
<dd>
|
|
558
|
+
|
|
559
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
588
560
|
|
|
589
561
|
</dd>
|
|
590
562
|
</dl>
|
|
@@ -595,7 +567,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
595
567
|
</dl>
|
|
596
568
|
</details>
|
|
597
569
|
|
|
598
|
-
|
|
570
|
+
## EmpathicVoice Tools
|
|
571
|
+
|
|
572
|
+
<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>
|
|
599
573
|
<dl>
|
|
600
574
|
<dd>
|
|
601
575
|
|
|
@@ -607,7 +581,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
607
581
|
<dl>
|
|
608
582
|
<dd>
|
|
609
583
|
|
|
610
|
-
|
|
584
|
+
Fetches a paginated list of **Tools**.
|
|
611
585
|
|
|
612
586
|
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.
|
|
613
587
|
|
|
@@ -625,8 +599,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
625
599
|
<dd>
|
|
626
600
|
|
|
627
601
|
```typescript
|
|
628
|
-
await client.empathicVoice.tools.
|
|
629
|
-
|
|
602
|
+
await client.empathicVoice.tools.listTools({
|
|
603
|
+
pageNumber: 0,
|
|
604
|
+
pageSize: 2,
|
|
630
605
|
});
|
|
631
606
|
```
|
|
632
607
|
|
|
@@ -643,15 +618,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
643
618
|
<dl>
|
|
644
619
|
<dd>
|
|
645
620
|
|
|
646
|
-
**
|
|
647
|
-
|
|
648
|
-
</dd>
|
|
649
|
-
</dl>
|
|
650
|
-
|
|
651
|
-
<dl>
|
|
652
|
-
<dd>
|
|
653
|
-
|
|
654
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
621
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
655
622
|
|
|
656
623
|
</dd>
|
|
657
624
|
</dl>
|
|
@@ -670,7 +637,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
670
637
|
</dl>
|
|
671
638
|
</details>
|
|
672
639
|
|
|
673
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
640
|
+
<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>
|
|
674
641
|
<dl>
|
|
675
642
|
<dd>
|
|
676
643
|
|
|
@@ -682,7 +649,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
682
649
|
<dl>
|
|
683
650
|
<dd>
|
|
684
651
|
|
|
685
|
-
|
|
652
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
686
653
|
|
|
687
654
|
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.
|
|
688
655
|
|
|
@@ -700,7 +667,14 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
700
667
|
<dd>
|
|
701
668
|
|
|
702
669
|
```typescript
|
|
703
|
-
await client.empathicVoice.tools.
|
|
670
|
+
await client.empathicVoice.tools.createTool({
|
|
671
|
+
name: "get_current_weather",
|
|
672
|
+
parameters:
|
|
673
|
+
'{ "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"] }',
|
|
674
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
675
|
+
description: "This tool is for getting the current weather.",
|
|
676
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
677
|
+
});
|
|
704
678
|
```
|
|
705
679
|
|
|
706
680
|
</dd>
|
|
@@ -716,21 +690,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
716
690
|
<dl>
|
|
717
691
|
<dd>
|
|
718
692
|
|
|
719
|
-
**
|
|
720
|
-
|
|
721
|
-
</dd>
|
|
722
|
-
</dl>
|
|
723
|
-
|
|
724
|
-
<dl>
|
|
725
|
-
<dd>
|
|
726
|
-
|
|
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.
|
|
693
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
734
694
|
|
|
735
695
|
</dd>
|
|
736
696
|
</dl>
|
|
@@ -749,7 +709,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
749
709
|
</dl>
|
|
750
710
|
</details>
|
|
751
711
|
|
|
752
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
712
|
+
<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>
|
|
753
713
|
<dl>
|
|
754
714
|
<dd>
|
|
755
715
|
|
|
@@ -761,7 +721,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
761
721
|
<dl>
|
|
762
722
|
<dd>
|
|
763
723
|
|
|
764
|
-
|
|
724
|
+
Fetches a list of a **Tool's** versions.
|
|
765
725
|
|
|
766
726
|
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
727
|
|
|
@@ -779,7 +739,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
779
739
|
<dd>
|
|
780
740
|
|
|
781
741
|
```typescript
|
|
782
|
-
await client.empathicVoice.tools.
|
|
742
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
783
743
|
```
|
|
784
744
|
|
|
785
745
|
</dd>
|
|
@@ -803,13 +763,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
803
763
|
<dl>
|
|
804
764
|
<dd>
|
|
805
765
|
|
|
806
|
-
**
|
|
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.
|
|
766
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
813
767
|
|
|
814
768
|
</dd>
|
|
815
769
|
</dl>
|
|
@@ -828,7 +782,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
828
782
|
</dl>
|
|
829
783
|
</details>
|
|
830
784
|
|
|
831
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
785
|
+
<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>
|
|
832
786
|
<dl>
|
|
833
787
|
<dd>
|
|
834
788
|
|
|
@@ -840,7 +794,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
840
794
|
<dl>
|
|
841
795
|
<dd>
|
|
842
796
|
|
|
843
|
-
Updates
|
|
797
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
844
798
|
|
|
845
799
|
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
800
|
|
|
@@ -858,9 +812,12 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
858
812
|
<dd>
|
|
859
813
|
|
|
860
814
|
```typescript
|
|
861
|
-
await client.empathicVoice.tools.
|
|
862
|
-
|
|
863
|
-
"
|
|
815
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
816
|
+
parameters:
|
|
817
|
+
'{ "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"] }',
|
|
818
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
819
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
820
|
+
description: "This tool is for getting the current weather.",
|
|
864
821
|
});
|
|
865
822
|
```
|
|
866
823
|
|
|
@@ -885,21 +842,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
885
842
|
<dl>
|
|
886
843
|
<dd>
|
|
887
844
|
|
|
888
|
-
**
|
|
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`
|
|
845
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
903
846
|
|
|
904
847
|
</dd>
|
|
905
848
|
</dl>
|
|
@@ -918,9 +861,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
918
861
|
</dl>
|
|
919
862
|
</details>
|
|
920
863
|
|
|
921
|
-
|
|
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>
|
|
864
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
924
865
|
<dl>
|
|
925
866
|
<dd>
|
|
926
867
|
|
|
@@ -932,9 +873,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
932
873
|
<dl>
|
|
933
874
|
<dd>
|
|
934
875
|
|
|
935
|
-
|
|
876
|
+
Deletes a **Tool** and its versions.
|
|
936
877
|
|
|
937
|
-
|
|
878
|
+
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
879
|
|
|
939
880
|
</dd>
|
|
940
881
|
</dl>
|
|
@@ -950,10 +891,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
950
891
|
<dd>
|
|
951
892
|
|
|
952
893
|
```typescript
|
|
953
|
-
await client.empathicVoice.
|
|
954
|
-
pageNumber: 0,
|
|
955
|
-
pageSize: 2,
|
|
956
|
-
});
|
|
894
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
957
895
|
```
|
|
958
896
|
|
|
959
897
|
</dd>
|
|
@@ -969,7 +907,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
969
907
|
<dl>
|
|
970
908
|
<dd>
|
|
971
909
|
|
|
972
|
-
**
|
|
910
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
973
911
|
|
|
974
912
|
</dd>
|
|
975
913
|
</dl>
|
|
@@ -977,7 +915,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
977
915
|
<dl>
|
|
978
916
|
<dd>
|
|
979
917
|
|
|
980
|
-
**requestOptions:** `
|
|
918
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
981
919
|
|
|
982
920
|
</dd>
|
|
983
921
|
</dl>
|
|
@@ -988,7 +926,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
988
926
|
</dl>
|
|
989
927
|
</details>
|
|
990
928
|
|
|
991
|
-
<details><summary><code>client.empathicVoice.
|
|
929
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
992
930
|
<dl>
|
|
993
931
|
<dd>
|
|
994
932
|
|
|
@@ -1000,9 +938,9 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
1000
938
|
<dl>
|
|
1001
939
|
<dd>
|
|
1002
940
|
|
|
1003
|
-
|
|
941
|
+
Updates the name of a **Tool**.
|
|
1004
942
|
|
|
1005
|
-
|
|
943
|
+
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
944
|
|
|
1007
945
|
</dd>
|
|
1008
946
|
</dl>
|
|
@@ -1018,9 +956,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1018
956
|
<dd>
|
|
1019
957
|
|
|
1020
958
|
```typescript
|
|
1021
|
-
await client.empathicVoice.
|
|
1022
|
-
name: "
|
|
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>",
|
|
959
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
960
|
+
name: "get_current_temperature",
|
|
1024
961
|
});
|
|
1025
962
|
```
|
|
1026
963
|
|
|
@@ -1037,7 +974,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1037
974
|
<dl>
|
|
1038
975
|
<dd>
|
|
1039
976
|
|
|
1040
|
-
**
|
|
977
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1041
978
|
|
|
1042
979
|
</dd>
|
|
1043
980
|
</dl>
|
|
@@ -1045,7 +982,15 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1045
982
|
<dl>
|
|
1046
983
|
<dd>
|
|
1047
984
|
|
|
1048
|
-
**
|
|
985
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
986
|
+
|
|
987
|
+
</dd>
|
|
988
|
+
</dl>
|
|
989
|
+
|
|
990
|
+
<dl>
|
|
991
|
+
<dd>
|
|
992
|
+
|
|
993
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1049
994
|
|
|
1050
995
|
</dd>
|
|
1051
996
|
</dl>
|
|
@@ -1056,7 +1001,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1056
1001
|
</dl>
|
|
1057
1002
|
</details>
|
|
1058
1003
|
|
|
1059
|
-
<details><summary><code>client.empathicVoice.
|
|
1004
|
+
<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>
|
|
1060
1005
|
<dl>
|
|
1061
1006
|
<dd>
|
|
1062
1007
|
|
|
@@ -1068,9 +1013,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1068
1013
|
<dl>
|
|
1069
1014
|
<dd>
|
|
1070
1015
|
|
|
1071
|
-
Fetches a
|
|
1016
|
+
Fetches a specified version of a **Tool**.
|
|
1072
1017
|
|
|
1073
|
-
|
|
1018
|
+
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
1019
|
|
|
1075
1020
|
</dd>
|
|
1076
1021
|
</dl>
|
|
@@ -1086,7 +1031,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1086
1031
|
<dd>
|
|
1087
1032
|
|
|
1088
1033
|
```typescript
|
|
1089
|
-
await client.empathicVoice.
|
|
1034
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1090
1035
|
```
|
|
1091
1036
|
|
|
1092
1037
|
</dd>
|
|
@@ -1102,7 +1047,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1102
1047
|
<dl>
|
|
1103
1048
|
<dd>
|
|
1104
1049
|
|
|
1105
|
-
**id:** `string` — Identifier for a
|
|
1050
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1106
1051
|
|
|
1107
1052
|
</dd>
|
|
1108
1053
|
</dl>
|
|
@@ -1110,15 +1055,21 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1110
1055
|
<dl>
|
|
1111
1056
|
<dd>
|
|
1112
1057
|
|
|
1113
|
-
**
|
|
1058
|
+
**version:** `number`
|
|
1114
1059
|
|
|
1115
|
-
|
|
1116
|
-
</dl>
|
|
1060
|
+
Version number for a Tool.
|
|
1117
1061
|
|
|
1118
|
-
|
|
1119
|
-
<dd>
|
|
1062
|
+
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.
|
|
1120
1063
|
|
|
1121
|
-
|
|
1064
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1065
|
+
|
|
1066
|
+
</dd>
|
|
1067
|
+
</dl>
|
|
1068
|
+
|
|
1069
|
+
<dl>
|
|
1070
|
+
<dd>
|
|
1071
|
+
|
|
1072
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1122
1073
|
|
|
1123
1074
|
</dd>
|
|
1124
1075
|
</dl>
|
|
@@ -1129,7 +1080,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1129
1080
|
</dl>
|
|
1130
1081
|
</details>
|
|
1131
1082
|
|
|
1132
|
-
<details><summary><code>client.empathicVoice.
|
|
1083
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
1133
1084
|
<dl>
|
|
1134
1085
|
<dd>
|
|
1135
1086
|
|
|
@@ -1141,9 +1092,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1141
1092
|
<dl>
|
|
1142
1093
|
<dd>
|
|
1143
1094
|
|
|
1144
|
-
|
|
1095
|
+
Deletes a specified version of a **Tool**.
|
|
1145
1096
|
|
|
1146
|
-
|
|
1097
|
+
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
1098
|
|
|
1148
1099
|
</dd>
|
|
1149
1100
|
</dl>
|
|
@@ -1159,10 +1110,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1159
1110
|
<dd>
|
|
1160
1111
|
|
|
1161
1112
|
```typescript
|
|
1162
|
-
await client.empathicVoice.
|
|
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.",
|
|
1165
|
-
});
|
|
1113
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1166
1114
|
```
|
|
1167
1115
|
|
|
1168
1116
|
</dd>
|
|
@@ -1178,7 +1126,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1178
1126
|
<dl>
|
|
1179
1127
|
<dd>
|
|
1180
1128
|
|
|
1181
|
-
**id:** `string` — Identifier for a
|
|
1129
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1182
1130
|
|
|
1183
1131
|
</dd>
|
|
1184
1132
|
</dl>
|
|
@@ -1186,7 +1134,13 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1186
1134
|
<dl>
|
|
1187
1135
|
<dd>
|
|
1188
1136
|
|
|
1189
|
-
**
|
|
1137
|
+
**version:** `number`
|
|
1138
|
+
|
|
1139
|
+
Version number for a Tool.
|
|
1140
|
+
|
|
1141
|
+
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.
|
|
1142
|
+
|
|
1143
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1190
1144
|
|
|
1191
1145
|
</dd>
|
|
1192
1146
|
</dl>
|
|
@@ -1194,7 +1148,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1194
1148
|
<dl>
|
|
1195
1149
|
<dd>
|
|
1196
1150
|
|
|
1197
|
-
**requestOptions:** `
|
|
1151
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1198
1152
|
|
|
1199
1153
|
</dd>
|
|
1200
1154
|
</dl>
|
|
@@ -1205,7 +1159,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1205
1159
|
</dl>
|
|
1206
1160
|
</details>
|
|
1207
1161
|
|
|
1208
|
-
<details><summary><code>client.empathicVoice.
|
|
1162
|
+
<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>
|
|
1209
1163
|
<dl>
|
|
1210
1164
|
<dd>
|
|
1211
1165
|
|
|
@@ -1217,9 +1171,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1217
1171
|
<dl>
|
|
1218
1172
|
<dd>
|
|
1219
1173
|
|
|
1220
|
-
|
|
1174
|
+
Updates the description of a specified **Tool** version.
|
|
1221
1175
|
|
|
1222
|
-
|
|
1176
|
+
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
1177
|
|
|
1224
1178
|
</dd>
|
|
1225
1179
|
</dl>
|
|
@@ -1235,7 +1189,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1235
1189
|
<dd>
|
|
1236
1190
|
|
|
1237
1191
|
```typescript
|
|
1238
|
-
await client.empathicVoice.
|
|
1192
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
1193
|
+
versionDescription:
|
|
1194
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1195
|
+
});
|
|
1239
1196
|
```
|
|
1240
1197
|
|
|
1241
1198
|
</dd>
|
|
@@ -1251,7 +1208,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1251
1208
|
<dl>
|
|
1252
1209
|
<dd>
|
|
1253
1210
|
|
|
1254
|
-
**id:** `string` — Identifier for a
|
|
1211
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1255
1212
|
|
|
1256
1213
|
</dd>
|
|
1257
1214
|
</dl>
|
|
@@ -1259,7 +1216,29 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1259
1216
|
<dl>
|
|
1260
1217
|
<dd>
|
|
1261
1218
|
|
|
1262
|
-
**
|
|
1219
|
+
**version:** `number`
|
|
1220
|
+
|
|
1221
|
+
Version number for a Tool.
|
|
1222
|
+
|
|
1223
|
+
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.
|
|
1224
|
+
|
|
1225
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1226
|
+
|
|
1227
|
+
</dd>
|
|
1228
|
+
</dl>
|
|
1229
|
+
|
|
1230
|
+
<dl>
|
|
1231
|
+
<dd>
|
|
1232
|
+
|
|
1233
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
1234
|
+
|
|
1235
|
+
</dd>
|
|
1236
|
+
</dl>
|
|
1237
|
+
|
|
1238
|
+
<dl>
|
|
1239
|
+
<dd>
|
|
1240
|
+
|
|
1241
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1263
1242
|
|
|
1264
1243
|
</dd>
|
|
1265
1244
|
</dl>
|
|
@@ -1270,7 +1249,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1270
1249
|
</dl>
|
|
1271
1250
|
</details>
|
|
1272
1251
|
|
|
1273
|
-
|
|
1252
|
+
## EmpathicVoice Prompts
|
|
1253
|
+
|
|
1254
|
+
<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>
|
|
1274
1255
|
<dl>
|
|
1275
1256
|
<dd>
|
|
1276
1257
|
|
|
@@ -1282,7 +1263,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1282
1263
|
<dl>
|
|
1283
1264
|
<dd>
|
|
1284
1265
|
|
|
1285
|
-
|
|
1266
|
+
Fetches a paginated list of **Prompts**.
|
|
1286
1267
|
|
|
1287
1268
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1288
1269
|
|
|
@@ -1300,8 +1281,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1300
1281
|
<dd>
|
|
1301
1282
|
|
|
1302
1283
|
```typescript
|
|
1303
|
-
await client.empathicVoice.prompts.
|
|
1304
|
-
|
|
1284
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
1285
|
+
pageNumber: 0,
|
|
1286
|
+
pageSize: 2,
|
|
1305
1287
|
});
|
|
1306
1288
|
```
|
|
1307
1289
|
|
|
@@ -1318,15 +1300,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1318
1300
|
<dl>
|
|
1319
1301
|
<dd>
|
|
1320
1302
|
|
|
1321
|
-
**
|
|
1322
|
-
|
|
1323
|
-
</dd>
|
|
1324
|
-
</dl>
|
|
1325
|
-
|
|
1326
|
-
<dl>
|
|
1327
|
-
<dd>
|
|
1328
|
-
|
|
1329
|
-
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1303
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
1330
1304
|
|
|
1331
1305
|
</dd>
|
|
1332
1306
|
</dl>
|
|
@@ -1345,7 +1319,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1345
1319
|
</dl>
|
|
1346
1320
|
</details>
|
|
1347
1321
|
|
|
1348
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1322
|
+
<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>
|
|
1349
1323
|
<dl>
|
|
1350
1324
|
<dd>
|
|
1351
1325
|
|
|
@@ -1357,7 +1331,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1357
1331
|
<dl>
|
|
1358
1332
|
<dd>
|
|
1359
1333
|
|
|
1360
|
-
|
|
1334
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1361
1335
|
|
|
1362
1336
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1363
1337
|
|
|
@@ -1375,7 +1349,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1375
1349
|
<dd>
|
|
1376
1350
|
|
|
1377
1351
|
```typescript
|
|
1378
|
-
await client.empathicVoice.prompts.
|
|
1352
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1353
|
+
name: "Weather Assistant Prompt",
|
|
1354
|
+
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>",
|
|
1355
|
+
});
|
|
1379
1356
|
```
|
|
1380
1357
|
|
|
1381
1358
|
</dd>
|
|
@@ -1391,21 +1368,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1391
1368
|
<dl>
|
|
1392
1369
|
<dd>
|
|
1393
1370
|
|
|
1394
|
-
**
|
|
1395
|
-
|
|
1396
|
-
</dd>
|
|
1397
|
-
</dl>
|
|
1398
|
-
|
|
1399
|
-
<dl>
|
|
1400
|
-
<dd>
|
|
1401
|
-
|
|
1402
|
-
**version:** `number`
|
|
1403
|
-
|
|
1404
|
-
Version number for a Prompt.
|
|
1405
|
-
|
|
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.
|
|
1407
|
-
|
|
1408
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1371
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
1409
1372
|
|
|
1410
1373
|
</dd>
|
|
1411
1374
|
</dl>
|
|
@@ -1424,7 +1387,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1424
1387
|
</dl>
|
|
1425
1388
|
</details>
|
|
1426
1389
|
|
|
1427
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1390
|
+
<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>
|
|
1428
1391
|
<dl>
|
|
1429
1392
|
<dd>
|
|
1430
1393
|
|
|
@@ -1436,7 +1399,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1436
1399
|
<dl>
|
|
1437
1400
|
<dd>
|
|
1438
1401
|
|
|
1439
|
-
|
|
1402
|
+
Fetches a list of a **Prompt's** versions.
|
|
1440
1403
|
|
|
1441
1404
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1442
1405
|
|
|
@@ -1454,7 +1417,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1454
1417
|
<dd>
|
|
1455
1418
|
|
|
1456
1419
|
```typescript
|
|
1457
|
-
await client.empathicVoice.prompts.
|
|
1420
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1458
1421
|
```
|
|
1459
1422
|
|
|
1460
1423
|
</dd>
|
|
@@ -1478,13 +1441,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1478
1441
|
<dl>
|
|
1479
1442
|
<dd>
|
|
1480
1443
|
|
|
1481
|
-
**
|
|
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.
|
|
1444
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1488
1445
|
|
|
1489
1446
|
</dd>
|
|
1490
1447
|
</dl>
|
|
@@ -1503,7 +1460,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1503
1460
|
</dl>
|
|
1504
1461
|
</details>
|
|
1505
1462
|
|
|
1506
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1463
|
+
<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>
|
|
1507
1464
|
<dl>
|
|
1508
1465
|
<dd>
|
|
1509
1466
|
|
|
@@ -1515,7 +1472,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1515
1472
|
<dl>
|
|
1516
1473
|
<dd>
|
|
1517
1474
|
|
|
1518
|
-
Updates
|
|
1475
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1519
1476
|
|
|
1520
1477
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1521
1478
|
|
|
@@ -1533,8 +1490,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1533
1490
|
<dd>
|
|
1534
1491
|
|
|
1535
1492
|
```typescript
|
|
1536
|
-
await client.empathicVoice.prompts.
|
|
1537
|
-
|
|
1493
|
+
await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1494
|
+
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>",
|
|
1495
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1538
1496
|
});
|
|
1539
1497
|
```
|
|
1540
1498
|
|
|
@@ -1559,21 +1517,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1559
1517
|
<dl>
|
|
1560
1518
|
<dd>
|
|
1561
1519
|
|
|
1562
|
-
**
|
|
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`
|
|
1520
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1577
1521
|
|
|
1578
1522
|
</dd>
|
|
1579
1523
|
</dl>
|
|
@@ -1592,9 +1536,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1592
1536
|
</dl>
|
|
1593
1537
|
</details>
|
|
1594
1538
|
|
|
1595
|
-
|
|
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>
|
|
1539
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
1598
1540
|
<dl>
|
|
1599
1541
|
<dd>
|
|
1600
1542
|
|
|
@@ -1606,9 +1548,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1606
1548
|
<dl>
|
|
1607
1549
|
<dd>
|
|
1608
1550
|
|
|
1609
|
-
|
|
1551
|
+
Deletes a **Prompt** and its versions.
|
|
1610
1552
|
|
|
1611
|
-
|
|
1553
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1612
1554
|
|
|
1613
1555
|
</dd>
|
|
1614
1556
|
</dl>
|
|
@@ -1624,7 +1566,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1624
1566
|
<dd>
|
|
1625
1567
|
|
|
1626
1568
|
```typescript
|
|
1627
|
-
await client.empathicVoice.
|
|
1569
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1628
1570
|
```
|
|
1629
1571
|
|
|
1630
1572
|
</dd>
|
|
@@ -1640,7 +1582,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1640
1582
|
<dl>
|
|
1641
1583
|
<dd>
|
|
1642
1584
|
|
|
1643
|
-
**
|
|
1585
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1644
1586
|
|
|
1645
1587
|
</dd>
|
|
1646
1588
|
</dl>
|
|
@@ -1648,7 +1590,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1648
1590
|
<dl>
|
|
1649
1591
|
<dd>
|
|
1650
1592
|
|
|
1651
|
-
**requestOptions:** `
|
|
1593
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1652
1594
|
|
|
1653
1595
|
</dd>
|
|
1654
1596
|
</dl>
|
|
@@ -1659,7 +1601,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1659
1601
|
</dl>
|
|
1660
1602
|
</details>
|
|
1661
1603
|
|
|
1662
|
-
<details><summary><code>client.empathicVoice.
|
|
1604
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1663
1605
|
<dl>
|
|
1664
1606
|
<dd>
|
|
1665
1607
|
|
|
@@ -1671,9 +1613,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1671
1613
|
<dl>
|
|
1672
1614
|
<dd>
|
|
1673
1615
|
|
|
1674
|
-
|
|
1616
|
+
Updates the name of a **Prompt**.
|
|
1675
1617
|
|
|
1676
|
-
|
|
1618
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1677
1619
|
|
|
1678
1620
|
</dd>
|
|
1679
1621
|
</dl>
|
|
@@ -1689,10 +1631,8 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1689
1631
|
<dd>
|
|
1690
1632
|
|
|
1691
1633
|
```typescript
|
|
1692
|
-
await client.empathicVoice.
|
|
1693
|
-
name: "
|
|
1694
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1695
|
-
parameterModel: "20241004-11parameter",
|
|
1634
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1635
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
1696
1636
|
});
|
|
1697
1637
|
```
|
|
1698
1638
|
|
|
@@ -1709,7 +1649,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1709
1649
|
<dl>
|
|
1710
1650
|
<dd>
|
|
1711
1651
|
|
|
1712
|
-
**
|
|
1652
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1713
1653
|
|
|
1714
1654
|
</dd>
|
|
1715
1655
|
</dl>
|
|
@@ -1717,7 +1657,15 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1717
1657
|
<dl>
|
|
1718
1658
|
<dd>
|
|
1719
1659
|
|
|
1720
|
-
**
|
|
1660
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1661
|
+
|
|
1662
|
+
</dd>
|
|
1663
|
+
</dl>
|
|
1664
|
+
|
|
1665
|
+
<dl>
|
|
1666
|
+
<dd>
|
|
1667
|
+
|
|
1668
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1721
1669
|
|
|
1722
1670
|
</dd>
|
|
1723
1671
|
</dl>
|
|
@@ -1728,7 +1676,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1728
1676
|
</dl>
|
|
1729
1677
|
</details>
|
|
1730
1678
|
|
|
1731
|
-
<details><summary><code>client.empathicVoice.
|
|
1679
|
+
<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>
|
|
1732
1680
|
<dl>
|
|
1733
1681
|
<dd>
|
|
1734
1682
|
|
|
@@ -1740,9 +1688,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1740
1688
|
<dl>
|
|
1741
1689
|
<dd>
|
|
1742
1690
|
|
|
1743
|
-
Fetches a
|
|
1691
|
+
Fetches a specified version of a **Prompt**.
|
|
1744
1692
|
|
|
1745
|
-
|
|
1693
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1746
1694
|
|
|
1747
1695
|
</dd>
|
|
1748
1696
|
</dl>
|
|
@@ -1758,7 +1706,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1758
1706
|
<dd>
|
|
1759
1707
|
|
|
1760
1708
|
```typescript
|
|
1761
|
-
await client.empathicVoice.
|
|
1709
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
1762
1710
|
```
|
|
1763
1711
|
|
|
1764
1712
|
</dd>
|
|
@@ -1774,7 +1722,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1774
1722
|
<dl>
|
|
1775
1723
|
<dd>
|
|
1776
1724
|
|
|
1777
|
-
**id:** `string` — Identifier for a
|
|
1725
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1778
1726
|
|
|
1779
1727
|
</dd>
|
|
1780
1728
|
</dl>
|
|
@@ -1782,7 +1730,21 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1782
1730
|
<dl>
|
|
1783
1731
|
<dd>
|
|
1784
1732
|
|
|
1785
|
-
**
|
|
1733
|
+
**version:** `number`
|
|
1734
|
+
|
|
1735
|
+
Version number for a Prompt.
|
|
1736
|
+
|
|
1737
|
+
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.
|
|
1738
|
+
|
|
1739
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1740
|
+
|
|
1741
|
+
</dd>
|
|
1742
|
+
</dl>
|
|
1743
|
+
|
|
1744
|
+
<dl>
|
|
1745
|
+
<dd>
|
|
1746
|
+
|
|
1747
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1786
1748
|
|
|
1787
1749
|
</dd>
|
|
1788
1750
|
</dl>
|
|
@@ -1793,7 +1755,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1793
1755
|
</dl>
|
|
1794
1756
|
</details>
|
|
1795
1757
|
|
|
1796
|
-
<details><summary><code>client.empathicVoice.
|
|
1758
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
1797
1759
|
<dl>
|
|
1798
1760
|
<dd>
|
|
1799
1761
|
|
|
@@ -1805,9 +1767,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1805
1767
|
<dl>
|
|
1806
1768
|
<dd>
|
|
1807
1769
|
|
|
1808
|
-
|
|
1770
|
+
Deletes a specified version of a **Prompt**.
|
|
1809
1771
|
|
|
1810
|
-
|
|
1772
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1811
1773
|
|
|
1812
1774
|
</dd>
|
|
1813
1775
|
</dl>
|
|
@@ -1823,11 +1785,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1823
1785
|
<dd>
|
|
1824
1786
|
|
|
1825
1787
|
```typescript
|
|
1826
|
-
await client.empathicVoice.
|
|
1827
|
-
name: "name",
|
|
1828
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1829
|
-
parameterModel: "20241004-11parameter",
|
|
1830
|
-
});
|
|
1788
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
1831
1789
|
```
|
|
1832
1790
|
|
|
1833
1791
|
</dd>
|
|
@@ -1843,7 +1801,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1843
1801
|
<dl>
|
|
1844
1802
|
<dd>
|
|
1845
1803
|
|
|
1846
|
-
**id:** `string` — Identifier for a
|
|
1804
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1847
1805
|
|
|
1848
1806
|
</dd>
|
|
1849
1807
|
</dl>
|
|
@@ -1851,7 +1809,13 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1851
1809
|
<dl>
|
|
1852
1810
|
<dd>
|
|
1853
1811
|
|
|
1854
|
-
**
|
|
1812
|
+
**version:** `number`
|
|
1813
|
+
|
|
1814
|
+
Version number for a Prompt.
|
|
1815
|
+
|
|
1816
|
+
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.
|
|
1817
|
+
|
|
1818
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1855
1819
|
|
|
1856
1820
|
</dd>
|
|
1857
1821
|
</dl>
|
|
@@ -1859,7 +1823,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1859
1823
|
<dl>
|
|
1860
1824
|
<dd>
|
|
1861
1825
|
|
|
1862
|
-
**requestOptions:** `
|
|
1826
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1863
1827
|
|
|
1864
1828
|
</dd>
|
|
1865
1829
|
</dl>
|
|
@@ -1870,7 +1834,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1870
1834
|
</dl>
|
|
1871
1835
|
</details>
|
|
1872
1836
|
|
|
1873
|
-
<details><summary><code>client.empathicVoice.
|
|
1837
|
+
<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>
|
|
1874
1838
|
<dl>
|
|
1875
1839
|
<dd>
|
|
1876
1840
|
|
|
@@ -1882,9 +1846,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1882
1846
|
<dl>
|
|
1883
1847
|
<dd>
|
|
1884
1848
|
|
|
1885
|
-
|
|
1849
|
+
Updates the description of a **Prompt**.
|
|
1886
1850
|
|
|
1887
|
-
|
|
1851
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1888
1852
|
|
|
1889
1853
|
</dd>
|
|
1890
1854
|
</dl>
|
|
@@ -1900,7 +1864,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1900
1864
|
<dd>
|
|
1901
1865
|
|
|
1902
1866
|
```typescript
|
|
1903
|
-
await client.empathicVoice.
|
|
1867
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1868
|
+
versionDescription: "This is an updated version_description.",
|
|
1869
|
+
});
|
|
1904
1870
|
```
|
|
1905
1871
|
|
|
1906
1872
|
</dd>
|
|
@@ -1916,7 +1882,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1916
1882
|
<dl>
|
|
1917
1883
|
<dd>
|
|
1918
1884
|
|
|
1919
|
-
**id:** `string` — Identifier for a
|
|
1885
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1920
1886
|
|
|
1921
1887
|
</dd>
|
|
1922
1888
|
</dl>
|
|
@@ -1924,7 +1890,29 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1924
1890
|
<dl>
|
|
1925
1891
|
<dd>
|
|
1926
1892
|
|
|
1927
|
-
**
|
|
1893
|
+
**version:** `number`
|
|
1894
|
+
|
|
1895
|
+
Version number for a Prompt.
|
|
1896
|
+
|
|
1897
|
+
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.
|
|
1898
|
+
|
|
1899
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1900
|
+
|
|
1901
|
+
</dd>
|
|
1902
|
+
</dl>
|
|
1903
|
+
|
|
1904
|
+
<dl>
|
|
1905
|
+
<dd>
|
|
1906
|
+
|
|
1907
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1908
|
+
|
|
1909
|
+
</dd>
|
|
1910
|
+
</dl>
|
|
1911
|
+
|
|
1912
|
+
<dl>
|
|
1913
|
+
<dd>
|
|
1914
|
+
|
|
1915
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1928
1916
|
|
|
1929
1917
|
</dd>
|
|
1930
1918
|
</dl>
|
|
@@ -1935,7 +1923,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1935
1923
|
</dl>
|
|
1936
1924
|
</details>
|
|
1937
1925
|
|
|
1938
|
-
|
|
1926
|
+
## EmpathicVoice CustomVoices
|
|
1927
|
+
|
|
1928
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1939
1929
|
<dl>
|
|
1940
1930
|
<dd>
|
|
1941
1931
|
|
|
@@ -1947,7 +1937,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1947
1937
|
<dl>
|
|
1948
1938
|
<dd>
|
|
1949
1939
|
|
|
1950
|
-
|
|
1940
|
+
Fetches a paginated list of **Custom Voices**.
|
|
1951
1941
|
|
|
1952
1942
|
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1953
1943
|
|
|
@@ -1965,9 +1955,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1965
1955
|
<dd>
|
|
1966
1956
|
|
|
1967
1957
|
```typescript
|
|
1968
|
-
await client.empathicVoice.customVoices.
|
|
1969
|
-
name: "name",
|
|
1970
|
-
});
|
|
1958
|
+
await client.empathicVoice.customVoices.listCustomVoices();
|
|
1971
1959
|
```
|
|
1972
1960
|
|
|
1973
1961
|
</dd>
|
|
@@ -1983,15 +1971,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
1983
1971
|
<dl>
|
|
1984
1972
|
<dd>
|
|
1985
1973
|
|
|
1986
|
-
**
|
|
1987
|
-
|
|
1988
|
-
</dd>
|
|
1989
|
-
</dl>
|
|
1990
|
-
|
|
1991
|
-
<dl>
|
|
1992
|
-
<dd>
|
|
1993
|
-
|
|
1994
|
-
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
1974
|
+
**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
|
|
1995
1975
|
|
|
1996
1976
|
</dd>
|
|
1997
1977
|
</dl>
|
|
@@ -2010,9 +1990,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2010
1990
|
</dl>
|
|
2011
1991
|
</details>
|
|
2012
1992
|
|
|
2013
|
-
|
|
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>
|
|
1993
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
2016
1994
|
<dl>
|
|
2017
1995
|
<dd>
|
|
2018
1996
|
|
|
@@ -2024,9 +2002,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2024
2002
|
<dl>
|
|
2025
2003
|
<dd>
|
|
2026
2004
|
|
|
2027
|
-
|
|
2005
|
+
Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
2028
2006
|
|
|
2029
|
-
|
|
2007
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2030
2008
|
|
|
2031
2009
|
</dd>
|
|
2032
2010
|
</dl>
|
|
@@ -2042,9 +2020,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2042
2020
|
<dd>
|
|
2043
2021
|
|
|
2044
2022
|
```typescript
|
|
2045
|
-
await client.empathicVoice.
|
|
2046
|
-
|
|
2047
|
-
|
|
2023
|
+
await client.empathicVoice.customVoices.createCustomVoice({
|
|
2024
|
+
name: "name",
|
|
2025
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
2026
|
+
parameterModel: "20241004-11parameter",
|
|
2048
2027
|
});
|
|
2049
2028
|
```
|
|
2050
2029
|
|
|
@@ -2061,7 +2040,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2061
2040
|
<dl>
|
|
2062
2041
|
<dd>
|
|
2063
2042
|
|
|
2064
|
-
**request:** `Hume.
|
|
2043
|
+
**request:** `Hume.PostedCustomVoice`
|
|
2065
2044
|
|
|
2066
2045
|
</dd>
|
|
2067
2046
|
</dl>
|
|
@@ -2069,7 +2048,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2069
2048
|
<dl>
|
|
2070
2049
|
<dd>
|
|
2071
2050
|
|
|
2072
|
-
**requestOptions:** `
|
|
2051
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2073
2052
|
|
|
2074
2053
|
</dd>
|
|
2075
2054
|
</dl>
|
|
@@ -2080,7 +2059,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2080
2059
|
</dl>
|
|
2081
2060
|
</details>
|
|
2082
2061
|
|
|
2083
|
-
<details><summary><code>client.empathicVoice.
|
|
2062
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
|
|
2084
2063
|
<dl>
|
|
2085
2064
|
<dd>
|
|
2086
2065
|
|
|
@@ -2092,9 +2071,9 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2092
2071
|
<dl>
|
|
2093
2072
|
<dd>
|
|
2094
2073
|
|
|
2095
|
-
|
|
2074
|
+
Fetches a specific **Custom Voice** by ID.
|
|
2096
2075
|
|
|
2097
|
-
|
|
2076
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2098
2077
|
|
|
2099
2078
|
</dd>
|
|
2100
2079
|
</dl>
|
|
@@ -2110,37 +2089,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2110
2089
|
<dd>
|
|
2111
2090
|
|
|
2112
2091
|
```typescript
|
|
2113
|
-
await client.empathicVoice.
|
|
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
|
-
});
|
|
2092
|
+
await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
2144
2093
|
```
|
|
2145
2094
|
|
|
2146
2095
|
</dd>
|
|
@@ -2156,7 +2105,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2156
2105
|
<dl>
|
|
2157
2106
|
<dd>
|
|
2158
2107
|
|
|
2159
|
-
**
|
|
2108
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2160
2109
|
|
|
2161
2110
|
</dd>
|
|
2162
2111
|
</dl>
|
|
@@ -2164,7 +2113,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2164
2113
|
<dl>
|
|
2165
2114
|
<dd>
|
|
2166
2115
|
|
|
2167
|
-
**requestOptions:** `
|
|
2116
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2168
2117
|
|
|
2169
2118
|
</dd>
|
|
2170
2119
|
</dl>
|
|
@@ -2175,7 +2124,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2175
2124
|
</dl>
|
|
2176
2125
|
</details>
|
|
2177
2126
|
|
|
2178
|
-
<details><summary><code>client.empathicVoice.
|
|
2127
|
+
<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>
|
|
2179
2128
|
<dl>
|
|
2180
2129
|
<dd>
|
|
2181
2130
|
|
|
@@ -2187,9 +2136,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2187
2136
|
<dl>
|
|
2188
2137
|
<dd>
|
|
2189
2138
|
|
|
2190
|
-
|
|
2139
|
+
Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
|
|
2191
2140
|
|
|
2192
|
-
|
|
2141
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2193
2142
|
|
|
2194
2143
|
</dd>
|
|
2195
2144
|
</dl>
|
|
@@ -2205,7 +2154,11 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2205
2154
|
<dd>
|
|
2206
2155
|
|
|
2207
2156
|
```typescript
|
|
2208
|
-
await client.empathicVoice.
|
|
2157
|
+
await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
2158
|
+
name: "name",
|
|
2159
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
2160
|
+
parameterModel: "20241004-11parameter",
|
|
2161
|
+
});
|
|
2209
2162
|
```
|
|
2210
2163
|
|
|
2211
2164
|
</dd>
|
|
@@ -2221,7 +2174,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2221
2174
|
<dl>
|
|
2222
2175
|
<dd>
|
|
2223
2176
|
|
|
2224
|
-
**id:** `string` — Identifier for a
|
|
2177
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2225
2178
|
|
|
2226
2179
|
</dd>
|
|
2227
2180
|
</dl>
|
|
@@ -2229,7 +2182,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2229
2182
|
<dl>
|
|
2230
2183
|
<dd>
|
|
2231
2184
|
|
|
2232
|
-
**request:** `Hume.
|
|
2185
|
+
**request:** `Hume.PostedCustomVoice`
|
|
2233
2186
|
|
|
2234
2187
|
</dd>
|
|
2235
2188
|
</dl>
|
|
@@ -2237,7 +2190,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2237
2190
|
<dl>
|
|
2238
2191
|
<dd>
|
|
2239
2192
|
|
|
2240
|
-
**requestOptions:** `
|
|
2193
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2241
2194
|
|
|
2242
2195
|
</dd>
|
|
2243
2196
|
</dl>
|
|
@@ -2248,7 +2201,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2248
2201
|
</dl>
|
|
2249
2202
|
</details>
|
|
2250
2203
|
|
|
2251
|
-
<details><summary><code>client.empathicVoice.
|
|
2204
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
|
|
2252
2205
|
<dl>
|
|
2253
2206
|
<dd>
|
|
2254
2207
|
|
|
@@ -2260,9 +2213,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2260
2213
|
<dl>
|
|
2261
2214
|
<dd>
|
|
2262
2215
|
|
|
2263
|
-
|
|
2216
|
+
Deletes a **Custom Voice** and its versions.
|
|
2264
2217
|
|
|
2265
|
-
|
|
2218
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2266
2219
|
|
|
2267
2220
|
</dd>
|
|
2268
2221
|
</dl>
|
|
@@ -2278,40 +2231,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2278
2231
|
<dd>
|
|
2279
2232
|
|
|
2280
2233
|
```typescript
|
|
2281
|
-
await client.empathicVoice.
|
|
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
|
-
},
|
|
2314
|
-
});
|
|
2234
|
+
await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
2315
2235
|
```
|
|
2316
2236
|
|
|
2317
2237
|
</dd>
|
|
@@ -2327,15 +2247,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2327
2247
|
<dl>
|
|
2328
2248
|
<dd>
|
|
2329
2249
|
|
|
2330
|
-
**id:** `string` — Identifier for a
|
|
2331
|
-
|
|
2332
|
-
</dd>
|
|
2333
|
-
</dl>
|
|
2334
|
-
|
|
2335
|
-
<dl>
|
|
2336
|
-
<dd>
|
|
2337
|
-
|
|
2338
|
-
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2250
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2339
2251
|
|
|
2340
2252
|
</dd>
|
|
2341
2253
|
</dl>
|
|
@@ -2343,7 +2255,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2343
2255
|
<dl>
|
|
2344
2256
|
<dd>
|
|
2345
2257
|
|
|
2346
|
-
**requestOptions:** `
|
|
2258
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2347
2259
|
|
|
2348
2260
|
</dd>
|
|
2349
2261
|
</dl>
|
|
@@ -2354,7 +2266,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2354
2266
|
</dl>
|
|
2355
2267
|
</details>
|
|
2356
2268
|
|
|
2357
|
-
<details><summary><code>client.empathicVoice.
|
|
2269
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
|
|
2358
2270
|
<dl>
|
|
2359
2271
|
<dd>
|
|
2360
2272
|
|
|
@@ -2366,9 +2278,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2366
2278
|
<dl>
|
|
2367
2279
|
<dd>
|
|
2368
2280
|
|
|
2369
|
-
|
|
2281
|
+
Updates the name of a **Custom Voice**.
|
|
2370
2282
|
|
|
2371
|
-
|
|
2283
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2372
2284
|
|
|
2373
2285
|
</dd>
|
|
2374
2286
|
</dl>
|
|
@@ -2384,7 +2296,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2384
2296
|
<dd>
|
|
2385
2297
|
|
|
2386
2298
|
```typescript
|
|
2387
|
-
await client.empathicVoice.
|
|
2299
|
+
await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
2300
|
+
name: "name",
|
|
2301
|
+
});
|
|
2388
2302
|
```
|
|
2389
2303
|
|
|
2390
2304
|
</dd>
|
|
@@ -2400,7 +2314,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2400
2314
|
<dl>
|
|
2401
2315
|
<dd>
|
|
2402
2316
|
|
|
2403
|
-
**id:** `string` — Identifier for a
|
|
2317
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2404
2318
|
|
|
2405
2319
|
</dd>
|
|
2406
2320
|
</dl>
|
|
@@ -2408,7 +2322,15 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2408
2322
|
<dl>
|
|
2409
2323
|
<dd>
|
|
2410
2324
|
|
|
2411
|
-
**
|
|
2325
|
+
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
2326
|
+
|
|
2327
|
+
</dd>
|
|
2328
|
+
</dl>
|
|
2329
|
+
|
|
2330
|
+
<dl>
|
|
2331
|
+
<dd>
|
|
2332
|
+
|
|
2333
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2412
2334
|
|
|
2413
2335
|
</dd>
|
|
2414
2336
|
</dl>
|
|
@@ -2419,7 +2341,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2419
2341
|
</dl>
|
|
2420
2342
|
</details>
|
|
2421
2343
|
|
|
2422
|
-
|
|
2344
|
+
## EmpathicVoice Configs
|
|
2345
|
+
|
|
2346
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2423
2347
|
<dl>
|
|
2424
2348
|
<dd>
|
|
2425
2349
|
|
|
@@ -2431,7 +2355,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2431
2355
|
<dl>
|
|
2432
2356
|
<dd>
|
|
2433
2357
|
|
|
2434
|
-
|
|
2358
|
+
Fetches a paginated list of **Configs**.
|
|
2435
2359
|
|
|
2436
2360
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2437
2361
|
|
|
@@ -2449,8 +2373,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2449
2373
|
<dd>
|
|
2450
2374
|
|
|
2451
2375
|
```typescript
|
|
2452
|
-
await client.empathicVoice.configs.
|
|
2453
|
-
|
|
2376
|
+
await client.empathicVoice.configs.listConfigs({
|
|
2377
|
+
pageNumber: 0,
|
|
2378
|
+
pageSize: 1,
|
|
2454
2379
|
});
|
|
2455
2380
|
```
|
|
2456
2381
|
|
|
@@ -2467,15 +2392,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2467
2392
|
<dl>
|
|
2468
2393
|
<dd>
|
|
2469
2394
|
|
|
2470
|
-
**
|
|
2471
|
-
|
|
2472
|
-
</dd>
|
|
2473
|
-
</dl>
|
|
2474
|
-
|
|
2475
|
-
<dl>
|
|
2476
|
-
<dd>
|
|
2477
|
-
|
|
2478
|
-
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2395
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
2479
2396
|
|
|
2480
2397
|
</dd>
|
|
2481
2398
|
</dl>
|
|
@@ -2494,7 +2411,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2494
2411
|
</dl>
|
|
2495
2412
|
</details>
|
|
2496
2413
|
|
|
2497
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2414
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2498
2415
|
<dl>
|
|
2499
2416
|
<dd>
|
|
2500
2417
|
|
|
@@ -2506,7 +2423,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2506
2423
|
<dl>
|
|
2507
2424
|
<dd>
|
|
2508
2425
|
|
|
2509
|
-
|
|
2426
|
+
Creates a **Config** which can be applied to EVI.
|
|
2510
2427
|
|
|
2511
2428
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2512
2429
|
|
|
@@ -2524,7 +2441,37 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2524
2441
|
<dd>
|
|
2525
2442
|
|
|
2526
2443
|
```typescript
|
|
2527
|
-
await client.empathicVoice.configs.
|
|
2444
|
+
await client.empathicVoice.configs.createConfig({
|
|
2445
|
+
name: "Weather Assistant Config",
|
|
2446
|
+
prompt: {
|
|
2447
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2448
|
+
version: 0,
|
|
2449
|
+
},
|
|
2450
|
+
eviVersion: "2",
|
|
2451
|
+
voice: {
|
|
2452
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2453
|
+
name: "SAMPLE VOICE",
|
|
2454
|
+
},
|
|
2455
|
+
languageModel: {
|
|
2456
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2457
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2458
|
+
temperature: 1,
|
|
2459
|
+
},
|
|
2460
|
+
eventMessages: {
|
|
2461
|
+
onNewChat: {
|
|
2462
|
+
enabled: false,
|
|
2463
|
+
text: "",
|
|
2464
|
+
},
|
|
2465
|
+
onInactivityTimeout: {
|
|
2466
|
+
enabled: false,
|
|
2467
|
+
text: "",
|
|
2468
|
+
},
|
|
2469
|
+
onMaxDurationTimeout: {
|
|
2470
|
+
enabled: false,
|
|
2471
|
+
text: "",
|
|
2472
|
+
},
|
|
2473
|
+
},
|
|
2474
|
+
});
|
|
2528
2475
|
```
|
|
2529
2476
|
|
|
2530
2477
|
</dd>
|
|
@@ -2540,21 +2487,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2540
2487
|
<dl>
|
|
2541
2488
|
<dd>
|
|
2542
2489
|
|
|
2543
|
-
**
|
|
2544
|
-
|
|
2545
|
-
</dd>
|
|
2546
|
-
</dl>
|
|
2547
|
-
|
|
2548
|
-
<dl>
|
|
2549
|
-
<dd>
|
|
2550
|
-
|
|
2551
|
-
**version:** `number`
|
|
2552
|
-
|
|
2553
|
-
Version number for a Config.
|
|
2554
|
-
|
|
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.
|
|
2556
|
-
|
|
2557
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2490
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
2558
2491
|
|
|
2559
2492
|
</dd>
|
|
2560
2493
|
</dl>
|
|
@@ -2573,7 +2506,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2573
2506
|
</dl>
|
|
2574
2507
|
</details>
|
|
2575
2508
|
|
|
2576
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2509
|
+
<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
2510
|
<dl>
|
|
2578
2511
|
<dd>
|
|
2579
2512
|
|
|
@@ -2585,7 +2518,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2585
2518
|
<dl>
|
|
2586
2519
|
<dd>
|
|
2587
2520
|
|
|
2588
|
-
|
|
2521
|
+
Fetches a list of a **Config's** versions.
|
|
2589
2522
|
|
|
2590
2523
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2591
2524
|
|
|
@@ -2603,7 +2536,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2603
2536
|
<dd>
|
|
2604
2537
|
|
|
2605
2538
|
```typescript
|
|
2606
|
-
await client.empathicVoice.configs.
|
|
2539
|
+
await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2607
2540
|
```
|
|
2608
2541
|
|
|
2609
2542
|
</dd>
|
|
@@ -2627,13 +2560,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2627
2560
|
<dl>
|
|
2628
2561
|
<dd>
|
|
2629
2562
|
|
|
2630
|
-
**
|
|
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.
|
|
2563
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2637
2564
|
|
|
2638
2565
|
</dd>
|
|
2639
2566
|
</dl>
|
|
@@ -2652,7 +2579,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2652
2579
|
</dl>
|
|
2653
2580
|
</details>
|
|
2654
2581
|
|
|
2655
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2582
|
+
<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
2583
|
<dl>
|
|
2657
2584
|
<dd>
|
|
2658
2585
|
|
|
@@ -2664,7 +2591,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2664
2591
|
<dl>
|
|
2665
2592
|
<dd>
|
|
2666
2593
|
|
|
2667
|
-
Updates
|
|
2594
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
2668
2595
|
|
|
2669
2596
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2670
2597
|
|
|
@@ -2682,8 +2609,39 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2682
2609
|
<dd>
|
|
2683
2610
|
|
|
2684
2611
|
```typescript
|
|
2685
|
-
await client.empathicVoice.configs.
|
|
2686
|
-
versionDescription: "This is an updated
|
|
2612
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2613
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2614
|
+
eviVersion: "2",
|
|
2615
|
+
prompt: {
|
|
2616
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2617
|
+
version: 0,
|
|
2618
|
+
},
|
|
2619
|
+
voice: {
|
|
2620
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2621
|
+
name: "ITO",
|
|
2622
|
+
},
|
|
2623
|
+
languageModel: {
|
|
2624
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2625
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2626
|
+
temperature: 1,
|
|
2627
|
+
},
|
|
2628
|
+
ellmModel: {
|
|
2629
|
+
allowShortResponses: true,
|
|
2630
|
+
},
|
|
2631
|
+
eventMessages: {
|
|
2632
|
+
onNewChat: {
|
|
2633
|
+
enabled: false,
|
|
2634
|
+
text: "",
|
|
2635
|
+
},
|
|
2636
|
+
onInactivityTimeout: {
|
|
2637
|
+
enabled: false,
|
|
2638
|
+
text: "",
|
|
2639
|
+
},
|
|
2640
|
+
onMaxDurationTimeout: {
|
|
2641
|
+
enabled: false,
|
|
2642
|
+
text: "",
|
|
2643
|
+
},
|
|
2644
|
+
},
|
|
2687
2645
|
});
|
|
2688
2646
|
```
|
|
2689
2647
|
|
|
@@ -2708,21 +2666,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
2708
2666
|
<dl>
|
|
2709
2667
|
<dd>
|
|
2710
2668
|
|
|
2711
|
-
**
|
|
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`
|
|
2669
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2726
2670
|
|
|
2727
2671
|
</dd>
|
|
2728
2672
|
</dl>
|
|
@@ -2741,9 +2685,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2741
2685
|
</dl>
|
|
2742
2686
|
</details>
|
|
2743
2687
|
|
|
2744
|
-
|
|
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>
|
|
2688
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
2747
2689
|
<dl>
|
|
2748
2690
|
<dd>
|
|
2749
2691
|
|
|
@@ -2755,7 +2697,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2755
2697
|
<dl>
|
|
2756
2698
|
<dd>
|
|
2757
2699
|
|
|
2758
|
-
|
|
2700
|
+
Deletes a **Config** and its versions.
|
|
2701
|
+
|
|
2702
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2759
2703
|
|
|
2760
2704
|
</dd>
|
|
2761
2705
|
</dl>
|
|
@@ -2771,11 +2715,7 @@ Fetches a paginated list of **Chats**.
|
|
|
2771
2715
|
<dd>
|
|
2772
2716
|
|
|
2773
2717
|
```typescript
|
|
2774
|
-
await client.empathicVoice.
|
|
2775
|
-
pageNumber: 0,
|
|
2776
|
-
pageSize: 1,
|
|
2777
|
-
ascendingOrder: true,
|
|
2778
|
-
});
|
|
2718
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2779
2719
|
```
|
|
2780
2720
|
|
|
2781
2721
|
</dd>
|
|
@@ -2791,7 +2731,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2791
2731
|
<dl>
|
|
2792
2732
|
<dd>
|
|
2793
2733
|
|
|
2794
|
-
**
|
|
2734
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2795
2735
|
|
|
2796
2736
|
</dd>
|
|
2797
2737
|
</dl>
|
|
@@ -2799,7 +2739,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2799
2739
|
<dl>
|
|
2800
2740
|
<dd>
|
|
2801
2741
|
|
|
2802
|
-
**requestOptions:** `
|
|
2742
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2803
2743
|
|
|
2804
2744
|
</dd>
|
|
2805
2745
|
</dl>
|
|
@@ -2810,7 +2750,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2810
2750
|
</dl>
|
|
2811
2751
|
</details>
|
|
2812
2752
|
|
|
2813
|
-
<details><summary><code>client.empathicVoice.
|
|
2753
|
+
<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
2754
|
<dl>
|
|
2815
2755
|
<dd>
|
|
2816
2756
|
|
|
@@ -2822,7 +2762,9 @@ await client.empathicVoice.chats.listChats({
|
|
|
2822
2762
|
<dl>
|
|
2823
2763
|
<dd>
|
|
2824
2764
|
|
|
2825
|
-
|
|
2765
|
+
Updates the name of a **Config**.
|
|
2766
|
+
|
|
2767
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2826
2768
|
|
|
2827
2769
|
</dd>
|
|
2828
2770
|
</dl>
|
|
@@ -2838,10 +2780,8 @@ Fetches a paginated list of **Chat** events.
|
|
|
2838
2780
|
<dd>
|
|
2839
2781
|
|
|
2840
2782
|
```typescript
|
|
2841
|
-
await client.empathicVoice.
|
|
2842
|
-
|
|
2843
|
-
pageSize: 3,
|
|
2844
|
-
ascendingOrder: true,
|
|
2783
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2784
|
+
name: "Updated Weather Assistant Config Name",
|
|
2845
2785
|
});
|
|
2846
2786
|
```
|
|
2847
2787
|
|
|
@@ -2858,7 +2798,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2858
2798
|
<dl>
|
|
2859
2799
|
<dd>
|
|
2860
2800
|
|
|
2861
|
-
**id:** `string` — Identifier for a
|
|
2801
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2862
2802
|
|
|
2863
2803
|
</dd>
|
|
2864
2804
|
</dl>
|
|
@@ -2866,7 +2806,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2866
2806
|
<dl>
|
|
2867
2807
|
<dd>
|
|
2868
2808
|
|
|
2869
|
-
**request:** `Hume.empathicVoice.
|
|
2809
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2870
2810
|
|
|
2871
2811
|
</dd>
|
|
2872
2812
|
</dl>
|
|
@@ -2874,7 +2814,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2874
2814
|
<dl>
|
|
2875
2815
|
<dd>
|
|
2876
2816
|
|
|
2877
|
-
**requestOptions:** `
|
|
2817
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2878
2818
|
|
|
2879
2819
|
</dd>
|
|
2880
2820
|
</dl>
|
|
@@ -2885,7 +2825,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2885
2825
|
</dl>
|
|
2886
2826
|
</details>
|
|
2887
2827
|
|
|
2888
|
-
<details><summary><code>client.empathicVoice.
|
|
2828
|
+
<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
2829
|
<dl>
|
|
2890
2830
|
<dd>
|
|
2891
2831
|
|
|
@@ -2897,7 +2837,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2897
2837
|
<dl>
|
|
2898
2838
|
<dd>
|
|
2899
2839
|
|
|
2900
|
-
Fetches
|
|
2840
|
+
Fetches a specified version of a **Config**.
|
|
2841
|
+
|
|
2842
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2901
2843
|
|
|
2902
2844
|
</dd>
|
|
2903
2845
|
</dl>
|
|
@@ -2913,7 +2855,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
|
|
|
2913
2855
|
<dd>
|
|
2914
2856
|
|
|
2915
2857
|
```typescript
|
|
2916
|
-
await client.empathicVoice.
|
|
2858
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2917
2859
|
```
|
|
2918
2860
|
|
|
2919
2861
|
</dd>
|
|
@@ -2929,7 +2871,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2929
2871
|
<dl>
|
|
2930
2872
|
<dd>
|
|
2931
2873
|
|
|
2932
|
-
**id:** `string` — Identifier for a
|
|
2874
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2933
2875
|
|
|
2934
2876
|
</dd>
|
|
2935
2877
|
</dl>
|
|
@@ -2937,7 +2879,21 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2937
2879
|
<dl>
|
|
2938
2880
|
<dd>
|
|
2939
2881
|
|
|
2940
|
-
**
|
|
2882
|
+
**version:** `number`
|
|
2883
|
+
|
|
2884
|
+
Version number for a Config.
|
|
2885
|
+
|
|
2886
|
+
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.
|
|
2887
|
+
|
|
2888
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2889
|
+
|
|
2890
|
+
</dd>
|
|
2891
|
+
</dl>
|
|
2892
|
+
|
|
2893
|
+
<dl>
|
|
2894
|
+
<dd>
|
|
2895
|
+
|
|
2896
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2941
2897
|
|
|
2942
2898
|
</dd>
|
|
2943
2899
|
</dl>
|
|
@@ -2948,9 +2904,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2948
2904
|
</dl>
|
|
2949
2905
|
</details>
|
|
2950
2906
|
|
|
2951
|
-
|
|
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>
|
|
2907
|
+
<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
2908
|
<dl>
|
|
2955
2909
|
<dd>
|
|
2956
2910
|
|
|
@@ -2962,7 +2916,9 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2962
2916
|
<dl>
|
|
2963
2917
|
<dd>
|
|
2964
2918
|
|
|
2965
|
-
|
|
2919
|
+
Deletes a specified version of a **Config**.
|
|
2920
|
+
|
|
2921
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2966
2922
|
|
|
2967
2923
|
</dd>
|
|
2968
2924
|
</dl>
|
|
@@ -2978,12 +2934,7 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
2978
2934
|
<dd>
|
|
2979
2935
|
|
|
2980
2936
|
```typescript
|
|
2981
|
-
await client.empathicVoice.
|
|
2982
|
-
pageNumber: 0,
|
|
2983
|
-
pageSize: 1,
|
|
2984
|
-
ascendingOrder: true,
|
|
2985
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2986
|
-
});
|
|
2937
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2987
2938
|
```
|
|
2988
2939
|
|
|
2989
2940
|
</dd>
|
|
@@ -2999,7 +2950,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2999
2950
|
<dl>
|
|
3000
2951
|
<dd>
|
|
3001
2952
|
|
|
3002
|
-
**
|
|
2953
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
3003
2954
|
|
|
3004
2955
|
</dd>
|
|
3005
2956
|
</dl>
|
|
@@ -3007,7 +2958,21 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3007
2958
|
<dl>
|
|
3008
2959
|
<dd>
|
|
3009
2960
|
|
|
3010
|
-
**
|
|
2961
|
+
**version:** `number`
|
|
2962
|
+
|
|
2963
|
+
Version number for a Config.
|
|
2964
|
+
|
|
2965
|
+
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.
|
|
2966
|
+
|
|
2967
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2968
|
+
|
|
2969
|
+
</dd>
|
|
2970
|
+
</dl>
|
|
2971
|
+
|
|
2972
|
+
<dl>
|
|
2973
|
+
<dd>
|
|
2974
|
+
|
|
2975
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
3011
2976
|
|
|
3012
2977
|
</dd>
|
|
3013
2978
|
</dl>
|
|
@@ -3018,7 +2983,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3018
2983
|
</dl>
|
|
3019
2984
|
</details>
|
|
3020
2985
|
|
|
3021
|
-
<details><summary><code>client.empathicVoice.
|
|
2986
|
+
<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
2987
|
<dl>
|
|
3023
2988
|
<dd>
|
|
3024
2989
|
|
|
@@ -3030,7 +2995,9 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3030
2995
|
<dl>
|
|
3031
2996
|
<dd>
|
|
3032
2997
|
|
|
3033
|
-
|
|
2998
|
+
Updates the description of a **Config**.
|
|
2999
|
+
|
|
3000
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
3034
3001
|
|
|
3035
3002
|
</dd>
|
|
3036
3003
|
</dl>
|
|
@@ -3046,10 +3013,8 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
3046
3013
|
<dd>
|
|
3047
3014
|
|
|
3048
3015
|
```typescript
|
|
3049
|
-
await client.empathicVoice.
|
|
3050
|
-
|
|
3051
|
-
pageSize: 1,
|
|
3052
|
-
ascendingOrder: true,
|
|
3016
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
3017
|
+
versionDescription: "This is an updated version_description.",
|
|
3053
3018
|
});
|
|
3054
3019
|
```
|
|
3055
3020
|
|
|
@@ -3066,7 +3031,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3066
3031
|
<dl>
|
|
3067
3032
|
<dd>
|
|
3068
3033
|
|
|
3069
|
-
**id:** `string` — Identifier for a
|
|
3034
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
3070
3035
|
|
|
3071
3036
|
</dd>
|
|
3072
3037
|
</dl>
|
|
@@ -3074,7 +3039,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3074
3039
|
<dl>
|
|
3075
3040
|
<dd>
|
|
3076
3041
|
|
|
3077
|
-
**
|
|
3042
|
+
**version:** `number`
|
|
3043
|
+
|
|
3044
|
+
Version number for a Config.
|
|
3045
|
+
|
|
3046
|
+
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.
|
|
3047
|
+
|
|
3048
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
3078
3049
|
|
|
3079
3050
|
</dd>
|
|
3080
3051
|
</dl>
|
|
@@ -3082,7 +3053,15 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3082
3053
|
<dl>
|
|
3083
3054
|
<dd>
|
|
3084
3055
|
|
|
3085
|
-
**
|
|
3056
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
3057
|
+
|
|
3058
|
+
</dd>
|
|
3059
|
+
</dl>
|
|
3060
|
+
|
|
3061
|
+
<dl>
|
|
3062
|
+
<dd>
|
|
3063
|
+
|
|
3064
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
3086
3065
|
|
|
3087
3066
|
</dd>
|
|
3088
3067
|
</dl>
|
|
@@ -3093,7 +3072,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3093
3072
|
</dl>
|
|
3094
3073
|
</details>
|
|
3095
3074
|
|
|
3096
|
-
|
|
3075
|
+
## EmpathicVoice Chats
|
|
3076
|
+
|
|
3077
|
+
<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
3078
|
<dl>
|
|
3098
3079
|
<dd>
|
|
3099
3080
|
|
|
@@ -3105,7 +3086,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3105
3086
|
<dl>
|
|
3106
3087
|
<dd>
|
|
3107
3088
|
|
|
3108
|
-
Fetches a paginated list of **
|
|
3089
|
+
Fetches a paginated list of **Chats**.
|
|
3109
3090
|
|
|
3110
3091
|
</dd>
|
|
3111
3092
|
</dl>
|
|
@@ -3121,9 +3102,9 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
3121
3102
|
<dd>
|
|
3122
3103
|
|
|
3123
3104
|
```typescript
|
|
3124
|
-
await client.empathicVoice.
|
|
3105
|
+
await client.empathicVoice.chats.listChats({
|
|
3125
3106
|
pageNumber: 0,
|
|
3126
|
-
pageSize:
|
|
3107
|
+
pageSize: 1,
|
|
3127
3108
|
ascendingOrder: true,
|
|
3128
3109
|
});
|
|
3129
3110
|
```
|
|
@@ -3141,15 +3122,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3141
3122
|
<dl>
|
|
3142
3123
|
<dd>
|
|
3143
3124
|
|
|
3144
|
-
**
|
|
3145
|
-
|
|
3146
|
-
</dd>
|
|
3147
|
-
</dl>
|
|
3148
|
-
|
|
3149
|
-
<dl>
|
|
3150
|
-
<dd>
|
|
3151
|
-
|
|
3152
|
-
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3125
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
3153
3126
|
|
|
3154
3127
|
</dd>
|
|
3155
3128
|
</dl>
|
|
@@ -3157,7 +3130,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3157
3130
|
<dl>
|
|
3158
3131
|
<dd>
|
|
3159
3132
|
|
|
3160
|
-
**requestOptions:** `
|
|
3133
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
3161
3134
|
|
|
3162
3135
|
</dd>
|
|
3163
3136
|
</dl>
|
|
@@ -3168,7 +3141,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3168
3141
|
</dl>
|
|
3169
3142
|
</details>
|
|
3170
3143
|
|
|
3171
|
-
<details><summary><code>client.empathicVoice.
|
|
3144
|
+
<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
3145
|
<dl>
|
|
3173
3146
|
<dd>
|
|
3174
3147
|
|
|
@@ -3180,7 +3153,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3180
3153
|
<dl>
|
|
3181
3154
|
<dd>
|
|
3182
3155
|
|
|
3183
|
-
Fetches a paginated list of
|
|
3156
|
+
Fetches a paginated list of **Chat** events.
|
|
3184
3157
|
|
|
3185
3158
|
</dd>
|
|
3186
3159
|
</dl>
|
|
@@ -3196,9 +3169,9 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
|
|
|
3196
3169
|
<dd>
|
|
3197
3170
|
|
|
3198
3171
|
```typescript
|
|
3199
|
-
await client.empathicVoice.
|
|
3172
|
+
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
3200
3173
|
pageNumber: 0,
|
|
3201
|
-
pageSize:
|
|
3174
|
+
pageSize: 3,
|
|
3202
3175
|
ascendingOrder: true,
|
|
3203
3176
|
});
|
|
3204
3177
|
```
|
|
@@ -3216,7 +3189,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3216
3189
|
<dl>
|
|
3217
3190
|
<dd>
|
|
3218
3191
|
|
|
3219
|
-
**id:** `string` — Identifier for a Chat
|
|
3192
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
3220
3193
|
|
|
3221
3194
|
</dd>
|
|
3222
3195
|
</dl>
|
|
@@ -3224,7 +3197,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3224
3197
|
<dl>
|
|
3225
3198
|
<dd>
|
|
3226
3199
|
|
|
3227
|
-
**request:** `Hume.empathicVoice.
|
|
3200
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
3228
3201
|
|
|
3229
3202
|
</dd>
|
|
3230
3203
|
</dl>
|
|
@@ -3232,7 +3205,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3232
3205
|
<dl>
|
|
3233
3206
|
<dd>
|
|
3234
3207
|
|
|
3235
|
-
**requestOptions:** `
|
|
3208
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
3236
3209
|
|
|
3237
3210
|
</dd>
|
|
3238
3211
|
</dl>
|
|
@@ -3243,9 +3216,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3243
3216
|
</dl>
|
|
3244
3217
|
</details>
|
|
3245
3218
|
|
|
3246
|
-
|
|
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>
|
|
3219
|
+
<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
3220
|
<dl>
|
|
3250
3221
|
<dd>
|
|
3251
3222
|
|
|
@@ -3257,7 +3228,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3257
3228
|
<dl>
|
|
3258
3229
|
<dd>
|
|
3259
3230
|
|
|
3260
|
-
|
|
3231
|
+
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
3232
|
|
|
3262
3233
|
</dd>
|
|
3263
3234
|
</dl>
|
|
@@ -3273,7 +3244,7 @@ Sort and filter jobs.
|
|
|
3273
3244
|
<dd>
|
|
3274
3245
|
|
|
3275
3246
|
```typescript
|
|
3276
|
-
await client.
|
|
3247
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
3277
3248
|
```
|
|
3278
3249
|
|
|
3279
3250
|
</dd>
|
|
@@ -3289,7 +3260,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
3289
3260
|
<dl>
|
|
3290
3261
|
<dd>
|
|
3291
3262
|
|
|
3292
|
-
**
|
|
3263
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
3293
3264
|
|
|
3294
3265
|
</dd>
|
|
3295
3266
|
</dl>
|
|
@@ -3297,7 +3268,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
3297
3268
|
<dl>
|
|
3298
3269
|
<dd>
|
|
3299
3270
|
|
|
3300
|
-
**requestOptions:** `
|
|
3271
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
3301
3272
|
|
|
3302
3273
|
</dd>
|
|
3303
3274
|
</dl>
|
|
@@ -3308,7 +3279,9 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
3308
3279
|
</dl>
|
|
3309
3280
|
</details>
|
|
3310
3281
|
|
|
3311
|
-
|
|
3282
|
+
## EmpathicVoice ChatGroups
|
|
3283
|
+
|
|
3284
|
+
<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
3285
|
<dl>
|
|
3313
3286
|
<dd>
|
|
3314
3287
|
|
|
@@ -3320,7 +3293,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
3320
3293
|
<dl>
|
|
3321
3294
|
<dd>
|
|
3322
3295
|
|
|
3323
|
-
|
|
3296
|
+
Fetches a paginated list of **Chat Groups**.
|
|
3324
3297
|
|
|
3325
3298
|
</dd>
|
|
3326
3299
|
</dl>
|
|
@@ -3336,9 +3309,11 @@ Start a new measurement inference job.
|
|
|
3336
3309
|
<dd>
|
|
3337
3310
|
|
|
3338
3311
|
```typescript
|
|
3339
|
-
await client.
|
|
3340
|
-
|
|
3341
|
-
|
|
3312
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
3313
|
+
pageNumber: 0,
|
|
3314
|
+
pageSize: 1,
|
|
3315
|
+
ascendingOrder: true,
|
|
3316
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
3342
3317
|
});
|
|
3343
3318
|
```
|
|
3344
3319
|
|
|
@@ -3355,7 +3330,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3355
3330
|
<dl>
|
|
3356
3331
|
<dd>
|
|
3357
3332
|
|
|
3358
|
-
**request:** `Hume.
|
|
3333
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
3359
3334
|
|
|
3360
3335
|
</dd>
|
|
3361
3336
|
</dl>
|
|
@@ -3363,7 +3338,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3363
3338
|
<dl>
|
|
3364
3339
|
<dd>
|
|
3365
3340
|
|
|
3366
|
-
**requestOptions:** `
|
|
3341
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3367
3342
|
|
|
3368
3343
|
</dd>
|
|
3369
3344
|
</dl>
|
|
@@ -3374,7 +3349,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3374
3349
|
</dl>
|
|
3375
3350
|
</details>
|
|
3376
3351
|
|
|
3377
|
-
<details><summary><code>client.
|
|
3352
|
+
<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
3353
|
<dl>
|
|
3379
3354
|
<dd>
|
|
3380
3355
|
|
|
@@ -3386,7 +3361,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3386
3361
|
<dl>
|
|
3387
3362
|
<dd>
|
|
3388
3363
|
|
|
3389
|
-
|
|
3364
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
3390
3365
|
|
|
3391
3366
|
</dd>
|
|
3392
3367
|
</dl>
|
|
@@ -3402,7 +3377,11 @@ Get the request details and state of a given job.
|
|
|
3402
3377
|
<dd>
|
|
3403
3378
|
|
|
3404
3379
|
```typescript
|
|
3405
|
-
await client.
|
|
3380
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3381
|
+
pageNumber: 0,
|
|
3382
|
+
pageSize: 1,
|
|
3383
|
+
ascendingOrder: true,
|
|
3384
|
+
});
|
|
3406
3385
|
```
|
|
3407
3386
|
|
|
3408
3387
|
</dd>
|
|
@@ -3418,7 +3397,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3418
3397
|
<dl>
|
|
3419
3398
|
<dd>
|
|
3420
3399
|
|
|
3421
|
-
**id:** `string` —
|
|
3400
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3422
3401
|
|
|
3423
3402
|
</dd>
|
|
3424
3403
|
</dl>
|
|
@@ -3426,7 +3405,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3426
3405
|
<dl>
|
|
3427
3406
|
<dd>
|
|
3428
3407
|
|
|
3429
|
-
**
|
|
3408
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3409
|
+
|
|
3410
|
+
</dd>
|
|
3411
|
+
</dl>
|
|
3412
|
+
|
|
3413
|
+
<dl>
|
|
3414
|
+
<dd>
|
|
3415
|
+
|
|
3416
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3430
3417
|
|
|
3431
3418
|
</dd>
|
|
3432
3419
|
</dl>
|
|
@@ -3437,7 +3424,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3437
3424
|
</dl>
|
|
3438
3425
|
</details>
|
|
3439
3426
|
|
|
3440
|
-
<details><summary><code>client.
|
|
3427
|
+
<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
3428
|
<dl>
|
|
3442
3429
|
<dd>
|
|
3443
3430
|
|
|
@@ -3449,7 +3436,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3449
3436
|
<dl>
|
|
3450
3437
|
<dd>
|
|
3451
3438
|
|
|
3452
|
-
|
|
3439
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
3453
3440
|
|
|
3454
3441
|
</dd>
|
|
3455
3442
|
</dl>
|
|
@@ -3465,7 +3452,11 @@ Get the JSON predictions of a completed inference job.
|
|
|
3465
3452
|
<dd>
|
|
3466
3453
|
|
|
3467
3454
|
```typescript
|
|
3468
|
-
await client.
|
|
3455
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3456
|
+
pageNumber: 0,
|
|
3457
|
+
pageSize: 3,
|
|
3458
|
+
ascendingOrder: true,
|
|
3459
|
+
});
|
|
3469
3460
|
```
|
|
3470
3461
|
|
|
3471
3462
|
</dd>
|
|
@@ -3481,7 +3472,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3481
3472
|
<dl>
|
|
3482
3473
|
<dd>
|
|
3483
3474
|
|
|
3484
|
-
**id:** `string` —
|
|
3475
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3485
3476
|
|
|
3486
3477
|
</dd>
|
|
3487
3478
|
</dl>
|
|
@@ -3489,7 +3480,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3489
3480
|
<dl>
|
|
3490
3481
|
<dd>
|
|
3491
3482
|
|
|
3492
|
-
**
|
|
3483
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3484
|
+
|
|
3485
|
+
</dd>
|
|
3486
|
+
</dl>
|
|
3487
|
+
|
|
3488
|
+
<dl>
|
|
3489
|
+
<dd>
|
|
3490
|
+
|
|
3491
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3493
3492
|
|
|
3494
3493
|
</dd>
|
|
3495
3494
|
</dl>
|
|
@@ -3500,7 +3499,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3500
3499
|
</dl>
|
|
3501
3500
|
</details>
|
|
3502
3501
|
|
|
3503
|
-
<details><summary><code>client.
|
|
3502
|
+
<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
3503
|
<dl>
|
|
3505
3504
|
<dd>
|
|
3506
3505
|
|
|
@@ -3512,7 +3511,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3512
3511
|
<dl>
|
|
3513
3512
|
<dd>
|
|
3514
3513
|
|
|
3515
|
-
|
|
3514
|
+
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
3515
|
|
|
3517
3516
|
</dd>
|
|
3518
3517
|
</dl>
|
|
@@ -3528,10 +3527,11 @@ Start a new batch inference job.
|
|
|
3528
3527
|
<dd>
|
|
3529
3528
|
|
|
3530
3529
|
```typescript
|
|
3531
|
-
await client.
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3530
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
3531
|
+
pageNumber: 0,
|
|
3532
|
+
pageSize: 10,
|
|
3533
|
+
ascendingOrder: true,
|
|
3534
|
+
});
|
|
3535
3535
|
```
|
|
3536
3536
|
|
|
3537
3537
|
</dd>
|
|
@@ -3547,7 +3547,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3547
3547
|
<dl>
|
|
3548
3548
|
<dd>
|
|
3549
3549
|
|
|
3550
|
-
**
|
|
3550
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3551
3551
|
|
|
3552
3552
|
</dd>
|
|
3553
3553
|
</dl>
|
|
@@ -3555,7 +3555,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3555
3555
|
<dl>
|
|
3556
3556
|
<dd>
|
|
3557
3557
|
|
|
3558
|
-
**request:** `Hume.
|
|
3558
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
3559
3559
|
|
|
3560
3560
|
</dd>
|
|
3561
3561
|
</dl>
|
|
@@ -3563,7 +3563,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3563
3563
|
<dl>
|
|
3564
3564
|
<dd>
|
|
3565
3565
|
|
|
3566
|
-
**requestOptions:** `
|
|
3566
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3567
3567
|
|
|
3568
3568
|
</dd>
|
|
3569
3569
|
</dl>
|