hume 0.15.3 → 0.15.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/reference.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Reference
2
- ## Tts
3
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
2
+ ## EmpathicVoice ControlPlane
3
+ <details><summary><code>client.empathicVoice.controlPlane.<a href="/src/api/resources/empathicVoice/resources/controlPlane/client/Client.ts">send</a>(chatId, { ...params }) -> void</code></summary>
4
4
  <dl>
5
5
  <dd>
6
6
 
@@ -12,9 +12,7 @@
12
12
  <dl>
13
13
  <dd>
14
14
 
15
- Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
16
-
17
- The response includes the base64-encoded audio and metadata in JSON format.
15
+ Send a message to a specific chat.
18
16
  </dd>
19
17
  </dl>
20
18
  </dd>
@@ -29,21 +27,8 @@ The response includes the base64-encoded audio and metadata in JSON format.
29
27
  <dd>
30
28
 
31
29
  ```typescript
32
- await client.tts.synthesizeJson({
33
- context: {
34
- utterances: [{
35
- text: "How can people see beauty so differently?",
36
- description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
37
- }]
38
- },
39
- format: {
40
- type: "mp3"
41
- },
42
- numGenerations: 1,
43
- utterances: [{
44
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
45
- description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
46
- }]
30
+ await client.empathicVoice.controlPlane.send("chat_id", {
31
+ type: "session_settings"
47
32
  });
48
33
 
49
34
  ```
@@ -60,7 +45,7 @@ await client.tts.synthesizeJson({
60
45
  <dl>
61
46
  <dd>
62
47
 
63
- **request:** `Hume.PostedTts`
48
+ **chatId:** `string`
64
49
 
65
50
  </dd>
66
51
  </dl>
@@ -68,7 +53,15 @@ await client.tts.synthesizeJson({
68
53
  <dl>
69
54
  <dd>
70
55
 
71
- **requestOptions:** `Tts.RequestOptions`
56
+ **request:** `Hume.ControlPlanePublishEvent`
57
+
58
+ </dd>
59
+ </dl>
60
+
61
+ <dl>
62
+ <dd>
63
+
64
+ **requestOptions:** `ControlPlane.RequestOptions`
72
65
 
73
66
  </dd>
74
67
  </dl>
@@ -80,7 +73,8 @@ await client.tts.synthesizeJson({
80
73
  </dl>
81
74
  </details>
82
75
 
83
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> core.BinaryResponse</code></summary>
76
+ ## EmpathicVoice Tools
77
+ <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), Hume.ReturnPagedUserDefinedTools></code></summary>
84
78
  <dl>
85
79
  <dd>
86
80
 
@@ -92,9 +86,9 @@ await client.tts.synthesizeJson({
92
86
  <dl>
93
87
  <dd>
94
88
 
95
- Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
89
+ Fetches a paginated list of **Tools**.
96
90
 
97
- The response contains the generated audio file in the requested format.
91
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
98
92
  </dd>
99
93
  </dl>
100
94
  </dd>
@@ -109,19 +103,25 @@ The response contains the generated audio file in the requested format.
109
103
  <dd>
110
104
 
111
105
  ```typescript
112
- await client.tts.synthesizeFile({
113
- context: {
114
- generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2"
115
- },
116
- format: {
117
- type: "mp3"
118
- },
119
- numGenerations: 1,
120
- utterances: [{
121
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
122
- description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
123
- }]
106
+ const pageableResponse = await client.empathicVoice.tools.listTools({
107
+ pageNumber: 0,
108
+ pageSize: 2
109
+ });
110
+ for await (const item of pageableResponse) {
111
+ console.log(item);
112
+ }
113
+
114
+ // Or you can manually iterate page-by-page
115
+ let page = await client.empathicVoice.tools.listTools({
116
+ pageNumber: 0,
117
+ pageSize: 2
124
118
  });
119
+ while (page.hasNextPage()) {
120
+ page = page.getNextPage();
121
+ }
122
+
123
+ // You can also access the underlying response
124
+ const response = page.response;
125
125
 
126
126
  ```
127
127
  </dd>
@@ -137,7 +137,7 @@ await client.tts.synthesizeFile({
137
137
  <dl>
138
138
  <dd>
139
139
 
140
- **request:** `Hume.PostedTts`
140
+ **request:** `Hume.empathicVoice.ToolsListToolsRequest`
141
141
 
142
142
  </dd>
143
143
  </dl>
@@ -145,7 +145,7 @@ await client.tts.synthesizeFile({
145
145
  <dl>
146
146
  <dd>
147
147
 
148
- **requestOptions:** `Tts.RequestOptions`
148
+ **requestOptions:** `Tools.RequestOptions`
149
149
 
150
150
  </dd>
151
151
  </dl>
@@ -157,7 +157,7 @@ await client.tts.synthesizeFile({
157
157
  </dl>
158
158
  </details>
159
159
 
160
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> core.BinaryResponse</code></summary>
160
+ <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>
161
161
  <dl>
162
162
  <dd>
163
163
 
@@ -169,7 +169,9 @@ await client.tts.synthesizeFile({
169
169
  <dl>
170
170
  <dd>
171
171
 
172
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
172
+ Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
173
+
174
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
173
175
  </dd>
174
176
  </dl>
175
177
  </dd>
@@ -184,14 +186,12 @@ Streams synthesized speech using the specified voice. If no voice is provided, a
184
186
  <dd>
185
187
 
186
188
  ```typescript
187
- await client.tts.synthesizeFileStreaming({
188
- utterances: [{
189
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
190
- voice: {
191
- name: "Male English Actor",
192
- provider: "HUME_AI"
193
- }
194
- }]
189
+ await client.empathicVoice.tools.createTool({
190
+ name: "get_current_weather",
191
+ parameters: "{ \"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\"] }",
192
+ versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
193
+ description: "This tool is for getting the current weather.",
194
+ fallbackContent: "Unable to fetch current weather."
195
195
  });
196
196
 
197
197
  ```
@@ -208,7 +208,7 @@ await client.tts.synthesizeFileStreaming({
208
208
  <dl>
209
209
  <dd>
210
210
 
211
- **request:** `Hume.PostedTts`
211
+ **request:** `Hume.empathicVoice.PostedUserDefinedTool`
212
212
 
213
213
  </dd>
214
214
  </dl>
@@ -216,7 +216,7 @@ await client.tts.synthesizeFileStreaming({
216
216
  <dl>
217
217
  <dd>
218
218
 
219
- **requestOptions:** `Tts.RequestOptions`
219
+ **requestOptions:** `Tools.RequestOptions`
220
220
 
221
221
  </dd>
222
222
  </dl>
@@ -228,7 +228,7 @@ await client.tts.synthesizeFileStreaming({
228
228
  </dl>
229
229
  </details>
230
230
 
231
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
231
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
232
232
  <dl>
233
233
  <dd>
234
234
 
@@ -240,9 +240,9 @@ await client.tts.synthesizeFileStreaming({
240
240
  <dl>
241
241
  <dd>
242
242
 
243
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
243
+ Fetches a list of a **Tool's** versions.
244
244
 
245
- The response is a stream of JSON objects including audio encoded in base64.
245
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
246
246
  </dd>
247
247
  </dl>
248
248
  </dd>
@@ -257,19 +257,20 @@ The response is a stream of JSON objects including audio encoded in base64.
257
257
  <dd>
258
258
 
259
259
  ```typescript
260
- const response = await client.tts.synthesizeJsonStreaming({
261
- utterances: [{
262
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
263
- voice: {
264
- name: "Male English Actor",
265
- provider: "HUME_AI"
266
- }
267
- }]
268
- });
269
- for await (const item of response) {
260
+ const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
261
+ for await (const item of pageableResponse) {
270
262
  console.log(item);
271
263
  }
272
264
 
265
+ // Or you can manually iterate page-by-page
266
+ let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
267
+ while (page.hasNextPage()) {
268
+ page = page.getNextPage();
269
+ }
270
+
271
+ // You can also access the underlying response
272
+ const response = page.response;
273
+
273
274
  ```
274
275
  </dd>
275
276
  </dl>
@@ -284,7 +285,7 @@ for await (const item of response) {
284
285
  <dl>
285
286
  <dd>
286
287
 
287
- **request:** `Hume.PostedTts`
288
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
288
289
 
289
290
  </dd>
290
291
  </dl>
@@ -292,7 +293,15 @@ for await (const item of response) {
292
293
  <dl>
293
294
  <dd>
294
295
 
295
- **requestOptions:** `Tts.RequestOptions`
296
+ **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
297
+
298
+ </dd>
299
+ </dl>
300
+
301
+ <dl>
302
+ <dd>
303
+
304
+ **requestOptions:** `Tools.RequestOptions`
296
305
 
297
306
  </dd>
298
307
  </dl>
@@ -304,10 +313,26 @@ for await (const item of response) {
304
313
  </dl>
305
314
  </details>
306
315
 
307
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
316
+ <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>
317
+ <dl>
318
+ <dd>
319
+
320
+ #### 📝 Description
321
+
308
322
  <dl>
309
323
  <dd>
310
324
 
325
+ <dl>
326
+ <dd>
327
+
328
+ Updates a **Tool** by creating a new version of the **Tool**.
329
+
330
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
331
+ </dd>
332
+ </dl>
333
+ </dd>
334
+ </dl>
335
+
311
336
  #### 🔌 Usage
312
337
 
313
338
  <dl>
@@ -317,10 +342,12 @@ for await (const item of response) {
317
342
  <dd>
318
343
 
319
344
  ```typescript
320
- const response = await client.tts.convertVoiceJson({});
321
- for await (const item of response) {
322
- console.log(item);
323
- }
345
+ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
346
+ parameters: "{ \"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\"] }",
347
+ versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
348
+ fallbackContent: "Unable to fetch current weather.",
349
+ description: "This tool is for getting the current weather."
350
+ });
324
351
 
325
352
  ```
326
353
  </dd>
@@ -336,7 +363,7 @@ for await (const item of response) {
336
363
  <dl>
337
364
  <dd>
338
365
 
339
- **request:** `Hume.tts.ConvertVoiceJsonRequest`
366
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
340
367
 
341
368
  </dd>
342
369
  </dl>
@@ -344,7 +371,15 @@ for await (const item of response) {
344
371
  <dl>
345
372
  <dd>
346
373
 
347
- **requestOptions:** `Tts.RequestOptions`
374
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
375
+
376
+ </dd>
377
+ </dl>
378
+
379
+ <dl>
380
+ <dd>
381
+
382
+ **requestOptions:** `Tools.RequestOptions`
348
383
 
349
384
  </dd>
350
385
  </dl>
@@ -356,8 +391,7 @@ for await (const item of response) {
356
391
  </dl>
357
392
  </details>
358
393
 
359
- ## Tts Voices
360
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
394
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
361
395
  <dl>
362
396
  <dd>
363
397
 
@@ -369,7 +403,9 @@ for await (const item of response) {
369
403
  <dl>
370
404
  <dd>
371
405
 
372
- Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
406
+ Deletes a **Tool** and its versions.
407
+
408
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
373
409
  </dd>
374
410
  </dl>
375
411
  </dd>
@@ -384,23 +420,7 @@ Lists voices you have saved in your account, or voices from the [Voice Library](
384
420
  <dd>
385
421
 
386
422
  ```typescript
387
- const pageableResponse = await client.tts.voices.list({
388
- provider: "CUSTOM_VOICE"
389
- });
390
- for await (const item of pageableResponse) {
391
- console.log(item);
392
- }
393
-
394
- // Or you can manually iterate page-by-page
395
- let page = await client.tts.voices.list({
396
- provider: "CUSTOM_VOICE"
397
- });
398
- while (page.hasNextPage()) {
399
- page = page.getNextPage();
400
- }
401
-
402
- // You can also access the underlying response
403
- const response = page.response;
423
+ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
404
424
 
405
425
  ```
406
426
  </dd>
@@ -416,7 +436,7 @@ const response = page.response;
416
436
  <dl>
417
437
  <dd>
418
438
 
419
- **request:** `Hume.tts.VoicesListRequest`
439
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
420
440
 
421
441
  </dd>
422
442
  </dl>
@@ -424,7 +444,7 @@ const response = page.response;
424
444
  <dl>
425
445
  <dd>
426
446
 
427
- **requestOptions:** `Voices.RequestOptions`
447
+ **requestOptions:** `Tools.RequestOptions`
428
448
 
429
449
  </dd>
430
450
  </dl>
@@ -436,7 +456,7 @@ const response = page.response;
436
456
  </dl>
437
457
  </details>
438
458
 
439
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
459
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
440
460
  <dl>
441
461
  <dd>
442
462
 
@@ -448,9 +468,9 @@ const response = page.response;
448
468
  <dl>
449
469
  <dd>
450
470
 
451
- Saves a new custom voice to your account using the specified TTS generation ID.
471
+ Updates the name of a **Tool**.
452
472
 
453
- Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
473
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
454
474
  </dd>
455
475
  </dl>
456
476
  </dd>
@@ -465,9 +485,8 @@ Once saved, this voice can be reused in subsequent TTS requests, ensuring consis
465
485
  <dd>
466
486
 
467
487
  ```typescript
468
- await client.tts.voices.create({
469
- generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
470
- name: "David Hume"
488
+ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
489
+ name: "get_current_temperature"
471
490
  });
472
491
 
473
492
  ```
@@ -484,7 +503,7 @@ await client.tts.voices.create({
484
503
  <dl>
485
504
  <dd>
486
505
 
487
- **request:** `Hume.tts.PostedVoice`
506
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
488
507
 
489
508
  </dd>
490
509
  </dl>
@@ -492,7 +511,15 @@ await client.tts.voices.create({
492
511
  <dl>
493
512
  <dd>
494
513
 
495
- **requestOptions:** `Voices.RequestOptions`
514
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
515
+
516
+ </dd>
517
+ </dl>
518
+
519
+ <dl>
520
+ <dd>
521
+
522
+ **requestOptions:** `Tools.RequestOptions`
496
523
 
497
524
  </dd>
498
525
  </dl>
@@ -504,7 +531,7 @@ await client.tts.voices.create({
504
531
  </dl>
505
532
  </details>
506
533
 
507
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
534
+ <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>
508
535
  <dl>
509
536
  <dd>
510
537
 
@@ -516,7 +543,9 @@ await client.tts.voices.create({
516
543
  <dl>
517
544
  <dd>
518
545
 
519
- Deletes a previously generated custom voice.
546
+ Fetches a specified version of a **Tool**.
547
+
548
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
520
549
  </dd>
521
550
  </dl>
522
551
  </dd>
@@ -531,9 +560,7 @@ Deletes a previously generated custom voice.
531
560
  <dd>
532
561
 
533
562
  ```typescript
534
- await client.tts.voices.delete({
535
- name: "David Hume"
536
- });
563
+ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
537
564
 
538
565
  ```
539
566
  </dd>
@@ -549,7 +576,7 @@ await client.tts.voices.delete({
549
576
  <dl>
550
577
  <dd>
551
578
 
552
- **request:** `Hume.tts.VoicesDeleteRequest`
579
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
553
580
 
554
581
  </dd>
555
582
  </dl>
@@ -557,20 +584,33 @@ await client.tts.voices.delete({
557
584
  <dl>
558
585
  <dd>
559
586
 
560
- **requestOptions:** `Voices.RequestOptions`
587
+ **version:** `number`
588
+
589
+ Version number for a Tool.
590
+
591
+ 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.
592
+
593
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
561
594
 
562
595
  </dd>
563
596
  </dl>
564
- </dd>
565
- </dl>
566
-
597
+
598
+ <dl>
599
+ <dd>
600
+
601
+ **requestOptions:** `Tools.RequestOptions`
602
+
603
+ </dd>
604
+ </dl>
605
+ </dd>
606
+ </dl>
607
+
567
608
 
568
609
  </dd>
569
610
  </dl>
570
611
  </details>
571
612
 
572
- ## EmpathicVoice ControlPlane
573
- <details><summary><code>client.empathicVoice.controlPlane.<a href="/src/api/resources/empathicVoice/resources/controlPlane/client/Client.ts">send</a>(chatId, { ...params }) -> void</code></summary>
613
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
574
614
  <dl>
575
615
  <dd>
576
616
 
@@ -582,7 +622,9 @@ await client.tts.voices.delete({
582
622
  <dl>
583
623
  <dd>
584
624
 
585
- Send a message to a specific chat.
625
+ Deletes a specified version of a **Tool**.
626
+
627
+ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
586
628
  </dd>
587
629
  </dl>
588
630
  </dd>
@@ -597,9 +639,7 @@ Send a message to a specific chat.
597
639
  <dd>
598
640
 
599
641
  ```typescript
600
- await client.empathicVoice.controlPlane.send("chat_id", {
601
- type: "session_settings"
602
- });
642
+ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
603
643
 
604
644
  ```
605
645
  </dd>
@@ -615,7 +655,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
615
655
  <dl>
616
656
  <dd>
617
657
 
618
- **chatId:** `string`
658
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
619
659
 
620
660
  </dd>
621
661
  </dl>
@@ -623,7 +663,13 @@ await client.empathicVoice.controlPlane.send("chat_id", {
623
663
  <dl>
624
664
  <dd>
625
665
 
626
- **request:** `Hume.ControlPlanePublishEvent`
666
+ **version:** `number`
667
+
668
+ Version number for a Tool.
669
+
670
+ 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.
671
+
672
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
627
673
 
628
674
  </dd>
629
675
  </dl>
@@ -631,7 +677,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
631
677
  <dl>
632
678
  <dd>
633
679
 
634
- **requestOptions:** `ControlPlane.RequestOptions`
680
+ **requestOptions:** `Tools.RequestOptions`
635
681
 
636
682
  </dd>
637
683
  </dl>
@@ -643,8 +689,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
643
689
  </dl>
644
690
  </details>
645
691
 
646
- ## EmpathicVoice Tools
647
- <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), Hume.ReturnPagedUserDefinedTools></code></summary>
692
+ <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>
648
693
  <dl>
649
694
  <dd>
650
695
 
@@ -656,7 +701,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
656
701
  <dl>
657
702
  <dd>
658
703
 
659
- Fetches a paginated list of **Tools**.
704
+ Updates the description of a specified **Tool** version.
660
705
 
661
706
  Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
662
707
  </dd>
@@ -673,7 +718,97 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
673
718
  <dd>
674
719
 
675
720
  ```typescript
676
- const pageableResponse = await client.empathicVoice.tools.listTools({
721
+ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
722
+ versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
723
+ });
724
+
725
+ ```
726
+ </dd>
727
+ </dl>
728
+ </dd>
729
+ </dl>
730
+
731
+ #### ⚙️ Parameters
732
+
733
+ <dl>
734
+ <dd>
735
+
736
+ <dl>
737
+ <dd>
738
+
739
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
740
+
741
+ </dd>
742
+ </dl>
743
+
744
+ <dl>
745
+ <dd>
746
+
747
+ **version:** `number`
748
+
749
+ Version number for a Tool.
750
+
751
+ 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.
752
+
753
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
754
+
755
+ </dd>
756
+ </dl>
757
+
758
+ <dl>
759
+ <dd>
760
+
761
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
762
+
763
+ </dd>
764
+ </dl>
765
+
766
+ <dl>
767
+ <dd>
768
+
769
+ **requestOptions:** `Tools.RequestOptions`
770
+
771
+ </dd>
772
+ </dl>
773
+ </dd>
774
+ </dl>
775
+
776
+
777
+ </dd>
778
+ </dl>
779
+ </details>
780
+
781
+ ## EmpathicVoice Prompts
782
+ <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), Hume.ReturnPagedPrompts></code></summary>
783
+ <dl>
784
+ <dd>
785
+
786
+ #### 📝 Description
787
+
788
+ <dl>
789
+ <dd>
790
+
791
+ <dl>
792
+ <dd>
793
+
794
+ Fetches a paginated list of **Prompts**.
795
+
796
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
797
+ </dd>
798
+ </dl>
799
+ </dd>
800
+ </dl>
801
+
802
+ #### 🔌 Usage
803
+
804
+ <dl>
805
+ <dd>
806
+
807
+ <dl>
808
+ <dd>
809
+
810
+ ```typescript
811
+ const pageableResponse = await client.empathicVoice.prompts.listPrompts({
677
812
  pageNumber: 0,
678
813
  pageSize: 2
679
814
  });
@@ -682,7 +817,7 @@ for await (const item of pageableResponse) {
682
817
  }
683
818
 
684
819
  // Or you can manually iterate page-by-page
685
- let page = await client.empathicVoice.tools.listTools({
820
+ let page = await client.empathicVoice.prompts.listPrompts({
686
821
  pageNumber: 0,
687
822
  pageSize: 2
688
823
  });
@@ -707,7 +842,7 @@ const response = page.response;
707
842
  <dl>
708
843
  <dd>
709
844
 
710
- **request:** `Hume.empathicVoice.ToolsListToolsRequest`
845
+ **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
711
846
 
712
847
  </dd>
713
848
  </dl>
@@ -715,7 +850,7 @@ const response = page.response;
715
850
  <dl>
716
851
  <dd>
717
852
 
718
- **requestOptions:** `Tools.RequestOptions`
853
+ **requestOptions:** `Prompts.RequestOptions`
719
854
 
720
855
  </dd>
721
856
  </dl>
@@ -727,7 +862,7 @@ const response = page.response;
727
862
  </dl>
728
863
  </details>
729
864
 
730
- <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>
865
+ <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>
731
866
  <dl>
732
867
  <dd>
733
868
 
@@ -739,9 +874,9 @@ const response = page.response;
739
874
  <dl>
740
875
  <dd>
741
876
 
742
- Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
877
+ Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
743
878
 
744
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
879
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
745
880
  </dd>
746
881
  </dl>
747
882
  </dd>
@@ -756,12 +891,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
756
891
  <dd>
757
892
 
758
893
  ```typescript
759
- await client.empathicVoice.tools.createTool({
760
- name: "get_current_weather",
761
- parameters: "{ \"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\"] }",
762
- versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
763
- description: "This tool is for getting the current weather.",
764
- fallbackContent: "Unable to fetch current weather."
894
+ await client.empathicVoice.prompts.createPrompt({
895
+ name: "Weather Assistant Prompt",
896
+ 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>"
765
897
  });
766
898
 
767
899
  ```
@@ -778,7 +910,7 @@ await client.empathicVoice.tools.createTool({
778
910
  <dl>
779
911
  <dd>
780
912
 
781
- **request:** `Hume.empathicVoice.PostedUserDefinedTool`
913
+ **request:** `Hume.empathicVoice.PostedPrompt`
782
914
 
783
915
  </dd>
784
916
  </dl>
@@ -786,7 +918,7 @@ await client.empathicVoice.tools.createTool({
786
918
  <dl>
787
919
  <dd>
788
920
 
789
- **requestOptions:** `Tools.RequestOptions`
921
+ **requestOptions:** `Prompts.RequestOptions`
790
922
 
791
923
  </dd>
792
924
  </dl>
@@ -798,7 +930,7 @@ await client.empathicVoice.tools.createTool({
798
930
  </dl>
799
931
  </details>
800
932
 
801
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
933
+ <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>
802
934
  <dl>
803
935
  <dd>
804
936
 
@@ -810,9 +942,9 @@ await client.empathicVoice.tools.createTool({
810
942
  <dl>
811
943
  <dd>
812
944
 
813
- Fetches a list of a **Tool's** versions.
945
+ Fetches a list of a **Prompt's** versions.
814
946
 
815
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
947
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
816
948
  </dd>
817
949
  </dl>
818
950
  </dd>
@@ -827,19 +959,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
827
959
  <dd>
828
960
 
829
961
  ```typescript
830
- const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
831
- for await (const item of pageableResponse) {
832
- console.log(item);
833
- }
834
-
835
- // Or you can manually iterate page-by-page
836
- let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
837
- while (page.hasNextPage()) {
838
- page = page.getNextPage();
839
- }
840
-
841
- // You can also access the underlying response
842
- const response = page.response;
962
+ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
843
963
 
844
964
  ```
845
965
  </dd>
@@ -855,7 +975,7 @@ const response = page.response;
855
975
  <dl>
856
976
  <dd>
857
977
 
858
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
978
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
859
979
 
860
980
  </dd>
861
981
  </dl>
@@ -863,7 +983,7 @@ const response = page.response;
863
983
  <dl>
864
984
  <dd>
865
985
 
866
- **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
986
+ **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
867
987
 
868
988
  </dd>
869
989
  </dl>
@@ -871,7 +991,7 @@ const response = page.response;
871
991
  <dl>
872
992
  <dd>
873
993
 
874
- **requestOptions:** `Tools.RequestOptions`
994
+ **requestOptions:** `Prompts.RequestOptions`
875
995
 
876
996
  </dd>
877
997
  </dl>
@@ -883,7 +1003,7 @@ const response = page.response;
883
1003
  </dl>
884
1004
  </details>
885
1005
 
886
- <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>
1006
+ <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>
887
1007
  <dl>
888
1008
  <dd>
889
1009
 
@@ -895,9 +1015,9 @@ const response = page.response;
895
1015
  <dl>
896
1016
  <dd>
897
1017
 
898
- Updates a **Tool** by creating a new version of the **Tool**.
1018
+ Updates a **Prompt** by creating a new version of the **Prompt**.
899
1019
 
900
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1020
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
901
1021
  </dd>
902
1022
  </dl>
903
1023
  </dd>
@@ -912,11 +1032,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
912
1032
  <dd>
913
1033
 
914
1034
  ```typescript
915
- await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
916
- parameters: "{ \"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\"] }",
917
- versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
918
- fallbackContent: "Unable to fetch current weather.",
919
- description: "This tool is for getting the current weather."
1035
+ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1036
+ 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>",
1037
+ versionDescription: "This is an updated version of the Weather Assistant Prompt."
920
1038
  });
921
1039
 
922
1040
  ```
@@ -933,7 +1051,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
933
1051
  <dl>
934
1052
  <dd>
935
1053
 
936
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1054
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
937
1055
 
938
1056
  </dd>
939
1057
  </dl>
@@ -941,7 +1059,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
941
1059
  <dl>
942
1060
  <dd>
943
1061
 
944
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
1062
+ **request:** `Hume.empathicVoice.PostedPromptVersion`
945
1063
 
946
1064
  </dd>
947
1065
  </dl>
@@ -949,7 +1067,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
949
1067
  <dl>
950
1068
  <dd>
951
1069
 
952
- **requestOptions:** `Tools.RequestOptions`
1070
+ **requestOptions:** `Prompts.RequestOptions`
953
1071
 
954
1072
  </dd>
955
1073
  </dl>
@@ -961,7 +1079,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
961
1079
  </dl>
962
1080
  </details>
963
1081
 
964
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
1082
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
965
1083
  <dl>
966
1084
  <dd>
967
1085
 
@@ -973,9 +1091,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
973
1091
  <dl>
974
1092
  <dd>
975
1093
 
976
- Deletes a **Tool** and its versions.
1094
+ Deletes a **Prompt** and its versions.
977
1095
 
978
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1096
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
979
1097
  </dd>
980
1098
  </dl>
981
1099
  </dd>
@@ -990,7 +1108,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
990
1108
  <dd>
991
1109
 
992
1110
  ```typescript
993
- await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
1111
+ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
994
1112
 
995
1113
  ```
996
1114
  </dd>
@@ -1006,7 +1124,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
1006
1124
  <dl>
1007
1125
  <dd>
1008
1126
 
1009
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1127
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1010
1128
 
1011
1129
  </dd>
1012
1130
  </dl>
@@ -1014,7 +1132,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
1014
1132
  <dl>
1015
1133
  <dd>
1016
1134
 
1017
- **requestOptions:** `Tools.RequestOptions`
1135
+ **requestOptions:** `Prompts.RequestOptions`
1018
1136
 
1019
1137
  </dd>
1020
1138
  </dl>
@@ -1026,7 +1144,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
1026
1144
  </dl>
1027
1145
  </details>
1028
1146
 
1029
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
1147
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1030
1148
  <dl>
1031
1149
  <dd>
1032
1150
 
@@ -1038,9 +1156,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
1038
1156
  <dl>
1039
1157
  <dd>
1040
1158
 
1041
- Updates the name of a **Tool**.
1159
+ Updates the name of a **Prompt**.
1042
1160
 
1043
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1161
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1044
1162
  </dd>
1045
1163
  </dl>
1046
1164
  </dd>
@@ -1055,8 +1173,8 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1055
1173
  <dd>
1056
1174
 
1057
1175
  ```typescript
1058
- await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
1059
- name: "get_current_temperature"
1176
+ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1177
+ name: "Updated Weather Assistant Prompt Name"
1060
1178
  });
1061
1179
 
1062
1180
  ```
@@ -1073,7 +1191,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
1073
1191
  <dl>
1074
1192
  <dd>
1075
1193
 
1076
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1194
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1077
1195
 
1078
1196
  </dd>
1079
1197
  </dl>
@@ -1081,7 +1199,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
1081
1199
  <dl>
1082
1200
  <dd>
1083
1201
 
1084
- **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
1202
+ **request:** `Hume.empathicVoice.PostedPromptName`
1085
1203
 
1086
1204
  </dd>
1087
1205
  </dl>
@@ -1089,7 +1207,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
1089
1207
  <dl>
1090
1208
  <dd>
1091
1209
 
1092
- **requestOptions:** `Tools.RequestOptions`
1210
+ **requestOptions:** `Prompts.RequestOptions`
1093
1211
 
1094
1212
  </dd>
1095
1213
  </dl>
@@ -1101,7 +1219,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
1101
1219
  </dl>
1102
1220
  </details>
1103
1221
 
1104
- <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>
1222
+ <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>
1105
1223
  <dl>
1106
1224
  <dd>
1107
1225
 
@@ -1113,9 +1231,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
1113
1231
  <dl>
1114
1232
  <dd>
1115
1233
 
1116
- Fetches a specified version of a **Tool**.
1234
+ Fetches a specified version of a **Prompt**.
1117
1235
 
1118
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1236
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1119
1237
  </dd>
1120
1238
  </dl>
1121
1239
  </dd>
@@ -1130,7 +1248,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1130
1248
  <dd>
1131
1249
 
1132
1250
  ```typescript
1133
- await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1251
+ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1134
1252
 
1135
1253
  ```
1136
1254
  </dd>
@@ -1146,7 +1264,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
1146
1264
  <dl>
1147
1265
  <dd>
1148
1266
 
1149
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1267
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1150
1268
 
1151
1269
  </dd>
1152
1270
  </dl>
@@ -1156,11 +1274,11 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
1156
1274
 
1157
1275
  **version:** `number`
1158
1276
 
1159
- Version number for a Tool.
1277
+ Version number for a Prompt.
1160
1278
 
1161
- 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.
1279
+ 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.
1162
1280
 
1163
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1281
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1164
1282
 
1165
1283
  </dd>
1166
1284
  </dl>
@@ -1168,7 +1286,7 @@ Version numbers are integer values representing different iterations of the Tool
1168
1286
  <dl>
1169
1287
  <dd>
1170
1288
 
1171
- **requestOptions:** `Tools.RequestOptions`
1289
+ **requestOptions:** `Prompts.RequestOptions`
1172
1290
 
1173
1291
  </dd>
1174
1292
  </dl>
@@ -1180,7 +1298,7 @@ Version numbers are integer values representing different iterations of the Tool
1180
1298
  </dl>
1181
1299
  </details>
1182
1300
 
1183
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
1301
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1184
1302
  <dl>
1185
1303
  <dd>
1186
1304
 
@@ -1192,9 +1310,9 @@ Version numbers are integer values representing different iterations of the Tool
1192
1310
  <dl>
1193
1311
  <dd>
1194
1312
 
1195
- Deletes a specified version of a **Tool**.
1313
+ Deletes a specified version of a **Prompt**.
1196
1314
 
1197
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1315
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1198
1316
  </dd>
1199
1317
  </dl>
1200
1318
  </dd>
@@ -1209,7 +1327,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1209
1327
  <dd>
1210
1328
 
1211
1329
  ```typescript
1212
- await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1330
+ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1213
1331
 
1214
1332
  ```
1215
1333
  </dd>
@@ -1225,7 +1343,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
1225
1343
  <dl>
1226
1344
  <dd>
1227
1345
 
1228
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1346
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1229
1347
 
1230
1348
  </dd>
1231
1349
  </dl>
@@ -1235,11 +1353,11 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
1235
1353
 
1236
1354
  **version:** `number`
1237
1355
 
1238
- Version number for a Tool.
1356
+ Version number for a Prompt.
1239
1357
 
1240
- 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.
1358
+ 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.
1241
1359
 
1242
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1360
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1243
1361
 
1244
1362
  </dd>
1245
1363
  </dl>
@@ -1247,7 +1365,7 @@ Version numbers are integer values representing different iterations of the Tool
1247
1365
  <dl>
1248
1366
  <dd>
1249
1367
 
1250
- **requestOptions:** `Tools.RequestOptions`
1368
+ **requestOptions:** `Prompts.RequestOptions`
1251
1369
 
1252
1370
  </dd>
1253
1371
  </dl>
@@ -1259,7 +1377,7 @@ Version numbers are integer values representing different iterations of the Tool
1259
1377
  </dl>
1260
1378
  </details>
1261
1379
 
1262
- <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>
1380
+ <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>
1263
1381
  <dl>
1264
1382
  <dd>
1265
1383
 
@@ -1271,9 +1389,9 @@ Version numbers are integer values representing different iterations of the Tool
1271
1389
  <dl>
1272
1390
  <dd>
1273
1391
 
1274
- Updates the description of a specified **Tool** version.
1392
+ Updates the description of a **Prompt**.
1275
1393
 
1276
- Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
1394
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1277
1395
  </dd>
1278
1396
  </dl>
1279
1397
  </dd>
@@ -1288,8 +1406,8 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1288
1406
  <dd>
1289
1407
 
1290
1408
  ```typescript
1291
- await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
1292
- versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
1409
+ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1410
+ versionDescription: "This is an updated version_description."
1293
1411
  });
1294
1412
 
1295
1413
  ```
@@ -1306,7 +1424,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
1306
1424
  <dl>
1307
1425
  <dd>
1308
1426
 
1309
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1427
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1310
1428
 
1311
1429
  </dd>
1312
1430
  </dl>
@@ -1316,11 +1434,11 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
1316
1434
 
1317
1435
  **version:** `number`
1318
1436
 
1319
- Version number for a Tool.
1437
+ Version number for a Prompt.
1320
1438
 
1321
- 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.
1439
+ 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.
1322
1440
 
1323
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1441
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1324
1442
 
1325
1443
  </dd>
1326
1444
  </dl>
@@ -1328,7 +1446,7 @@ Version numbers are integer values representing different iterations of the Tool
1328
1446
  <dl>
1329
1447
  <dd>
1330
1448
 
1331
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
1449
+ **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1332
1450
 
1333
1451
  </dd>
1334
1452
  </dl>
@@ -1336,7 +1454,7 @@ Version numbers are integer values representing different iterations of the Tool
1336
1454
  <dl>
1337
1455
  <dd>
1338
1456
 
1339
- **requestOptions:** `Tools.RequestOptions`
1457
+ **requestOptions:** `Prompts.RequestOptions`
1340
1458
 
1341
1459
  </dd>
1342
1460
  </dl>
@@ -1348,8 +1466,8 @@ Version numbers are integer values representing different iterations of the Tool
1348
1466
  </dl>
1349
1467
  </details>
1350
1468
 
1351
- ## EmpathicVoice Prompts
1352
- <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), Hume.ReturnPagedPrompts></code></summary>
1469
+ ## EmpathicVoice Configs
1470
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
1353
1471
  <dl>
1354
1472
  <dd>
1355
1473
 
@@ -1361,9 +1479,9 @@ Version numbers are integer values representing different iterations of the Tool
1361
1479
  <dl>
1362
1480
  <dd>
1363
1481
 
1364
- Fetches a paginated list of **Prompts**.
1482
+ Fetches a paginated list of **Configs**.
1365
1483
 
1366
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1484
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1367
1485
  </dd>
1368
1486
  </dl>
1369
1487
  </dd>
@@ -1378,18 +1496,18 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1378
1496
  <dd>
1379
1497
 
1380
1498
  ```typescript
1381
- const pageableResponse = await client.empathicVoice.prompts.listPrompts({
1499
+ const pageableResponse = await client.empathicVoice.configs.listConfigs({
1382
1500
  pageNumber: 0,
1383
- pageSize: 2
1501
+ pageSize: 1
1384
1502
  });
1385
1503
  for await (const item of pageableResponse) {
1386
1504
  console.log(item);
1387
1505
  }
1388
1506
 
1389
1507
  // Or you can manually iterate page-by-page
1390
- let page = await client.empathicVoice.prompts.listPrompts({
1508
+ let page = await client.empathicVoice.configs.listConfigs({
1391
1509
  pageNumber: 0,
1392
- pageSize: 2
1510
+ pageSize: 1
1393
1511
  });
1394
1512
  while (page.hasNextPage()) {
1395
1513
  page = page.getNextPage();
@@ -1412,7 +1530,7 @@ const response = page.response;
1412
1530
  <dl>
1413
1531
  <dd>
1414
1532
 
1415
- **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1533
+ **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
1416
1534
 
1417
1535
  </dd>
1418
1536
  </dl>
@@ -1420,7 +1538,7 @@ const response = page.response;
1420
1538
  <dl>
1421
1539
  <dd>
1422
1540
 
1423
- **requestOptions:** `Prompts.RequestOptions`
1541
+ **requestOptions:** `Configs.RequestOptions`
1424
1542
 
1425
1543
  </dd>
1426
1544
  </dl>
@@ -1432,7 +1550,7 @@ const response = page.response;
1432
1550
  </dl>
1433
1551
  </details>
1434
1552
 
1435
- <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>
1553
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
1436
1554
  <dl>
1437
1555
  <dd>
1438
1556
 
@@ -1444,9 +1562,9 @@ const response = page.response;
1444
1562
  <dl>
1445
1563
  <dd>
1446
1564
 
1447
- Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
1565
+ Creates a **Config** which can be applied to EVI.
1448
1566
 
1449
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1567
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1450
1568
  </dd>
1451
1569
  </dl>
1452
1570
  </dd>
@@ -1461,9 +1579,36 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1461
1579
  <dd>
1462
1580
 
1463
1581
  ```typescript
1464
- await client.empathicVoice.prompts.createPrompt({
1465
- name: "Weather Assistant Prompt",
1466
- 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>"
1582
+ await client.empathicVoice.configs.createConfig({
1583
+ name: "Weather Assistant Config",
1584
+ prompt: {
1585
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1586
+ version: 0
1587
+ },
1588
+ eviVersion: "3",
1589
+ voice: {
1590
+ provider: "HUME_AI",
1591
+ name: "Ava Song"
1592
+ },
1593
+ languageModel: {
1594
+ modelProvider: "ANTHROPIC",
1595
+ modelResource: "claude-3-7-sonnet-latest",
1596
+ temperature: 1
1597
+ },
1598
+ eventMessages: {
1599
+ onNewChat: {
1600
+ enabled: false,
1601
+ text: ""
1602
+ },
1603
+ onInactivityTimeout: {
1604
+ enabled: false,
1605
+ text: ""
1606
+ },
1607
+ onMaxDurationTimeout: {
1608
+ enabled: false,
1609
+ text: ""
1610
+ }
1611
+ }
1467
1612
  });
1468
1613
 
1469
1614
  ```
@@ -1480,7 +1625,7 @@ await client.empathicVoice.prompts.createPrompt({
1480
1625
  <dl>
1481
1626
  <dd>
1482
1627
 
1483
- **request:** `Hume.empathicVoice.PostedPrompt`
1628
+ **request:** `Hume.empathicVoice.PostedConfig`
1484
1629
 
1485
1630
  </dd>
1486
1631
  </dl>
@@ -1488,7 +1633,7 @@ await client.empathicVoice.prompts.createPrompt({
1488
1633
  <dl>
1489
1634
  <dd>
1490
1635
 
1491
- **requestOptions:** `Prompts.RequestOptions`
1636
+ **requestOptions:** `Configs.RequestOptions`
1492
1637
 
1493
1638
  </dd>
1494
1639
  </dl>
@@ -1500,7 +1645,7 @@ await client.empathicVoice.prompts.createPrompt({
1500
1645
  </dl>
1501
1646
  </details>
1502
1647
 
1503
- <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>
1648
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
1504
1649
  <dl>
1505
1650
  <dd>
1506
1651
 
@@ -1512,9 +1657,9 @@ await client.empathicVoice.prompts.createPrompt({
1512
1657
  <dl>
1513
1658
  <dd>
1514
1659
 
1515
- Fetches a list of a **Prompt's** versions.
1660
+ Fetches a list of a **Config's** versions.
1516
1661
 
1517
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1662
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1518
1663
  </dd>
1519
1664
  </dl>
1520
1665
  </dd>
@@ -1529,7 +1674,19 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1529
1674
  <dd>
1530
1675
 
1531
1676
  ```typescript
1532
- await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1677
+ const pageableResponse = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1678
+ for await (const item of pageableResponse) {
1679
+ console.log(item);
1680
+ }
1681
+
1682
+ // Or you can manually iterate page-by-page
1683
+ let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1684
+ while (page.hasNextPage()) {
1685
+ page = page.getNextPage();
1686
+ }
1687
+
1688
+ // You can also access the underlying response
1689
+ const response = page.response;
1533
1690
 
1534
1691
  ```
1535
1692
  </dd>
@@ -1545,7 +1702,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1545
1702
  <dl>
1546
1703
  <dd>
1547
1704
 
1548
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1705
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1549
1706
 
1550
1707
  </dd>
1551
1708
  </dl>
@@ -1553,7 +1710,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1553
1710
  <dl>
1554
1711
  <dd>
1555
1712
 
1556
- **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1713
+ **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
1557
1714
 
1558
1715
  </dd>
1559
1716
  </dl>
@@ -1561,7 +1718,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1561
1718
  <dl>
1562
1719
  <dd>
1563
1720
 
1564
- **requestOptions:** `Prompts.RequestOptions`
1721
+ **requestOptions:** `Configs.RequestOptions`
1565
1722
 
1566
1723
  </dd>
1567
1724
  </dl>
@@ -1573,7 +1730,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1573
1730
  </dl>
1574
1731
  </details>
1575
1732
 
1576
- <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>
1733
+ <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>
1577
1734
  <dl>
1578
1735
  <dd>
1579
1736
 
@@ -1585,9 +1742,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1585
1742
  <dl>
1586
1743
  <dd>
1587
1744
 
1588
- Updates a **Prompt** by creating a new version of the **Prompt**.
1745
+ Updates a **Config** by creating a new version of the **Config**.
1589
1746
 
1590
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1747
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1591
1748
  </dd>
1592
1749
  </dl>
1593
1750
  </dd>
@@ -1602,9 +1759,39 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1602
1759
  <dd>
1603
1760
 
1604
1761
  ```typescript
1605
- await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1606
- 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>",
1607
- versionDescription: "This is an updated version of the Weather Assistant Prompt."
1762
+ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1763
+ versionDescription: "This is an updated version of the Weather Assistant Config.",
1764
+ eviVersion: "3",
1765
+ prompt: {
1766
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1767
+ version: 0
1768
+ },
1769
+ voice: {
1770
+ provider: "HUME_AI",
1771
+ name: "Ava Song"
1772
+ },
1773
+ languageModel: {
1774
+ modelProvider: "ANTHROPIC",
1775
+ modelResource: "claude-3-7-sonnet-latest",
1776
+ temperature: 1
1777
+ },
1778
+ ellmModel: {
1779
+ allowShortResponses: true
1780
+ },
1781
+ eventMessages: {
1782
+ onNewChat: {
1783
+ enabled: false,
1784
+ text: ""
1785
+ },
1786
+ onInactivityTimeout: {
1787
+ enabled: false,
1788
+ text: ""
1789
+ },
1790
+ onMaxDurationTimeout: {
1791
+ enabled: false,
1792
+ text: ""
1793
+ }
1794
+ }
1608
1795
  });
1609
1796
 
1610
1797
  ```
@@ -1621,7 +1808,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1621
1808
  <dl>
1622
1809
  <dd>
1623
1810
 
1624
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1811
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1625
1812
 
1626
1813
  </dd>
1627
1814
  </dl>
@@ -1629,7 +1816,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1629
1816
  <dl>
1630
1817
  <dd>
1631
1818
 
1632
- **request:** `Hume.empathicVoice.PostedPromptVersion`
1819
+ **request:** `Hume.empathicVoice.PostedConfigVersion`
1633
1820
 
1634
1821
  </dd>
1635
1822
  </dl>
@@ -1637,7 +1824,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1637
1824
  <dl>
1638
1825
  <dd>
1639
1826
 
1640
- **requestOptions:** `Prompts.RequestOptions`
1827
+ **requestOptions:** `Configs.RequestOptions`
1641
1828
 
1642
1829
  </dd>
1643
1830
  </dl>
@@ -1649,7 +1836,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1649
1836
  </dl>
1650
1837
  </details>
1651
1838
 
1652
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1839
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
1653
1840
  <dl>
1654
1841
  <dd>
1655
1842
 
@@ -1661,9 +1848,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1661
1848
  <dl>
1662
1849
  <dd>
1663
1850
 
1664
- Deletes a **Prompt** and its versions.
1851
+ Deletes a **Config** and its versions.
1665
1852
 
1666
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1853
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1667
1854
  </dd>
1668
1855
  </dl>
1669
1856
  </dd>
@@ -1678,7 +1865,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1678
1865
  <dd>
1679
1866
 
1680
1867
  ```typescript
1681
- await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1868
+ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1682
1869
 
1683
1870
  ```
1684
1871
  </dd>
@@ -1694,7 +1881,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1694
1881
  <dl>
1695
1882
  <dd>
1696
1883
 
1697
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1884
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1698
1885
 
1699
1886
  </dd>
1700
1887
  </dl>
@@ -1702,7 +1889,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1702
1889
  <dl>
1703
1890
  <dd>
1704
1891
 
1705
- **requestOptions:** `Prompts.RequestOptions`
1892
+ **requestOptions:** `Configs.RequestOptions`
1706
1893
 
1707
1894
  </dd>
1708
1895
  </dl>
@@ -1714,7 +1901,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1714
1901
  </dl>
1715
1902
  </details>
1716
1903
 
1717
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1904
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
1718
1905
  <dl>
1719
1906
  <dd>
1720
1907
 
@@ -1726,9 +1913,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1726
1913
  <dl>
1727
1914
  <dd>
1728
1915
 
1729
- Updates the name of a **Prompt**.
1916
+ Updates the name of a **Config**.
1730
1917
 
1731
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1918
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1732
1919
  </dd>
1733
1920
  </dl>
1734
1921
  </dd>
@@ -1743,8 +1930,8 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1743
1930
  <dd>
1744
1931
 
1745
1932
  ```typescript
1746
- await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1747
- name: "Updated Weather Assistant Prompt Name"
1933
+ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1934
+ name: "Updated Weather Assistant Config Name"
1748
1935
  });
1749
1936
 
1750
1937
  ```
@@ -1761,7 +1948,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1761
1948
  <dl>
1762
1949
  <dd>
1763
1950
 
1764
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1951
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1765
1952
 
1766
1953
  </dd>
1767
1954
  </dl>
@@ -1769,7 +1956,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1769
1956
  <dl>
1770
1957
  <dd>
1771
1958
 
1772
- **request:** `Hume.empathicVoice.PostedPromptName`
1959
+ **request:** `Hume.empathicVoice.PostedConfigName`
1773
1960
 
1774
1961
  </dd>
1775
1962
  </dl>
@@ -1777,7 +1964,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1777
1964
  <dl>
1778
1965
  <dd>
1779
1966
 
1780
- **requestOptions:** `Prompts.RequestOptions`
1967
+ **requestOptions:** `Configs.RequestOptions`
1781
1968
 
1782
1969
  </dd>
1783
1970
  </dl>
@@ -1789,7 +1976,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1789
1976
  </dl>
1790
1977
  </details>
1791
1978
 
1792
- <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>
1979
+ <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>
1793
1980
  <dl>
1794
1981
  <dd>
1795
1982
 
@@ -1801,9 +1988,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1801
1988
  <dl>
1802
1989
  <dd>
1803
1990
 
1804
- Fetches a specified version of a **Prompt**.
1991
+ Fetches a specified version of a **Config**.
1805
1992
 
1806
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1993
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1807
1994
  </dd>
1808
1995
  </dl>
1809
1996
  </dd>
@@ -1818,7 +2005,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1818
2005
  <dd>
1819
2006
 
1820
2007
  ```typescript
1821
- await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
2008
+ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1822
2009
 
1823
2010
  ```
1824
2011
  </dd>
@@ -1834,7 +2021,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1834
2021
  <dl>
1835
2022
  <dd>
1836
2023
 
1837
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2024
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1838
2025
 
1839
2026
  </dd>
1840
2027
  </dl>
@@ -1844,11 +2031,11 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1844
2031
 
1845
2032
  **version:** `number`
1846
2033
 
1847
- Version number for a Prompt.
2034
+ Version number for a Config.
1848
2035
 
1849
- 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.
2036
+ 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.
1850
2037
 
1851
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2038
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1852
2039
 
1853
2040
  </dd>
1854
2041
  </dl>
@@ -1856,7 +2043,7 @@ Version numbers are integer values representing different iterations of the Prom
1856
2043
  <dl>
1857
2044
  <dd>
1858
2045
 
1859
- **requestOptions:** `Prompts.RequestOptions`
2046
+ **requestOptions:** `Configs.RequestOptions`
1860
2047
 
1861
2048
  </dd>
1862
2049
  </dl>
@@ -1868,7 +2055,7 @@ Version numbers are integer values representing different iterations of the Prom
1868
2055
  </dl>
1869
2056
  </details>
1870
2057
 
1871
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
2058
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
1872
2059
  <dl>
1873
2060
  <dd>
1874
2061
 
@@ -1880,9 +2067,9 @@ Version numbers are integer values representing different iterations of the Prom
1880
2067
  <dl>
1881
2068
  <dd>
1882
2069
 
1883
- Deletes a specified version of a **Prompt**.
2070
+ Deletes a specified version of a **Config**.
1884
2071
 
1885
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2072
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1886
2073
  </dd>
1887
2074
  </dl>
1888
2075
  </dd>
@@ -1897,7 +2084,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1897
2084
  <dd>
1898
2085
 
1899
2086
  ```typescript
1900
- await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
2087
+ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1901
2088
 
1902
2089
  ```
1903
2090
  </dd>
@@ -1913,7 +2100,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1913
2100
  <dl>
1914
2101
  <dd>
1915
2102
 
1916
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2103
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1917
2104
 
1918
2105
  </dd>
1919
2106
  </dl>
@@ -1923,11 +2110,11 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1923
2110
 
1924
2111
  **version:** `number`
1925
2112
 
1926
- Version number for a Prompt.
2113
+ Version number for a Config.
1927
2114
 
1928
- 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.
2115
+ 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.
1929
2116
 
1930
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2117
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1931
2118
 
1932
2119
  </dd>
1933
2120
  </dl>
@@ -1935,7 +2122,7 @@ Version numbers are integer values representing different iterations of the Prom
1935
2122
  <dl>
1936
2123
  <dd>
1937
2124
 
1938
- **requestOptions:** `Prompts.RequestOptions`
2125
+ **requestOptions:** `Configs.RequestOptions`
1939
2126
 
1940
2127
  </dd>
1941
2128
  </dl>
@@ -1947,7 +2134,7 @@ Version numbers are integer values representing different iterations of the Prom
1947
2134
  </dl>
1948
2135
  </details>
1949
2136
 
1950
- <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>
2137
+ <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>
1951
2138
  <dl>
1952
2139
  <dd>
1953
2140
 
@@ -1959,9 +2146,9 @@ Version numbers are integer values representing different iterations of the Prom
1959
2146
  <dl>
1960
2147
  <dd>
1961
2148
 
1962
- Updates the description of a **Prompt**.
2149
+ Updates the description of a **Config**.
1963
2150
 
1964
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
2151
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1965
2152
  </dd>
1966
2153
  </dl>
1967
2154
  </dd>
@@ -1976,7 +2163,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1976
2163
  <dd>
1977
2164
 
1978
2165
  ```typescript
1979
- await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
2166
+ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
1980
2167
  versionDescription: "This is an updated version_description."
1981
2168
  });
1982
2169
 
@@ -1994,7 +2181,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1994
2181
  <dl>
1995
2182
  <dd>
1996
2183
 
1997
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
2184
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1998
2185
 
1999
2186
  </dd>
2000
2187
  </dl>
@@ -2004,11 +2191,11 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
2004
2191
 
2005
2192
  **version:** `number`
2006
2193
 
2007
- Version number for a Prompt.
2194
+ Version number for a Config.
2008
2195
 
2009
- 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.
2196
+ 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.
2010
2197
 
2011
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
2198
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2012
2199
 
2013
2200
  </dd>
2014
2201
  </dl>
@@ -2016,7 +2203,7 @@ Version numbers are integer values representing different iterations of the Prom
2016
2203
  <dl>
2017
2204
  <dd>
2018
2205
 
2019
- **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
2206
+ **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2020
2207
 
2021
2208
  </dd>
2022
2209
  </dl>
@@ -2024,7 +2211,7 @@ Version numbers are integer values representing different iterations of the Prom
2024
2211
  <dl>
2025
2212
  <dd>
2026
2213
 
2027
- **requestOptions:** `Prompts.RequestOptions`
2214
+ **requestOptions:** `Configs.RequestOptions`
2028
2215
 
2029
2216
  </dd>
2030
2217
  </dl>
@@ -2036,9 +2223,9 @@ Version numbers are integer values representing different iterations of the Prom
2036
2223
  </dl>
2037
2224
  </details>
2038
2225
 
2039
- ## EmpathicVoice Configs
2040
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
2041
- <dl>
2226
+ ## EmpathicVoice Chats
2227
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
2228
+ <dl>
2042
2229
  <dd>
2043
2230
 
2044
2231
  #### 📝 Description
@@ -2049,9 +2236,7 @@ Version numbers are integer values representing different iterations of the Prom
2049
2236
  <dl>
2050
2237
  <dd>
2051
2238
 
2052
- Fetches a paginated list of **Configs**.
2053
-
2054
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2239
+ Fetches a paginated list of **Chats**.
2055
2240
  </dd>
2056
2241
  </dl>
2057
2242
  </dd>
@@ -2066,18 +2251,20 @@ For more details on configuration options and how to configure EVI, see our [con
2066
2251
  <dd>
2067
2252
 
2068
2253
  ```typescript
2069
- const pageableResponse = await client.empathicVoice.configs.listConfigs({
2254
+ const pageableResponse = await client.empathicVoice.chats.listChats({
2070
2255
  pageNumber: 0,
2071
- pageSize: 1
2256
+ pageSize: 1,
2257
+ ascendingOrder: true
2072
2258
  });
2073
2259
  for await (const item of pageableResponse) {
2074
2260
  console.log(item);
2075
2261
  }
2076
2262
 
2077
2263
  // Or you can manually iterate page-by-page
2078
- let page = await client.empathicVoice.configs.listConfigs({
2264
+ let page = await client.empathicVoice.chats.listChats({
2079
2265
  pageNumber: 0,
2080
- pageSize: 1
2266
+ pageSize: 1,
2267
+ ascendingOrder: true
2081
2268
  });
2082
2269
  while (page.hasNextPage()) {
2083
2270
  page = page.getNextPage();
@@ -2100,7 +2287,7 @@ const response = page.response;
2100
2287
  <dl>
2101
2288
  <dd>
2102
2289
 
2103
- **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
2290
+ **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2104
2291
 
2105
2292
  </dd>
2106
2293
  </dl>
@@ -2108,7 +2295,7 @@ const response = page.response;
2108
2295
  <dl>
2109
2296
  <dd>
2110
2297
 
2111
- **requestOptions:** `Configs.RequestOptions`
2298
+ **requestOptions:** `Chats.RequestOptions`
2112
2299
 
2113
2300
  </dd>
2114
2301
  </dl>
@@ -2120,7 +2307,7 @@ const response = page.response;
2120
2307
  </dl>
2121
2308
  </details>
2122
2309
 
2123
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
2310
+ <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, Hume.ReturnChatPagedEvents></code></summary>
2124
2311
  <dl>
2125
2312
  <dd>
2126
2313
 
@@ -2132,9 +2319,7 @@ const response = page.response;
2132
2319
  <dl>
2133
2320
  <dd>
2134
2321
 
2135
- Creates a **Config** which can be applied to EVI.
2136
-
2137
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2322
+ Fetches a paginated list of **Chat** events.
2138
2323
  </dd>
2139
2324
  </dl>
2140
2325
  </dd>
@@ -2149,108 +2334,21 @@ For more details on configuration options and how to configure EVI, see our [con
2149
2334
  <dd>
2150
2335
 
2151
2336
  ```typescript
2152
- await client.empathicVoice.configs.createConfig({
2153
- name: "Weather Assistant Config",
2154
- prompt: {
2155
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2156
- version: 0
2157
- },
2158
- eviVersion: "3",
2159
- voice: {
2160
- provider: "HUME_AI",
2161
- name: "Ava Song"
2162
- },
2163
- languageModel: {
2164
- modelProvider: "ANTHROPIC",
2165
- modelResource: "claude-3-7-sonnet-latest",
2166
- temperature: 1
2167
- },
2168
- eventMessages: {
2169
- onNewChat: {
2170
- enabled: false,
2171
- text: ""
2172
- },
2173
- onInactivityTimeout: {
2174
- enabled: false,
2175
- text: ""
2176
- },
2177
- onMaxDurationTimeout: {
2178
- enabled: false,
2179
- text: ""
2180
- }
2181
- }
2337
+ const pageableResponse = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2338
+ pageNumber: 0,
2339
+ pageSize: 3,
2340
+ ascendingOrder: true
2182
2341
  });
2183
-
2184
- ```
2185
- </dd>
2186
- </dl>
2187
- </dd>
2188
- </dl>
2189
-
2190
- #### ⚙️ Parameters
2191
-
2192
- <dl>
2193
- <dd>
2194
-
2195
- <dl>
2196
- <dd>
2197
-
2198
- **request:** `Hume.empathicVoice.PostedConfig`
2199
-
2200
- </dd>
2201
- </dl>
2202
-
2203
- <dl>
2204
- <dd>
2205
-
2206
- **requestOptions:** `Configs.RequestOptions`
2207
-
2208
- </dd>
2209
- </dl>
2210
- </dd>
2211
- </dl>
2212
-
2213
-
2214
- </dd>
2215
- </dl>
2216
- </details>
2217
-
2218
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
2219
- <dl>
2220
- <dd>
2221
-
2222
- #### 📝 Description
2223
-
2224
- <dl>
2225
- <dd>
2226
-
2227
- <dl>
2228
- <dd>
2229
-
2230
- Fetches a list of a **Config's** versions.
2231
-
2232
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2233
- </dd>
2234
- </dl>
2235
- </dd>
2236
- </dl>
2237
-
2238
- #### 🔌 Usage
2239
-
2240
- <dl>
2241
- <dd>
2242
-
2243
- <dl>
2244
- <dd>
2245
-
2246
- ```typescript
2247
- const pageableResponse = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2248
2342
  for await (const item of pageableResponse) {
2249
2343
  console.log(item);
2250
2344
  }
2251
2345
 
2252
2346
  // Or you can manually iterate page-by-page
2253
- let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2347
+ let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2348
+ pageNumber: 0,
2349
+ pageSize: 3,
2350
+ ascendingOrder: true
2351
+ });
2254
2352
  while (page.hasNextPage()) {
2255
2353
  page = page.getNextPage();
2256
2354
  }
@@ -2272,7 +2370,7 @@ const response = page.response;
2272
2370
  <dl>
2273
2371
  <dd>
2274
2372
 
2275
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2373
+ **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2276
2374
 
2277
2375
  </dd>
2278
2376
  </dl>
@@ -2280,7 +2378,7 @@ const response = page.response;
2280
2378
  <dl>
2281
2379
  <dd>
2282
2380
 
2283
- **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
2381
+ **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2284
2382
 
2285
2383
  </dd>
2286
2384
  </dl>
@@ -2288,7 +2386,7 @@ const response = page.response;
2288
2386
  <dl>
2289
2387
  <dd>
2290
2388
 
2291
- **requestOptions:** `Configs.RequestOptions`
2389
+ **requestOptions:** `Chats.RequestOptions`
2292
2390
 
2293
2391
  </dd>
2294
2392
  </dl>
@@ -2300,7 +2398,7 @@ const response = page.response;
2300
2398
  </dl>
2301
2399
  </details>
2302
2400
 
2303
- <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>
2401
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2304
2402
  <dl>
2305
2403
  <dd>
2306
2404
 
@@ -2312,9 +2410,7 @@ const response = page.response;
2312
2410
  <dl>
2313
2411
  <dd>
2314
2412
 
2315
- Updates a **Config** by creating a new version of the **Config**.
2316
-
2317
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2413
+ Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
2318
2414
  </dd>
2319
2415
  </dl>
2320
2416
  </dd>
@@ -2329,40 +2425,7 @@ For more details on configuration options and how to configure EVI, see our [con
2329
2425
  <dd>
2330
2426
 
2331
2427
  ```typescript
2332
- await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2333
- versionDescription: "This is an updated version of the Weather Assistant Config.",
2334
- eviVersion: "3",
2335
- prompt: {
2336
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2337
- version: 0
2338
- },
2339
- voice: {
2340
- provider: "HUME_AI",
2341
- name: "Ava Song"
2342
- },
2343
- languageModel: {
2344
- modelProvider: "ANTHROPIC",
2345
- modelResource: "claude-3-7-sonnet-latest",
2346
- temperature: 1
2347
- },
2348
- ellmModel: {
2349
- allowShortResponses: true
2350
- },
2351
- eventMessages: {
2352
- onNewChat: {
2353
- enabled: false,
2354
- text: ""
2355
- },
2356
- onInactivityTimeout: {
2357
- enabled: false,
2358
- text: ""
2359
- },
2360
- onMaxDurationTimeout: {
2361
- enabled: false,
2362
- text: ""
2363
- }
2364
- }
2365
- });
2428
+ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
2366
2429
 
2367
2430
  ```
2368
2431
  </dd>
@@ -2378,15 +2441,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2378
2441
  <dl>
2379
2442
  <dd>
2380
2443
 
2381
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2382
-
2383
- </dd>
2384
- </dl>
2385
-
2386
- <dl>
2387
- <dd>
2388
-
2389
- **request:** `Hume.empathicVoice.PostedConfigVersion`
2444
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
2390
2445
 
2391
2446
  </dd>
2392
2447
  </dl>
@@ -2394,7 +2449,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2394
2449
  <dl>
2395
2450
  <dd>
2396
2451
 
2397
- **requestOptions:** `Configs.RequestOptions`
2452
+ **requestOptions:** `Chats.RequestOptions`
2398
2453
 
2399
2454
  </dd>
2400
2455
  </dl>
@@ -2406,7 +2461,8 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2406
2461
  </dl>
2407
2462
  </details>
2408
2463
 
2409
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
2464
+ ## EmpathicVoice ChatGroups
2465
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
2410
2466
  <dl>
2411
2467
  <dd>
2412
2468
 
@@ -2418,9 +2474,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2418
2474
  <dl>
2419
2475
  <dd>
2420
2476
 
2421
- Deletes a **Config** and its versions.
2422
-
2423
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2477
+ Fetches a paginated list of **Chat Groups**.
2424
2478
  </dd>
2425
2479
  </dl>
2426
2480
  </dd>
@@ -2435,7 +2489,29 @@ For more details on configuration options and how to configure EVI, see our [con
2435
2489
  <dd>
2436
2490
 
2437
2491
  ```typescript
2438
- await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2492
+ const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
2493
+ pageNumber: 0,
2494
+ pageSize: 1,
2495
+ ascendingOrder: true,
2496
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
2497
+ });
2498
+ for await (const item of pageableResponse) {
2499
+ console.log(item);
2500
+ }
2501
+
2502
+ // Or you can manually iterate page-by-page
2503
+ let page = await client.empathicVoice.chatGroups.listChatGroups({
2504
+ pageNumber: 0,
2505
+ pageSize: 1,
2506
+ ascendingOrder: true,
2507
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
2508
+ });
2509
+ while (page.hasNextPage()) {
2510
+ page = page.getNextPage();
2511
+ }
2512
+
2513
+ // You can also access the underlying response
2514
+ const response = page.response;
2439
2515
 
2440
2516
  ```
2441
2517
  </dd>
@@ -2451,7 +2527,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2451
2527
  <dl>
2452
2528
  <dd>
2453
2529
 
2454
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2530
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
2455
2531
 
2456
2532
  </dd>
2457
2533
  </dl>
@@ -2459,7 +2535,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2459
2535
  <dl>
2460
2536
  <dd>
2461
2537
 
2462
- **requestOptions:** `Configs.RequestOptions`
2538
+ **requestOptions:** `ChatGroups.RequestOptions`
2463
2539
 
2464
2540
  </dd>
2465
2541
  </dl>
@@ -2471,7 +2547,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2471
2547
  </dl>
2472
2548
  </details>
2473
2549
 
2474
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2550
+ <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>
2475
2551
  <dl>
2476
2552
  <dd>
2477
2553
 
@@ -2483,9 +2559,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2483
2559
  <dl>
2484
2560
  <dd>
2485
2561
 
2486
- Updates the name of a **Config**.
2487
-
2488
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2562
+ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
2489
2563
  </dd>
2490
2564
  </dl>
2491
2565
  </dd>
@@ -2500,8 +2574,10 @@ For more details on configuration options and how to configure EVI, see our [con
2500
2574
  <dd>
2501
2575
 
2502
2576
  ```typescript
2503
- await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2504
- name: "Updated Weather Assistant Config Name"
2577
+ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2578
+ pageNumber: 0,
2579
+ pageSize: 1,
2580
+ ascendingOrder: true
2505
2581
  });
2506
2582
 
2507
2583
  ```
@@ -2518,7 +2594,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2518
2594
  <dl>
2519
2595
  <dd>
2520
2596
 
2521
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2597
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2522
2598
 
2523
2599
  </dd>
2524
2600
  </dl>
@@ -2526,7 +2602,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2526
2602
  <dl>
2527
2603
  <dd>
2528
2604
 
2529
- **request:** `Hume.empathicVoice.PostedConfigName`
2605
+ **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
2530
2606
 
2531
2607
  </dd>
2532
2608
  </dl>
@@ -2534,7 +2610,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2534
2610
  <dl>
2535
2611
  <dd>
2536
2612
 
2537
- **requestOptions:** `Configs.RequestOptions`
2613
+ **requestOptions:** `ChatGroups.RequestOptions`
2538
2614
 
2539
2615
  </dd>
2540
2616
  </dl>
@@ -2546,7 +2622,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2546
2622
  </dl>
2547
2623
  </details>
2548
2624
 
2549
- <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>
2625
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
2550
2626
  <dl>
2551
2627
  <dd>
2552
2628
 
@@ -2558,9 +2634,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2558
2634
  <dl>
2559
2635
  <dd>
2560
2636
 
2561
- Fetches a specified version of a **Config**.
2562
-
2563
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2637
+ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
2564
2638
  </dd>
2565
2639
  </dl>
2566
2640
  </dd>
@@ -2575,7 +2649,27 @@ For more details on configuration options and how to configure EVI, see our [con
2575
2649
  <dd>
2576
2650
 
2577
2651
  ```typescript
2578
- await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2652
+ const pageableResponse = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2653
+ pageNumber: 0,
2654
+ pageSize: 3,
2655
+ ascendingOrder: true
2656
+ });
2657
+ for await (const item of pageableResponse) {
2658
+ console.log(item);
2659
+ }
2660
+
2661
+ // Or you can manually iterate page-by-page
2662
+ let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2663
+ pageNumber: 0,
2664
+ pageSize: 3,
2665
+ ascendingOrder: true
2666
+ });
2667
+ while (page.hasNextPage()) {
2668
+ page = page.getNextPage();
2669
+ }
2670
+
2671
+ // You can also access the underlying response
2672
+ const response = page.response;
2579
2673
 
2580
2674
  ```
2581
2675
  </dd>
@@ -2591,7 +2685,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2591
2685
  <dl>
2592
2686
  <dd>
2593
2687
 
2594
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2688
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2595
2689
 
2596
2690
  </dd>
2597
2691
  </dl>
@@ -2599,13 +2693,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2599
2693
  <dl>
2600
2694
  <dd>
2601
2695
 
2602
- **version:** `number`
2603
-
2604
- Version number for a Config.
2605
-
2606
- 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.
2607
-
2608
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2696
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
2609
2697
 
2610
2698
  </dd>
2611
2699
  </dl>
@@ -2613,7 +2701,7 @@ Version numbers are integer values representing different iterations of the Conf
2613
2701
  <dl>
2614
2702
  <dd>
2615
2703
 
2616
- **requestOptions:** `Configs.RequestOptions`
2704
+ **requestOptions:** `ChatGroups.RequestOptions`
2617
2705
 
2618
2706
  </dd>
2619
2707
  </dl>
@@ -2625,7 +2713,7 @@ Version numbers are integer values representing different iterations of the Conf
2625
2713
  </dl>
2626
2714
  </details>
2627
2715
 
2628
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2716
+ <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>
2629
2717
  <dl>
2630
2718
  <dd>
2631
2719
 
@@ -2637,9 +2725,7 @@ Version numbers are integer values representing different iterations of the Conf
2637
2725
  <dl>
2638
2726
  <dd>
2639
2727
 
2640
- Deletes a specified version of a **Config**.
2641
-
2642
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2728
+ 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/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
2643
2729
  </dd>
2644
2730
  </dl>
2645
2731
  </dd>
@@ -2654,7 +2740,11 @@ For more details on configuration options and how to configure EVI, see our [con
2654
2740
  <dd>
2655
2741
 
2656
2742
  ```typescript
2657
- await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2743
+ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
2744
+ pageNumber: 0,
2745
+ pageSize: 10,
2746
+ ascendingOrder: true
2747
+ });
2658
2748
 
2659
2749
  ```
2660
2750
  </dd>
@@ -2670,7 +2760,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2670
2760
  <dl>
2671
2761
  <dd>
2672
2762
 
2673
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2763
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2674
2764
 
2675
2765
  </dd>
2676
2766
  </dl>
@@ -2678,13 +2768,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2678
2768
  <dl>
2679
2769
  <dd>
2680
2770
 
2681
- **version:** `number`
2682
-
2683
- Version number for a Config.
2684
-
2685
- 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.
2686
-
2687
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2771
+ **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
2688
2772
 
2689
2773
  </dd>
2690
2774
  </dl>
@@ -2692,7 +2776,7 @@ Version numbers are integer values representing different iterations of the Conf
2692
2776
  <dl>
2693
2777
  <dd>
2694
2778
 
2695
- **requestOptions:** `Configs.RequestOptions`
2779
+ **requestOptions:** `ChatGroups.RequestOptions`
2696
2780
 
2697
2781
  </dd>
2698
2782
  </dl>
@@ -2704,7 +2788,8 @@ Version numbers are integer values representing different iterations of the Conf
2704
2788
  </dl>
2705
2789
  </details>
2706
2790
 
2707
- <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>
2791
+ ## Tts
2792
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
2708
2793
  <dl>
2709
2794
  <dd>
2710
2795
 
@@ -2716,9 +2801,9 @@ Version numbers are integer values representing different iterations of the Conf
2716
2801
  <dl>
2717
2802
  <dd>
2718
2803
 
2719
- Updates the description of a **Config**.
2804
+ Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2720
2805
 
2721
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2806
+ The response includes the base64-encoded audio and metadata in JSON format.
2722
2807
  </dd>
2723
2808
  </dl>
2724
2809
  </dd>
@@ -2733,8 +2818,21 @@ For more details on configuration options and how to configure EVI, see our [con
2733
2818
  <dd>
2734
2819
 
2735
2820
  ```typescript
2736
- await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2737
- versionDescription: "This is an updated version_description."
2821
+ await client.tts.synthesizeJson({
2822
+ context: {
2823
+ utterances: [{
2824
+ text: "How can people see beauty so differently?",
2825
+ description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
2826
+ }]
2827
+ },
2828
+ format: {
2829
+ type: "mp3"
2830
+ },
2831
+ numGenerations: 1,
2832
+ utterances: [{
2833
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2834
+ description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
2835
+ }]
2738
2836
  });
2739
2837
 
2740
2838
  ```
@@ -2751,29 +2849,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
2751
2849
  <dl>
2752
2850
  <dd>
2753
2851
 
2754
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2755
-
2756
- </dd>
2757
- </dl>
2758
-
2759
- <dl>
2760
- <dd>
2761
-
2762
- **version:** `number`
2763
-
2764
- Version number for a Config.
2765
-
2766
- 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.
2767
-
2768
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2769
-
2770
- </dd>
2771
- </dl>
2772
-
2773
- <dl>
2774
- <dd>
2775
-
2776
- **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2852
+ **request:** `Hume.PostedTts`
2777
2853
 
2778
2854
  </dd>
2779
2855
  </dl>
@@ -2781,7 +2857,7 @@ Version numbers are integer values representing different iterations of the Conf
2781
2857
  <dl>
2782
2858
  <dd>
2783
2859
 
2784
- **requestOptions:** `Configs.RequestOptions`
2860
+ **requestOptions:** `Tts.RequestOptions`
2785
2861
 
2786
2862
  </dd>
2787
2863
  </dl>
@@ -2793,8 +2869,7 @@ Version numbers are integer values representing different iterations of the Conf
2793
2869
  </dl>
2794
2870
  </details>
2795
2871
 
2796
- ## EmpathicVoice Chats
2797
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
2872
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> core.BinaryResponse</code></summary>
2798
2873
  <dl>
2799
2874
  <dd>
2800
2875
 
@@ -2806,7 +2881,9 @@ Version numbers are integer values representing different iterations of the Conf
2806
2881
  <dl>
2807
2882
  <dd>
2808
2883
 
2809
- Fetches a paginated list of **Chats**.
2884
+ Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2885
+
2886
+ The response contains the generated audio file in the requested format.
2810
2887
  </dd>
2811
2888
  </dl>
2812
2889
  </dd>
@@ -2821,27 +2898,19 @@ Fetches a paginated list of **Chats**.
2821
2898
  <dd>
2822
2899
 
2823
2900
  ```typescript
2824
- const pageableResponse = await client.empathicVoice.chats.listChats({
2825
- pageNumber: 0,
2826
- pageSize: 1,
2827
- ascendingOrder: true
2828
- });
2829
- for await (const item of pageableResponse) {
2830
- console.log(item);
2831
- }
2832
-
2833
- // Or you can manually iterate page-by-page
2834
- let page = await client.empathicVoice.chats.listChats({
2835
- pageNumber: 0,
2836
- pageSize: 1,
2837
- ascendingOrder: true
2901
+ await client.tts.synthesizeFile({
2902
+ context: {
2903
+ generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2"
2904
+ },
2905
+ format: {
2906
+ type: "mp3"
2907
+ },
2908
+ numGenerations: 1,
2909
+ utterances: [{
2910
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2911
+ description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
2912
+ }]
2838
2913
  });
2839
- while (page.hasNextPage()) {
2840
- page = page.getNextPage();
2841
- }
2842
-
2843
- // You can also access the underlying response
2844
- const response = page.response;
2845
2914
 
2846
2915
  ```
2847
2916
  </dd>
@@ -2857,7 +2926,7 @@ const response = page.response;
2857
2926
  <dl>
2858
2927
  <dd>
2859
2928
 
2860
- **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2929
+ **request:** `Hume.PostedTts`
2861
2930
 
2862
2931
  </dd>
2863
2932
  </dl>
@@ -2865,7 +2934,7 @@ const response = page.response;
2865
2934
  <dl>
2866
2935
  <dd>
2867
2936
 
2868
- **requestOptions:** `Chats.RequestOptions`
2937
+ **requestOptions:** `Tts.RequestOptions`
2869
2938
 
2870
2939
  </dd>
2871
2940
  </dl>
@@ -2877,7 +2946,7 @@ const response = page.response;
2877
2946
  </dl>
2878
2947
  </details>
2879
2948
 
2880
- <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, Hume.ReturnChatPagedEvents></code></summary>
2949
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> core.BinaryResponse</code></summary>
2881
2950
  <dl>
2882
2951
  <dd>
2883
2952
 
@@ -2889,7 +2958,7 @@ const response = page.response;
2889
2958
  <dl>
2890
2959
  <dd>
2891
2960
 
2892
- Fetches a paginated list of **Chat** events.
2961
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
2893
2962
  </dd>
2894
2963
  </dl>
2895
2964
  </dd>
@@ -2904,27 +2973,15 @@ Fetches a paginated list of **Chat** events.
2904
2973
  <dd>
2905
2974
 
2906
2975
  ```typescript
2907
- const pageableResponse = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2908
- pageNumber: 0,
2909
- pageSize: 3,
2910
- ascendingOrder: true
2911
- });
2912
- for await (const item of pageableResponse) {
2913
- console.log(item);
2914
- }
2915
-
2916
- // Or you can manually iterate page-by-page
2917
- let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2918
- pageNumber: 0,
2919
- pageSize: 3,
2920
- ascendingOrder: true
2976
+ await client.tts.synthesizeFileStreaming({
2977
+ utterances: [{
2978
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2979
+ voice: {
2980
+ name: "Male English Actor",
2981
+ provider: "HUME_AI"
2982
+ }
2983
+ }]
2921
2984
  });
2922
- while (page.hasNextPage()) {
2923
- page = page.getNextPage();
2924
- }
2925
-
2926
- // You can also access the underlying response
2927
- const response = page.response;
2928
2985
 
2929
2986
  ```
2930
2987
  </dd>
@@ -2940,15 +2997,7 @@ const response = page.response;
2940
2997
  <dl>
2941
2998
  <dd>
2942
2999
 
2943
- **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2944
-
2945
- </dd>
2946
- </dl>
2947
-
2948
- <dl>
2949
- <dd>
2950
-
2951
- **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
3000
+ **request:** `Hume.PostedTts`
2952
3001
 
2953
3002
  </dd>
2954
3003
  </dl>
@@ -2956,7 +3005,7 @@ const response = page.response;
2956
3005
  <dl>
2957
3006
  <dd>
2958
3007
 
2959
- **requestOptions:** `Chats.RequestOptions`
3008
+ **requestOptions:** `Tts.RequestOptions`
2960
3009
 
2961
3010
  </dd>
2962
3011
  </dl>
@@ -2968,7 +3017,7 @@ const response = page.response;
2968
3017
  </dl>
2969
3018
  </details>
2970
3019
 
2971
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
3020
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
2972
3021
  <dl>
2973
3022
  <dd>
2974
3023
 
@@ -2980,7 +3029,9 @@ const response = page.response;
2980
3029
  <dl>
2981
3030
  <dd>
2982
3031
 
2983
- Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
3032
+ Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
3033
+
3034
+ The response is a stream of JSON objects including audio encoded in base64.
2984
3035
  </dd>
2985
3036
  </dl>
2986
3037
  </dd>
@@ -2995,7 +3046,18 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
2995
3046
  <dd>
2996
3047
 
2997
3048
  ```typescript
2998
- await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
3049
+ const response = await client.tts.synthesizeJsonStreaming({
3050
+ utterances: [{
3051
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
3052
+ voice: {
3053
+ name: "Male English Actor",
3054
+ provider: "HUME_AI"
3055
+ }
3056
+ }]
3057
+ });
3058
+ for await (const item of response) {
3059
+ console.log(item);
3060
+ }
2999
3061
 
3000
3062
  ```
3001
3063
  </dd>
@@ -3011,7 +3073,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
3011
3073
  <dl>
3012
3074
  <dd>
3013
3075
 
3014
- **id:** `string` — Identifier for a chat. Formatted as a UUID.
3076
+ **request:** `Hume.PostedTts`
3015
3077
 
3016
3078
  </dd>
3017
3079
  </dl>
@@ -3019,7 +3081,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
3019
3081
  <dl>
3020
3082
  <dd>
3021
3083
 
3022
- **requestOptions:** `Chats.RequestOptions`
3084
+ **requestOptions:** `Tts.RequestOptions`
3023
3085
 
3024
3086
  </dd>
3025
3087
  </dl>
@@ -3031,25 +3093,10 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
3031
3093
  </dl>
3032
3094
  </details>
3033
3095
 
3034
- ## EmpathicVoice ChatGroups
3035
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
3036
- <dl>
3037
- <dd>
3038
-
3039
- #### 📝 Description
3040
-
3041
- <dl>
3042
- <dd>
3043
-
3096
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
3044
3097
  <dl>
3045
3098
  <dd>
3046
3099
 
3047
- Fetches a paginated list of **Chat Groups**.
3048
- </dd>
3049
- </dl>
3050
- </dd>
3051
- </dl>
3052
-
3053
3100
  #### 🔌 Usage
3054
3101
 
3055
3102
  <dl>
@@ -3059,30 +3106,11 @@ Fetches a paginated list of **Chat Groups**.
3059
3106
  <dd>
3060
3107
 
3061
3108
  ```typescript
3062
- const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
3063
- pageNumber: 0,
3064
- pageSize: 1,
3065
- ascendingOrder: true,
3066
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
3067
- });
3068
- for await (const item of pageableResponse) {
3109
+ const response = await client.tts.convertVoiceJson({});
3110
+ for await (const item of response) {
3069
3111
  console.log(item);
3070
3112
  }
3071
3113
 
3072
- // Or you can manually iterate page-by-page
3073
- let page = await client.empathicVoice.chatGroups.listChatGroups({
3074
- pageNumber: 0,
3075
- pageSize: 1,
3076
- ascendingOrder: true,
3077
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
3078
- });
3079
- while (page.hasNextPage()) {
3080
- page = page.getNextPage();
3081
- }
3082
-
3083
- // You can also access the underlying response
3084
- const response = page.response;
3085
-
3086
3114
  ```
3087
3115
  </dd>
3088
3116
  </dl>
@@ -3097,7 +3125,7 @@ const response = page.response;
3097
3125
  <dl>
3098
3126
  <dd>
3099
3127
 
3100
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
3128
+ **request:** `Hume.tts.ConvertVoiceJsonRequest`
3101
3129
 
3102
3130
  </dd>
3103
3131
  </dl>
@@ -3105,7 +3133,7 @@ const response = page.response;
3105
3133
  <dl>
3106
3134
  <dd>
3107
3135
 
3108
- **requestOptions:** `ChatGroups.RequestOptions`
3136
+ **requestOptions:** `Tts.RequestOptions`
3109
3137
 
3110
3138
  </dd>
3111
3139
  </dl>
@@ -3117,7 +3145,8 @@ const response = page.response;
3117
3145
  </dl>
3118
3146
  </details>
3119
3147
 
3120
- <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>
3148
+ ## Tts Voices
3149
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
3121
3150
  <dl>
3122
3151
  <dd>
3123
3152
 
@@ -3129,7 +3158,7 @@ const response = page.response;
3129
3158
  <dl>
3130
3159
  <dd>
3131
3160
 
3132
- Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
3161
+ Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
3133
3162
  </dd>
3134
3163
  </dl>
3135
3164
  </dd>
@@ -3144,11 +3173,23 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
3144
3173
  <dd>
3145
3174
 
3146
3175
  ```typescript
3147
- await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3148
- pageNumber: 0,
3149
- pageSize: 1,
3150
- ascendingOrder: true
3176
+ const pageableResponse = await client.tts.voices.list({
3177
+ provider: "CUSTOM_VOICE"
3178
+ });
3179
+ for await (const item of pageableResponse) {
3180
+ console.log(item);
3181
+ }
3182
+
3183
+ // Or you can manually iterate page-by-page
3184
+ let page = await client.tts.voices.list({
3185
+ provider: "CUSTOM_VOICE"
3151
3186
  });
3187
+ while (page.hasNextPage()) {
3188
+ page = page.getNextPage();
3189
+ }
3190
+
3191
+ // You can also access the underlying response
3192
+ const response = page.response;
3152
3193
 
3153
3194
  ```
3154
3195
  </dd>
@@ -3164,15 +3205,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3164
3205
  <dl>
3165
3206
  <dd>
3166
3207
 
3167
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3168
-
3169
- </dd>
3170
- </dl>
3171
-
3172
- <dl>
3173
- <dd>
3174
-
3175
- **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
3208
+ **request:** `Hume.tts.VoicesListRequest`
3176
3209
 
3177
3210
  </dd>
3178
3211
  </dl>
@@ -3180,7 +3213,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3180
3213
  <dl>
3181
3214
  <dd>
3182
3215
 
3183
- **requestOptions:** `ChatGroups.RequestOptions`
3216
+ **requestOptions:** `Voices.RequestOptions`
3184
3217
 
3185
3218
  </dd>
3186
3219
  </dl>
@@ -3192,7 +3225,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3192
3225
  </dl>
3193
3226
  </details>
3194
3227
 
3195
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
3228
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
3196
3229
  <dl>
3197
3230
  <dd>
3198
3231
 
@@ -3204,7 +3237,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3204
3237
  <dl>
3205
3238
  <dd>
3206
3239
 
3207
- Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3240
+ Saves a new custom voice to your account using the specified TTS generation ID.
3241
+
3242
+ Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
3208
3243
  </dd>
3209
3244
  </dl>
3210
3245
  </dd>
@@ -3219,27 +3254,10 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3219
3254
  <dd>
3220
3255
 
3221
3256
  ```typescript
3222
- const pageableResponse = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3223
- pageNumber: 0,
3224
- pageSize: 3,
3225
- ascendingOrder: true
3226
- });
3227
- for await (const item of pageableResponse) {
3228
- console.log(item);
3229
- }
3230
-
3231
- // Or you can manually iterate page-by-page
3232
- let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3233
- pageNumber: 0,
3234
- pageSize: 3,
3235
- ascendingOrder: true
3257
+ await client.tts.voices.create({
3258
+ generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
3259
+ name: "David Hume"
3236
3260
  });
3237
- while (page.hasNextPage()) {
3238
- page = page.getNextPage();
3239
- }
3240
-
3241
- // You can also access the underlying response
3242
- const response = page.response;
3243
3261
 
3244
3262
  ```
3245
3263
  </dd>
@@ -3255,15 +3273,7 @@ const response = page.response;
3255
3273
  <dl>
3256
3274
  <dd>
3257
3275
 
3258
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3259
-
3260
- </dd>
3261
- </dl>
3262
-
3263
- <dl>
3264
- <dd>
3265
-
3266
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
3276
+ **request:** `Hume.tts.PostedVoice`
3267
3277
 
3268
3278
  </dd>
3269
3279
  </dl>
@@ -3271,7 +3281,7 @@ const response = page.response;
3271
3281
  <dl>
3272
3282
  <dd>
3273
3283
 
3274
- **requestOptions:** `ChatGroups.RequestOptions`
3284
+ **requestOptions:** `Voices.RequestOptions`
3275
3285
 
3276
3286
  </dd>
3277
3287
  </dl>
@@ -3283,7 +3293,7 @@ const response = page.response;
3283
3293
  </dl>
3284
3294
  </details>
3285
3295
 
3286
- <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>
3296
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
3287
3297
  <dl>
3288
3298
  <dd>
3289
3299
 
@@ -3295,7 +3305,7 @@ const response = page.response;
3295
3305
  <dl>
3296
3306
  <dd>
3297
3307
 
3298
- 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/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
3308
+ Deletes a previously generated custom voice.
3299
3309
  </dd>
3300
3310
  </dl>
3301
3311
  </dd>
@@ -3310,10 +3320,8 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
3310
3320
  <dd>
3311
3321
 
3312
3322
  ```typescript
3313
- await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
3314
- pageNumber: 0,
3315
- pageSize: 10,
3316
- ascendingOrder: true
3323
+ await client.tts.voices.delete({
3324
+ name: "David Hume"
3317
3325
  });
3318
3326
 
3319
3327
  ```
@@ -3330,15 +3338,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3330
3338
  <dl>
3331
3339
  <dd>
3332
3340
 
3333
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3334
-
3335
- </dd>
3336
- </dl>
3337
-
3338
- <dl>
3339
- <dd>
3340
-
3341
- **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
3341
+ **request:** `Hume.tts.VoicesDeleteRequest`
3342
3342
 
3343
3343
  </dd>
3344
3344
  </dl>
@@ -3346,7 +3346,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3346
3346
  <dl>
3347
3347
  <dd>
3348
3348
 
3349
- **requestOptions:** `ChatGroups.RequestOptions`
3349
+ **requestOptions:** `Voices.RequestOptions`
3350
3350
 
3351
3351
  </dd>
3352
3352
  </dl>