hume 0.13.4 → 0.13.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +8 -3
  2. package/.mock/definition/tts/__package__.yml +4 -0
  3. package/.mock/definition/tts/streamInput.yml +30 -2
  4. package/.mock/fern.config.json +1 -1
  5. package/Client.js +10 -3
  6. package/api/resources/empathicVoice/types/ReturnConfig.d.ts +2 -2
  7. package/api/resources/empathicVoice/types/SessionSettings.d.ts +2 -0
  8. package/api/resources/index.d.ts +1 -1
  9. package/api/resources/index.js +2 -2
  10. package/api/resources/tts/types/SnippetAudioChunk.d.ts +5 -0
  11. package/dist/Client.js +10 -3
  12. package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +2 -2
  13. package/dist/api/resources/empathicVoice/types/SessionSettings.d.ts +2 -0
  14. package/dist/api/resources/index.d.ts +1 -1
  15. package/dist/api/resources/index.js +2 -2
  16. package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +5 -0
  17. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
  18. package/dist/serialization/resources/empathicVoice/types/ReturnConfig.js +1 -1
  19. package/dist/serialization/resources/empathicVoice/types/SessionSettings.d.ts +1 -0
  20. package/dist/serialization/resources/empathicVoice/types/SessionSettings.js +1 -0
  21. package/dist/serialization/resources/index.d.ts +1 -1
  22. package/dist/serialization/resources/index.js +2 -2
  23. package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +1 -0
  24. package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +1 -0
  25. package/dist/version.d.ts +1 -1
  26. package/dist/version.js +1 -1
  27. package/dist/wrapper/SilenceFiller.d.ts +85 -0
  28. package/dist/wrapper/SilenceFiller.js +203 -0
  29. package/dist/wrapper/collate.d.ts +36 -0
  30. package/dist/wrapper/collate.js +126 -0
  31. package/dist/wrapper/index.d.ts +2 -0
  32. package/dist/wrapper/index.js +5 -1
  33. package/package.json +1 -1
  34. package/reference.md +702 -702
  35. package/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
  36. package/serialization/resources/empathicVoice/types/ReturnConfig.js +1 -1
  37. package/serialization/resources/empathicVoice/types/SessionSettings.d.ts +1 -0
  38. package/serialization/resources/empathicVoice/types/SessionSettings.js +1 -0
  39. package/serialization/resources/index.d.ts +1 -1
  40. package/serialization/resources/index.js +2 -2
  41. package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +1 -0
  42. package/serialization/resources/tts/types/SnippetAudioChunk.js +1 -0
  43. package/version.d.ts +1 -1
  44. package/version.js +1 -1
  45. package/wrapper/SilenceFiller.d.ts +85 -0
  46. package/wrapper/SilenceFiller.js +203 -0
  47. package/wrapper/collate.d.ts +36 -0
  48. package/wrapper/collate.js +126 -0
  49. package/wrapper/index.d.ts +2 -0
  50. package/wrapper/index.js +5 -1
package/reference.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Reference
2
2
 
3
- ## Tts
3
+ ## EmpathicVoice Tools
4
4
 
5
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
5
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -14,9 +14,9 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- 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.
17
+ Fetches a paginated list of **Tools**.
18
18
 
19
- The response includes the base64-encoded audio and metadata in JSON format.
19
+ 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.
20
20
 
21
21
  </dd>
22
22
  </dl>
@@ -32,28 +32,22 @@ The response includes the base64-encoded audio and metadata in JSON format.
32
32
  <dd>
33
33
 
34
34
  ```typescript
35
- await client.tts.synthesizeJson({
36
- context: {
37
- utterances: [
38
- {
39
- text: "How can people see beauty so differently?",
40
- description:
41
- "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
42
- },
43
- ],
44
- },
45
- format: {
46
- type: "mp3",
47
- },
48
- numGenerations: 1,
49
- utterances: [
50
- {
51
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
52
- description:
53
- "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
54
- },
55
- ],
35
+ const response = await client.empathicVoice.tools.listTools({
36
+ pageNumber: 0,
37
+ pageSize: 2,
56
38
  });
39
+ for await (const item of response) {
40
+ console.log(item);
41
+ }
42
+
43
+ // Or you can manually iterate page-by-page
44
+ const page = await client.empathicVoice.tools.listTools({
45
+ pageNumber: 0,
46
+ pageSize: 2,
47
+ });
48
+ while (page.hasNextPage()) {
49
+ page = page.getNextPage();
50
+ }
57
51
  ```
58
52
 
59
53
  </dd>
@@ -69,7 +63,7 @@ await client.tts.synthesizeJson({
69
63
  <dl>
70
64
  <dd>
71
65
 
72
- **request:** `Hume.PostedTts`
66
+ **request:** `Hume.empathicVoice.ToolsListToolsRequest`
73
67
 
74
68
  </dd>
75
69
  </dl>
@@ -77,7 +71,7 @@ await client.tts.synthesizeJson({
77
71
  <dl>
78
72
  <dd>
79
73
 
80
- **requestOptions:** `Tts.RequestOptions`
74
+ **requestOptions:** `Tools.RequestOptions`
81
75
 
82
76
  </dd>
83
77
  </dl>
@@ -88,7 +82,7 @@ await client.tts.synthesizeJson({
88
82
  </dl>
89
83
  </details>
90
84
 
91
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> stream.Readable</code></summary>
85
+ <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>
92
86
  <dl>
93
87
  <dd>
94
88
 
@@ -100,9 +94,9 @@ await client.tts.synthesizeJson({
100
94
  <dl>
101
95
  <dd>
102
96
 
103
- 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.
97
+ Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
104
98
 
105
- The response contains the generated audio file in the requested format.
99
+ 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.
106
100
 
107
101
  </dd>
108
102
  </dl>
@@ -118,21 +112,13 @@ The response contains the generated audio file in the requested format.
118
112
  <dd>
119
113
 
120
114
  ```typescript
121
- await client.tts.synthesizeFile({
122
- context: {
123
- generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
124
- },
125
- format: {
126
- type: "mp3",
127
- },
128
- numGenerations: 1,
129
- utterances: [
130
- {
131
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
132
- description:
133
- "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
134
- },
135
- ],
115
+ await client.empathicVoice.tools.createTool({
116
+ name: "get_current_weather",
117
+ parameters:
118
+ '{ "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"] }',
119
+ versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
120
+ description: "This tool is for getting the current weather.",
121
+ fallbackContent: "Unable to fetch current weather.",
136
122
  });
137
123
  ```
138
124
 
@@ -149,7 +135,7 @@ await client.tts.synthesizeFile({
149
135
  <dl>
150
136
  <dd>
151
137
 
152
- **request:** `Hume.PostedTts`
138
+ **request:** `Hume.empathicVoice.PostedUserDefinedTool`
153
139
 
154
140
  </dd>
155
141
  </dl>
@@ -157,7 +143,7 @@ await client.tts.synthesizeFile({
157
143
  <dl>
158
144
  <dd>
159
145
 
160
- **requestOptions:** `Tts.RequestOptions`
146
+ **requestOptions:** `Tools.RequestOptions`
161
147
 
162
148
  </dd>
163
149
  </dl>
@@ -168,7 +154,7 @@ await client.tts.synthesizeFile({
168
154
  </dl>
169
155
  </details>
170
156
 
171
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.SnippetAudioChunk></code></summary>
157
+ <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></code></summary>
172
158
  <dl>
173
159
  <dd>
174
160
 
@@ -180,9 +166,9 @@ await client.tts.synthesizeFile({
180
166
  <dl>
181
167
  <dd>
182
168
 
183
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
169
+ Fetches a list of a **Tool's** versions.
184
170
 
185
- The response is a stream of JSON objects including audio encoded in base64.
171
+ 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.
186
172
 
187
173
  </dd>
188
174
  </dl>
@@ -198,20 +184,16 @@ The response is a stream of JSON objects including audio encoded in base64.
198
184
  <dd>
199
185
 
200
186
  ```typescript
201
- const response = await client.tts.synthesizeJsonStreaming({
202
- utterances: [
203
- {
204
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
205
- voice: {
206
- name: "Male English Actor",
207
- provider: "HUME_AI",
208
- },
209
- },
210
- ],
211
- });
187
+ const response = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
212
188
  for await (const item of response) {
213
189
  console.log(item);
214
190
  }
191
+
192
+ // Or you can manually iterate page-by-page
193
+ const page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
194
+ while (page.hasNextPage()) {
195
+ page = page.getNextPage();
196
+ }
215
197
  ```
216
198
 
217
199
  </dd>
@@ -227,7 +209,7 @@ for await (const item of response) {
227
209
  <dl>
228
210
  <dd>
229
211
 
230
- **request:** `Hume.PostedTts`
212
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
231
213
 
232
214
  </dd>
233
215
  </dl>
@@ -235,7 +217,15 @@ for await (const item of response) {
235
217
  <dl>
236
218
  <dd>
237
219
 
238
- **requestOptions:** `Tts.RequestOptions`
220
+ **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
221
+
222
+ </dd>
223
+ </dl>
224
+
225
+ <dl>
226
+ <dd>
227
+
228
+ **requestOptions:** `Tools.RequestOptions`
239
229
 
240
230
  </dd>
241
231
  </dl>
@@ -246,7 +236,7 @@ for await (const item of response) {
246
236
  </dl>
247
237
  </details>
248
238
 
249
- <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
239
+ <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>
250
240
  <dl>
251
241
  <dd>
252
242
 
@@ -258,7 +248,9 @@ for await (const item of response) {
258
248
  <dl>
259
249
  <dd>
260
250
 
261
- Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
251
+ Updates a **Tool** by creating a new version of the **Tool**.
252
+
253
+ 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.
262
254
 
263
255
  </dd>
264
256
  </dl>
@@ -274,16 +266,12 @@ Streams synthesized speech using the specified voice. If no voice is provided, a
274
266
  <dd>
275
267
 
276
268
  ```typescript
277
- await client.tts.synthesizeFileStreaming({
278
- utterances: [
279
- {
280
- text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
281
- voice: {
282
- name: "Male English Actor",
283
- provider: "HUME_AI",
284
- },
285
- },
286
- ],
269
+ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
270
+ parameters:
271
+ '{ "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"] }',
272
+ versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
273
+ fallbackContent: "Unable to fetch current weather.",
274
+ description: "This tool is for getting the current weather.",
287
275
  });
288
276
  ```
289
277
 
@@ -300,7 +288,7 @@ await client.tts.synthesizeFileStreaming({
300
288
  <dl>
301
289
  <dd>
302
290
 
303
- **request:** `Hume.PostedTts`
291
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
304
292
 
305
293
  </dd>
306
294
  </dl>
@@ -308,7 +296,15 @@ await client.tts.synthesizeFileStreaming({
308
296
  <dl>
309
297
  <dd>
310
298
 
311
- **requestOptions:** `Tts.RequestOptions`
299
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
300
+
301
+ </dd>
302
+ </dl>
303
+
304
+ <dl>
305
+ <dd>
306
+
307
+ **requestOptions:** `Tools.RequestOptions`
312
308
 
313
309
  </dd>
314
310
  </dl>
@@ -319,9 +315,7 @@ await client.tts.synthesizeFileStreaming({
319
315
  </dl>
320
316
  </details>
321
317
 
322
- ## Tts Voices
323
-
324
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice></code></summary>
318
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
325
319
  <dl>
326
320
  <dd>
327
321
 
@@ -333,7 +327,9 @@ await client.tts.synthesizeFileStreaming({
333
327
  <dl>
334
328
  <dd>
335
329
 
336
- Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
330
+ Deletes a **Tool** and its versions.
331
+
332
+ 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.
337
333
 
338
334
  </dd>
339
335
  </dl>
@@ -349,20 +345,7 @@ Lists voices you have saved in your account, or voices from the [Voice Library](
349
345
  <dd>
350
346
 
351
347
  ```typescript
352
- const response = await client.tts.voices.list({
353
- provider: "CUSTOM_VOICE",
354
- });
355
- for await (const item of response) {
356
- console.log(item);
357
- }
358
-
359
- // Or you can manually iterate page-by-page
360
- const page = await client.tts.voices.list({
361
- provider: "CUSTOM_VOICE",
362
- });
363
- while (page.hasNextPage()) {
364
- page = page.getNextPage();
365
- }
348
+ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
366
349
  ```
367
350
 
368
351
  </dd>
@@ -378,7 +361,7 @@ while (page.hasNextPage()) {
378
361
  <dl>
379
362
  <dd>
380
363
 
381
- **request:** `Hume.tts.VoicesListRequest`
364
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
382
365
 
383
366
  </dd>
384
367
  </dl>
@@ -386,7 +369,7 @@ while (page.hasNextPage()) {
386
369
  <dl>
387
370
  <dd>
388
371
 
389
- **requestOptions:** `Voices.RequestOptions`
372
+ **requestOptions:** `Tools.RequestOptions`
390
373
 
391
374
  </dd>
392
375
  </dl>
@@ -397,7 +380,7 @@ while (page.hasNextPage()) {
397
380
  </dl>
398
381
  </details>
399
382
 
400
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
383
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
401
384
  <dl>
402
385
  <dd>
403
386
 
@@ -409,9 +392,9 @@ while (page.hasNextPage()) {
409
392
  <dl>
410
393
  <dd>
411
394
 
412
- Saves a new custom voice to your account using the specified TTS generation ID.
395
+ Updates the name of a **Tool**.
413
396
 
414
- 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).
397
+ 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.
415
398
 
416
399
  </dd>
417
400
  </dl>
@@ -427,9 +410,8 @@ Once saved, this voice can be reused in subsequent TTS requests, ensuring consis
427
410
  <dd>
428
411
 
429
412
  ```typescript
430
- await client.tts.voices.create({
431
- generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
432
- name: "David Hume",
413
+ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
414
+ name: "get_current_temperature",
433
415
  });
434
416
  ```
435
417
 
@@ -446,7 +428,7 @@ await client.tts.voices.create({
446
428
  <dl>
447
429
  <dd>
448
430
 
449
- **request:** `Hume.tts.PostedVoice`
431
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
450
432
 
451
433
  </dd>
452
434
  </dl>
@@ -454,7 +436,15 @@ await client.tts.voices.create({
454
436
  <dl>
455
437
  <dd>
456
438
 
457
- **requestOptions:** `Voices.RequestOptions`
439
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
440
+
441
+ </dd>
442
+ </dl>
443
+
444
+ <dl>
445
+ <dd>
446
+
447
+ **requestOptions:** `Tools.RequestOptions`
458
448
 
459
449
  </dd>
460
450
  </dl>
@@ -465,7 +455,7 @@ await client.tts.voices.create({
465
455
  </dl>
466
456
  </details>
467
457
 
468
- <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
458
+ <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>
469
459
  <dl>
470
460
  <dd>
471
461
 
@@ -477,7 +467,9 @@ await client.tts.voices.create({
477
467
  <dl>
478
468
  <dd>
479
469
 
480
- Deletes a previously generated custom voice.
470
+ Fetches a specified version of a **Tool**.
471
+
472
+ 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.
481
473
 
482
474
  </dd>
483
475
  </dl>
@@ -493,9 +485,7 @@ Deletes a previously generated custom voice.
493
485
  <dd>
494
486
 
495
487
  ```typescript
496
- await client.tts.voices.delete({
497
- name: "David Hume",
498
- });
488
+ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
499
489
  ```
500
490
 
501
491
  </dd>
@@ -511,7 +501,7 @@ await client.tts.voices.delete({
511
501
  <dl>
512
502
  <dd>
513
503
 
514
- **request:** `Hume.tts.VoicesDeleteRequest`
504
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
515
505
 
516
506
  </dd>
517
507
  </dl>
@@ -519,7 +509,21 @@ await client.tts.voices.delete({
519
509
  <dl>
520
510
  <dd>
521
511
 
522
- **requestOptions:** `Voices.RequestOptions`
512
+ **version:** `number`
513
+
514
+ Version number for a Tool.
515
+
516
+ 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.
517
+
518
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
519
+
520
+ </dd>
521
+ </dl>
522
+
523
+ <dl>
524
+ <dd>
525
+
526
+ **requestOptions:** `Tools.RequestOptions`
523
527
 
524
528
  </dd>
525
529
  </dl>
@@ -530,9 +534,7 @@ await client.tts.voices.delete({
530
534
  </dl>
531
535
  </details>
532
536
 
533
- ## EmpathicVoice Tools
534
-
535
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
537
+ <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
536
538
  <dl>
537
539
  <dd>
538
540
 
@@ -544,7 +546,7 @@ await client.tts.voices.delete({
544
546
  <dl>
545
547
  <dd>
546
548
 
547
- Fetches a paginated list of **Tools**.
549
+ Deletes a specified version of a **Tool**.
548
550
 
549
551
  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.
550
552
 
@@ -562,22 +564,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
562
564
  <dd>
563
565
 
564
566
  ```typescript
565
- const response = await client.empathicVoice.tools.listTools({
566
- pageNumber: 0,
567
- pageSize: 2,
568
- });
569
- for await (const item of response) {
570
- console.log(item);
571
- }
572
-
573
- // Or you can manually iterate page-by-page
574
- const page = await client.empathicVoice.tools.listTools({
575
- pageNumber: 0,
576
- pageSize: 2,
577
- });
578
- while (page.hasNextPage()) {
579
- page = page.getNextPage();
580
- }
567
+ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
581
568
  ```
582
569
 
583
570
  </dd>
@@ -593,7 +580,7 @@ while (page.hasNextPage()) {
593
580
  <dl>
594
581
  <dd>
595
582
 
596
- **request:** `Hume.empathicVoice.ToolsListToolsRequest`
583
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
597
584
 
598
585
  </dd>
599
586
  </dl>
@@ -601,9 +588,23 @@ while (page.hasNextPage()) {
601
588
  <dl>
602
589
  <dd>
603
590
 
604
- **requestOptions:** `Tools.RequestOptions`
591
+ **version:** `number`
605
592
 
606
- </dd>
593
+ Version number for a Tool.
594
+
595
+ 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.
596
+
597
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
598
+
599
+ </dd>
600
+ </dl>
601
+
602
+ <dl>
603
+ <dd>
604
+
605
+ **requestOptions:** `Tools.RequestOptions`
606
+
607
+ </dd>
607
608
  </dl>
608
609
  </dd>
609
610
  </dl>
@@ -612,7 +613,7 @@ while (page.hasNextPage()) {
612
613
  </dl>
613
614
  </details>
614
615
 
615
- <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>
616
+ <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>
616
617
  <dl>
617
618
  <dd>
618
619
 
@@ -624,7 +625,7 @@ while (page.hasNextPage()) {
624
625
  <dl>
625
626
  <dd>
626
627
 
627
- Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
628
+ Updates the description of a specified **Tool** version.
628
629
 
629
630
  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.
630
631
 
@@ -642,13 +643,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
642
643
  <dd>
643
644
 
644
645
  ```typescript
645
- await client.empathicVoice.tools.createTool({
646
- name: "get_current_weather",
647
- parameters:
648
- '{ "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"] }',
649
- versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
650
- description: "This tool is for getting the current weather.",
651
- fallbackContent: "Unable to fetch current weather.",
646
+ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
647
+ versionDescription:
648
+ "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
652
649
  });
653
650
  ```
654
651
 
@@ -665,7 +662,29 @@ await client.empathicVoice.tools.createTool({
665
662
  <dl>
666
663
  <dd>
667
664
 
668
- **request:** `Hume.empathicVoice.PostedUserDefinedTool`
665
+ **id:** `string` — Identifier for a Tool. Formatted as a UUID.
666
+
667
+ </dd>
668
+ </dl>
669
+
670
+ <dl>
671
+ <dd>
672
+
673
+ **version:** `number`
674
+
675
+ Version number for a Tool.
676
+
677
+ 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.
678
+
679
+ Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
680
+
681
+ </dd>
682
+ </dl>
683
+
684
+ <dl>
685
+ <dd>
686
+
687
+ **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
669
688
 
670
689
  </dd>
671
690
  </dl>
@@ -684,7 +703,9 @@ await client.empathicVoice.tools.createTool({
684
703
  </dl>
685
704
  </details>
686
705
 
687
- <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></code></summary>
706
+ ## EmpathicVoice Prompts
707
+
708
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
688
709
  <dl>
689
710
  <dd>
690
711
 
@@ -696,9 +717,9 @@ await client.empathicVoice.tools.createTool({
696
717
  <dl>
697
718
  <dd>
698
719
 
699
- Fetches a list of a **Tool's** versions.
720
+ Fetches a paginated list of **Prompts**.
700
721
 
701
- 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.
722
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
702
723
 
703
724
  </dd>
704
725
  </dl>
@@ -714,13 +735,19 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
714
735
  <dd>
715
736
 
716
737
  ```typescript
717
- const response = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
738
+ const response = await client.empathicVoice.prompts.listPrompts({
739
+ pageNumber: 0,
740
+ pageSize: 2,
741
+ });
718
742
  for await (const item of response) {
719
743
  console.log(item);
720
744
  }
721
745
 
722
746
  // Or you can manually iterate page-by-page
723
- const page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
747
+ const page = await client.empathicVoice.prompts.listPrompts({
748
+ pageNumber: 0,
749
+ pageSize: 2,
750
+ });
724
751
  while (page.hasNextPage()) {
725
752
  page = page.getNextPage();
726
753
  }
@@ -739,15 +766,7 @@ while (page.hasNextPage()) {
739
766
  <dl>
740
767
  <dd>
741
768
 
742
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
743
-
744
- </dd>
745
- </dl>
746
-
747
- <dl>
748
- <dd>
749
-
750
- **request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
769
+ **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
751
770
 
752
771
  </dd>
753
772
  </dl>
@@ -755,7 +774,7 @@ while (page.hasNextPage()) {
755
774
  <dl>
756
775
  <dd>
757
776
 
758
- **requestOptions:** `Tools.RequestOptions`
777
+ **requestOptions:** `Prompts.RequestOptions`
759
778
 
760
779
  </dd>
761
780
  </dl>
@@ -766,7 +785,7 @@ while (page.hasNextPage()) {
766
785
  </dl>
767
786
  </details>
768
787
 
769
- <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>
788
+ <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>
770
789
  <dl>
771
790
  <dd>
772
791
 
@@ -778,9 +797,9 @@ while (page.hasNextPage()) {
778
797
  <dl>
779
798
  <dd>
780
799
 
781
- Updates a **Tool** by creating a new version of the **Tool**.
800
+ Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
782
801
 
783
- 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.
802
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
784
803
 
785
804
  </dd>
786
805
  </dl>
@@ -796,12 +815,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
796
815
  <dd>
797
816
 
798
817
  ```typescript
799
- await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
800
- parameters:
801
- '{ "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"] }',
802
- versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
803
- fallbackContent: "Unable to fetch current weather.",
804
- description: "This tool is for getting the current weather.",
818
+ await client.empathicVoice.prompts.createPrompt({
819
+ name: "Weather Assistant Prompt",
820
+ 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>",
805
821
  });
806
822
  ```
807
823
 
@@ -818,15 +834,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
818
834
  <dl>
819
835
  <dd>
820
836
 
821
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
822
-
823
- </dd>
824
- </dl>
825
-
826
- <dl>
827
- <dd>
828
-
829
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
837
+ **request:** `Hume.empathicVoice.PostedPrompt`
830
838
 
831
839
  </dd>
832
840
  </dl>
@@ -834,7 +842,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
834
842
  <dl>
835
843
  <dd>
836
844
 
837
- **requestOptions:** `Tools.RequestOptions`
845
+ **requestOptions:** `Prompts.RequestOptions`
838
846
 
839
847
  </dd>
840
848
  </dl>
@@ -845,7 +853,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
845
853
  </dl>
846
854
  </details>
847
855
 
848
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
856
+ <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>
849
857
  <dl>
850
858
  <dd>
851
859
 
@@ -857,9 +865,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
857
865
  <dl>
858
866
  <dd>
859
867
 
860
- Deletes a **Tool** and its versions.
868
+ Fetches a list of a **Prompt's** versions.
861
869
 
862
- 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.
870
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
863
871
 
864
872
  </dd>
865
873
  </dl>
@@ -875,7 +883,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
875
883
  <dd>
876
884
 
877
885
  ```typescript
878
- await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
886
+ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
879
887
  ```
880
888
 
881
889
  </dd>
@@ -891,7 +899,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
891
899
  <dl>
892
900
  <dd>
893
901
 
894
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
902
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
895
903
 
896
904
  </dd>
897
905
  </dl>
@@ -899,7 +907,15 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
899
907
  <dl>
900
908
  <dd>
901
909
 
902
- **requestOptions:** `Tools.RequestOptions`
910
+ **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
911
+
912
+ </dd>
913
+ </dl>
914
+
915
+ <dl>
916
+ <dd>
917
+
918
+ **requestOptions:** `Prompts.RequestOptions`
903
919
 
904
920
  </dd>
905
921
  </dl>
@@ -910,7 +926,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
910
926
  </dl>
911
927
  </details>
912
928
 
913
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
929
+ <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>
914
930
  <dl>
915
931
  <dd>
916
932
 
@@ -922,9 +938,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
922
938
  <dl>
923
939
  <dd>
924
940
 
925
- Updates the name of a **Tool**.
941
+ Updates a **Prompt** by creating a new version of the **Prompt**.
926
942
 
927
- 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.
943
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
928
944
 
929
945
  </dd>
930
946
  </dl>
@@ -940,8 +956,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
940
956
  <dd>
941
957
 
942
958
  ```typescript
943
- await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
944
- name: "get_current_temperature",
959
+ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
960
+ 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>",
961
+ versionDescription: "This is an updated version of the Weather Assistant Prompt.",
945
962
  });
946
963
  ```
947
964
 
@@ -958,7 +975,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
958
975
  <dl>
959
976
  <dd>
960
977
 
961
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
978
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
962
979
 
963
980
  </dd>
964
981
  </dl>
@@ -966,7 +983,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
966
983
  <dl>
967
984
  <dd>
968
985
 
969
- **request:** `Hume.empathicVoice.PostedUserDefinedToolName`
986
+ **request:** `Hume.empathicVoice.PostedPromptVersion`
970
987
 
971
988
  </dd>
972
989
  </dl>
@@ -974,7 +991,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
974
991
  <dl>
975
992
  <dd>
976
993
 
977
- **requestOptions:** `Tools.RequestOptions`
994
+ **requestOptions:** `Prompts.RequestOptions`
978
995
 
979
996
  </dd>
980
997
  </dl>
@@ -985,7 +1002,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
985
1002
  </dl>
986
1003
  </details>
987
1004
 
988
- <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>
1005
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
989
1006
  <dl>
990
1007
  <dd>
991
1008
 
@@ -997,9 +1014,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
997
1014
  <dl>
998
1015
  <dd>
999
1016
 
1000
- Fetches a specified version of a **Tool**.
1017
+ Deletes a **Prompt** and its versions.
1001
1018
 
1002
- 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.
1019
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1003
1020
 
1004
1021
  </dd>
1005
1022
  </dl>
@@ -1015,7 +1032,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1015
1032
  <dd>
1016
1033
 
1017
1034
  ```typescript
1018
- await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1035
+ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1019
1036
  ```
1020
1037
 
1021
1038
  </dd>
@@ -1031,21 +1048,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
1031
1048
  <dl>
1032
1049
  <dd>
1033
1050
 
1034
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1035
-
1036
- </dd>
1037
- </dl>
1038
-
1039
- <dl>
1040
- <dd>
1041
-
1042
- **version:** `number`
1043
-
1044
- Version number for a Tool.
1045
-
1046
- 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.
1047
-
1048
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1051
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1049
1052
 
1050
1053
  </dd>
1051
1054
  </dl>
@@ -1053,7 +1056,7 @@ Version numbers are integer values representing different iterations of the Tool
1053
1056
  <dl>
1054
1057
  <dd>
1055
1058
 
1056
- **requestOptions:** `Tools.RequestOptions`
1059
+ **requestOptions:** `Prompts.RequestOptions`
1057
1060
 
1058
1061
  </dd>
1059
1062
  </dl>
@@ -1064,7 +1067,7 @@ Version numbers are integer values representing different iterations of the Tool
1064
1067
  </dl>
1065
1068
  </details>
1066
1069
 
1067
- <details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
1070
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1068
1071
  <dl>
1069
1072
  <dd>
1070
1073
 
@@ -1076,9 +1079,9 @@ Version numbers are integer values representing different iterations of the Tool
1076
1079
  <dl>
1077
1080
  <dd>
1078
1081
 
1079
- Deletes a specified version of a **Tool**.
1082
+ Updates the name of a **Prompt**.
1080
1083
 
1081
- 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.
1084
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1082
1085
 
1083
1086
  </dd>
1084
1087
  </dl>
@@ -1094,7 +1097,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1094
1097
  <dd>
1095
1098
 
1096
1099
  ```typescript
1097
- await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
1100
+ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1101
+ name: "Updated Weather Assistant Prompt Name",
1102
+ });
1098
1103
  ```
1099
1104
 
1100
1105
  </dd>
@@ -1110,7 +1115,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
1110
1115
  <dl>
1111
1116
  <dd>
1112
1117
 
1113
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1118
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1114
1119
 
1115
1120
  </dd>
1116
1121
  </dl>
@@ -1118,13 +1123,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
1118
1123
  <dl>
1119
1124
  <dd>
1120
1125
 
1121
- **version:** `number`
1122
-
1123
- Version number for a Tool.
1124
-
1125
- 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.
1126
-
1127
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1126
+ **request:** `Hume.empathicVoice.PostedPromptName`
1128
1127
 
1129
1128
  </dd>
1130
1129
  </dl>
@@ -1132,7 +1131,7 @@ Version numbers are integer values representing different iterations of the Tool
1132
1131
  <dl>
1133
1132
  <dd>
1134
1133
 
1135
- **requestOptions:** `Tools.RequestOptions`
1134
+ **requestOptions:** `Prompts.RequestOptions`
1136
1135
 
1137
1136
  </dd>
1138
1137
  </dl>
@@ -1143,7 +1142,7 @@ Version numbers are integer values representing different iterations of the Tool
1143
1142
  </dl>
1144
1143
  </details>
1145
1144
 
1146
- <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>
1145
+ <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>
1147
1146
  <dl>
1148
1147
  <dd>
1149
1148
 
@@ -1155,9 +1154,9 @@ Version numbers are integer values representing different iterations of the Tool
1155
1154
  <dl>
1156
1155
  <dd>
1157
1156
 
1158
- Updates the description of a specified **Tool** version.
1157
+ Fetches a specified version of a **Prompt**.
1159
1158
 
1160
- 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.
1159
+ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1161
1160
 
1162
1161
  </dd>
1163
1162
  </dl>
@@ -1173,10 +1172,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
1173
1172
  <dd>
1174
1173
 
1175
1174
  ```typescript
1176
- await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
1177
- versionDescription:
1178
- "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
1179
- });
1175
+ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1180
1176
  ```
1181
1177
 
1182
1178
  </dd>
@@ -1192,7 +1188,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
1192
1188
  <dl>
1193
1189
  <dd>
1194
1190
 
1195
- **id:** `string` — Identifier for a Tool. Formatted as a UUID.
1191
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1196
1192
 
1197
1193
  </dd>
1198
1194
  </dl>
@@ -1202,19 +1198,11 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
1202
1198
 
1203
1199
  **version:** `number`
1204
1200
 
1205
- Version number for a Tool.
1206
-
1207
- 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.
1208
-
1209
- Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
1210
-
1211
- </dd>
1212
- </dl>
1201
+ Version number for a Prompt.
1213
1202
 
1214
- <dl>
1215
- <dd>
1203
+ 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.
1216
1204
 
1217
- **request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
1205
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1218
1206
 
1219
1207
  </dd>
1220
1208
  </dl>
@@ -1222,7 +1210,7 @@ Version numbers are integer values representing different iterations of the Tool
1222
1210
  <dl>
1223
1211
  <dd>
1224
1212
 
1225
- **requestOptions:** `Tools.RequestOptions`
1213
+ **requestOptions:** `Prompts.RequestOptions`
1226
1214
 
1227
1215
  </dd>
1228
1216
  </dl>
@@ -1233,9 +1221,7 @@ Version numbers are integer values representing different iterations of the Tool
1233
1221
  </dl>
1234
1222
  </details>
1235
1223
 
1236
- ## EmpathicVoice Prompts
1237
-
1238
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
1224
+ <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1239
1225
  <dl>
1240
1226
  <dd>
1241
1227
 
@@ -1247,7 +1233,7 @@ Version numbers are integer values representing different iterations of the Tool
1247
1233
  <dl>
1248
1234
  <dd>
1249
1235
 
1250
- Fetches a paginated list of **Prompts**.
1236
+ Deletes a specified version of a **Prompt**.
1251
1237
 
1252
1238
  See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1253
1239
 
@@ -1265,22 +1251,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1265
1251
  <dd>
1266
1252
 
1267
1253
  ```typescript
1268
- const response = await client.empathicVoice.prompts.listPrompts({
1269
- pageNumber: 0,
1270
- pageSize: 2,
1271
- });
1272
- for await (const item of response) {
1273
- console.log(item);
1274
- }
1275
-
1276
- // Or you can manually iterate page-by-page
1277
- const page = await client.empathicVoice.prompts.listPrompts({
1278
- pageNumber: 0,
1279
- pageSize: 2,
1280
- });
1281
- while (page.hasNextPage()) {
1282
- page = page.getNextPage();
1283
- }
1254
+ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1284
1255
  ```
1285
1256
 
1286
1257
  </dd>
@@ -1296,7 +1267,7 @@ while (page.hasNextPage()) {
1296
1267
  <dl>
1297
1268
  <dd>
1298
1269
 
1299
- **request:** `Hume.empathicVoice.PromptsListPromptsRequest`
1270
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1300
1271
 
1301
1272
  </dd>
1302
1273
  </dl>
@@ -1304,18 +1275,32 @@ while (page.hasNextPage()) {
1304
1275
  <dl>
1305
1276
  <dd>
1306
1277
 
1307
- **requestOptions:** `Prompts.RequestOptions`
1278
+ **version:** `number`
1308
1279
 
1309
- </dd>
1310
- </dl>
1311
- </dd>
1312
- </dl>
1280
+ Version number for a Prompt.
1281
+
1282
+ 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.
1283
+
1284
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1285
+
1286
+ </dd>
1287
+ </dl>
1288
+
1289
+ <dl>
1290
+ <dd>
1291
+
1292
+ **requestOptions:** `Prompts.RequestOptions`
1293
+
1294
+ </dd>
1295
+ </dl>
1296
+ </dd>
1297
+ </dl>
1313
1298
 
1314
1299
  </dd>
1315
1300
  </dl>
1316
1301
  </details>
1317
1302
 
1318
- <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>
1303
+ <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>
1319
1304
  <dl>
1320
1305
  <dd>
1321
1306
 
@@ -1327,7 +1312,7 @@ while (page.hasNextPage()) {
1327
1312
  <dl>
1328
1313
  <dd>
1329
1314
 
1330
- Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
1315
+ Updates the description of a **Prompt**.
1331
1316
 
1332
1317
  See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1333
1318
 
@@ -1345,9 +1330,8 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1345
1330
  <dd>
1346
1331
 
1347
1332
  ```typescript
1348
- await client.empathicVoice.prompts.createPrompt({
1349
- name: "Weather Assistant Prompt",
1350
- 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>",
1333
+ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1334
+ versionDescription: "This is an updated version_description.",
1351
1335
  });
1352
1336
  ```
1353
1337
 
@@ -1364,7 +1348,29 @@ await client.empathicVoice.prompts.createPrompt({
1364
1348
  <dl>
1365
1349
  <dd>
1366
1350
 
1367
- **request:** `Hume.empathicVoice.PostedPrompt`
1351
+ **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1352
+
1353
+ </dd>
1354
+ </dl>
1355
+
1356
+ <dl>
1357
+ <dd>
1358
+
1359
+ **version:** `number`
1360
+
1361
+ Version number for a Prompt.
1362
+
1363
+ 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.
1364
+
1365
+ Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1366
+
1367
+ </dd>
1368
+ </dl>
1369
+
1370
+ <dl>
1371
+ <dd>
1372
+
1373
+ **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1368
1374
 
1369
1375
  </dd>
1370
1376
  </dl>
@@ -1383,7 +1389,9 @@ await client.empathicVoice.prompts.createPrompt({
1383
1389
  </dl>
1384
1390
  </details>
1385
1391
 
1386
- <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>
1392
+ ## EmpathicVoice Configs
1393
+
1394
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig></code></summary>
1387
1395
  <dl>
1388
1396
  <dd>
1389
1397
 
@@ -1395,9 +1403,9 @@ await client.empathicVoice.prompts.createPrompt({
1395
1403
  <dl>
1396
1404
  <dd>
1397
1405
 
1398
- Fetches a list of a **Prompt's** versions.
1406
+ Fetches a paginated list of **Configs**.
1399
1407
 
1400
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1408
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1401
1409
 
1402
1410
  </dd>
1403
1411
  </dl>
@@ -1413,7 +1421,22 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1413
1421
  <dd>
1414
1422
 
1415
1423
  ```typescript
1416
- await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
1424
+ const response = await client.empathicVoice.configs.listConfigs({
1425
+ pageNumber: 0,
1426
+ pageSize: 1,
1427
+ });
1428
+ for await (const item of response) {
1429
+ console.log(item);
1430
+ }
1431
+
1432
+ // Or you can manually iterate page-by-page
1433
+ const page = await client.empathicVoice.configs.listConfigs({
1434
+ pageNumber: 0,
1435
+ pageSize: 1,
1436
+ });
1437
+ while (page.hasNextPage()) {
1438
+ page = page.getNextPage();
1439
+ }
1417
1440
  ```
1418
1441
 
1419
1442
  </dd>
@@ -1429,15 +1452,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1429
1452
  <dl>
1430
1453
  <dd>
1431
1454
 
1432
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1433
-
1434
- </dd>
1435
- </dl>
1436
-
1437
- <dl>
1438
- <dd>
1439
-
1440
- **request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
1455
+ **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
1441
1456
 
1442
1457
  </dd>
1443
1458
  </dl>
@@ -1445,7 +1460,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1445
1460
  <dl>
1446
1461
  <dd>
1447
1462
 
1448
- **requestOptions:** `Prompts.RequestOptions`
1463
+ **requestOptions:** `Configs.RequestOptions`
1449
1464
 
1450
1465
  </dd>
1451
1466
  </dl>
@@ -1456,7 +1471,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1456
1471
  </dl>
1457
1472
  </details>
1458
1473
 
1459
- <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>
1474
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
1460
1475
  <dl>
1461
1476
  <dd>
1462
1477
 
@@ -1468,9 +1483,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
1468
1483
  <dl>
1469
1484
  <dd>
1470
1485
 
1471
- Updates a **Prompt** by creating a new version of the **Prompt**.
1486
+ Creates a **Config** which can be applied to EVI.
1472
1487
 
1473
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1488
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1474
1489
 
1475
1490
  </dd>
1476
1491
  </dl>
@@ -1486,9 +1501,36 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1486
1501
  <dd>
1487
1502
 
1488
1503
  ```typescript
1489
- await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1490
- 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>",
1491
- versionDescription: "This is an updated version of the Weather Assistant Prompt.",
1504
+ await client.empathicVoice.configs.createConfig({
1505
+ name: "Weather Assistant Config",
1506
+ prompt: {
1507
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1508
+ version: 0,
1509
+ },
1510
+ eviVersion: "3",
1511
+ voice: {
1512
+ provider: "HUME_AI",
1513
+ name: "Ava Song",
1514
+ },
1515
+ languageModel: {
1516
+ modelProvider: "ANTHROPIC",
1517
+ modelResource: "claude-3-7-sonnet-latest",
1518
+ temperature: 1,
1519
+ },
1520
+ eventMessages: {
1521
+ onNewChat: {
1522
+ enabled: false,
1523
+ text: "",
1524
+ },
1525
+ onInactivityTimeout: {
1526
+ enabled: false,
1527
+ text: "",
1528
+ },
1529
+ onMaxDurationTimeout: {
1530
+ enabled: false,
1531
+ text: "",
1532
+ },
1533
+ },
1492
1534
  });
1493
1535
  ```
1494
1536
 
@@ -1505,15 +1547,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1505
1547
  <dl>
1506
1548
  <dd>
1507
1549
 
1508
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1509
-
1510
- </dd>
1511
- </dl>
1512
-
1513
- <dl>
1514
- <dd>
1515
-
1516
- **request:** `Hume.empathicVoice.PostedPromptVersion`
1550
+ **request:** `Hume.empathicVoice.PostedConfig`
1517
1551
 
1518
1552
  </dd>
1519
1553
  </dl>
@@ -1521,7 +1555,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1521
1555
  <dl>
1522
1556
  <dd>
1523
1557
 
1524
- **requestOptions:** `Prompts.RequestOptions`
1558
+ **requestOptions:** `Configs.RequestOptions`
1525
1559
 
1526
1560
  </dd>
1527
1561
  </dl>
@@ -1532,7 +1566,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1532
1566
  </dl>
1533
1567
  </details>
1534
1568
 
1535
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
1569
+ <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></code></summary>
1536
1570
  <dl>
1537
1571
  <dd>
1538
1572
 
@@ -1544,9 +1578,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
1544
1578
  <dl>
1545
1579
  <dd>
1546
1580
 
1547
- Deletes a **Prompt** and its versions.
1581
+ Fetches a list of a **Config's** versions.
1548
1582
 
1549
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1583
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1550
1584
 
1551
1585
  </dd>
1552
1586
  </dl>
@@ -1562,7 +1596,16 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1562
1596
  <dd>
1563
1597
 
1564
1598
  ```typescript
1565
- await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
1599
+ const response = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1600
+ for await (const item of response) {
1601
+ console.log(item);
1602
+ }
1603
+
1604
+ // Or you can manually iterate page-by-page
1605
+ const page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1606
+ while (page.hasNextPage()) {
1607
+ page = page.getNextPage();
1608
+ }
1566
1609
  ```
1567
1610
 
1568
1611
  </dd>
@@ -1578,7 +1621,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1578
1621
  <dl>
1579
1622
  <dd>
1580
1623
 
1581
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1624
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1582
1625
 
1583
1626
  </dd>
1584
1627
  </dl>
@@ -1586,7 +1629,15 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1586
1629
  <dl>
1587
1630
  <dd>
1588
1631
 
1589
- **requestOptions:** `Prompts.RequestOptions`
1632
+ **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
1633
+
1634
+ </dd>
1635
+ </dl>
1636
+
1637
+ <dl>
1638
+ <dd>
1639
+
1640
+ **requestOptions:** `Configs.RequestOptions`
1590
1641
 
1591
1642
  </dd>
1592
1643
  </dl>
@@ -1597,7 +1648,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1597
1648
  </dl>
1598
1649
  </details>
1599
1650
 
1600
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
1651
+ <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>
1601
1652
  <dl>
1602
1653
  <dd>
1603
1654
 
@@ -1609,9 +1660,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
1609
1660
  <dl>
1610
1661
  <dd>
1611
1662
 
1612
- Updates the name of a **Prompt**.
1663
+ Updates a **Config** by creating a new version of the **Config**.
1613
1664
 
1614
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1665
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1615
1666
 
1616
1667
  </dd>
1617
1668
  </dl>
@@ -1627,8 +1678,39 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1627
1678
  <dd>
1628
1679
 
1629
1680
  ```typescript
1630
- await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
1631
- name: "Updated Weather Assistant Prompt Name",
1681
+ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1682
+ versionDescription: "This is an updated version of the Weather Assistant Config.",
1683
+ eviVersion: "3",
1684
+ prompt: {
1685
+ id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
1686
+ version: 0,
1687
+ },
1688
+ voice: {
1689
+ provider: "HUME_AI",
1690
+ name: "Ava Song",
1691
+ },
1692
+ languageModel: {
1693
+ modelProvider: "ANTHROPIC",
1694
+ modelResource: "claude-3-7-sonnet-latest",
1695
+ temperature: 1,
1696
+ },
1697
+ ellmModel: {
1698
+ allowShortResponses: true,
1699
+ },
1700
+ eventMessages: {
1701
+ onNewChat: {
1702
+ enabled: false,
1703
+ text: "",
1704
+ },
1705
+ onInactivityTimeout: {
1706
+ enabled: false,
1707
+ text: "",
1708
+ },
1709
+ onMaxDurationTimeout: {
1710
+ enabled: false,
1711
+ text: "",
1712
+ },
1713
+ },
1632
1714
  });
1633
1715
  ```
1634
1716
 
@@ -1645,7 +1727,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1645
1727
  <dl>
1646
1728
  <dd>
1647
1729
 
1648
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1730
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1649
1731
 
1650
1732
  </dd>
1651
1733
  </dl>
@@ -1653,7 +1735,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1653
1735
  <dl>
1654
1736
  <dd>
1655
1737
 
1656
- **request:** `Hume.empathicVoice.PostedPromptName`
1738
+ **request:** `Hume.empathicVoice.PostedConfigVersion`
1657
1739
 
1658
1740
  </dd>
1659
1741
  </dl>
@@ -1661,7 +1743,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1661
1743
  <dl>
1662
1744
  <dd>
1663
1745
 
1664
- **requestOptions:** `Prompts.RequestOptions`
1746
+ **requestOptions:** `Configs.RequestOptions`
1665
1747
 
1666
1748
  </dd>
1667
1749
  </dl>
@@ -1672,7 +1754,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1672
1754
  </dl>
1673
1755
  </details>
1674
1756
 
1675
- <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>
1757
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
1676
1758
  <dl>
1677
1759
  <dd>
1678
1760
 
@@ -1684,9 +1766,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
1684
1766
  <dl>
1685
1767
  <dd>
1686
1768
 
1687
- Fetches a specified version of a **Prompt**.
1769
+ Deletes a **Config** and its versions.
1688
1770
 
1689
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1771
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1690
1772
 
1691
1773
  </dd>
1692
1774
  </dl>
@@ -1702,7 +1784,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1702
1784
  <dd>
1703
1785
 
1704
1786
  ```typescript
1705
- await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
1787
+ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
1706
1788
  ```
1707
1789
 
1708
1790
  </dd>
@@ -1718,21 +1800,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
1718
1800
  <dl>
1719
1801
  <dd>
1720
1802
 
1721
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1722
-
1723
- </dd>
1724
- </dl>
1725
-
1726
- <dl>
1727
- <dd>
1728
-
1729
- **version:** `number`
1730
-
1731
- Version number for a Prompt.
1732
-
1733
- 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.
1734
-
1735
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1803
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1736
1804
 
1737
1805
  </dd>
1738
1806
  </dl>
@@ -1740,7 +1808,7 @@ Version numbers are integer values representing different iterations of the Prom
1740
1808
  <dl>
1741
1809
  <dd>
1742
1810
 
1743
- **requestOptions:** `Prompts.RequestOptions`
1811
+ **requestOptions:** `Configs.RequestOptions`
1744
1812
 
1745
1813
  </dd>
1746
1814
  </dl>
@@ -1751,7 +1819,7 @@ Version numbers are integer values representing different iterations of the Prom
1751
1819
  </dl>
1752
1820
  </details>
1753
1821
 
1754
- <details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
1822
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
1755
1823
  <dl>
1756
1824
  <dd>
1757
1825
 
@@ -1763,9 +1831,9 @@ Version numbers are integer values representing different iterations of the Prom
1763
1831
  <dl>
1764
1832
  <dd>
1765
1833
 
1766
- Deletes a specified version of a **Prompt**.
1834
+ Updates the name of a **Config**.
1767
1835
 
1768
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1836
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1769
1837
 
1770
1838
  </dd>
1771
1839
  </dl>
@@ -1781,7 +1849,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1781
1849
  <dd>
1782
1850
 
1783
1851
  ```typescript
1784
- await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
1852
+ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
1853
+ name: "Updated Weather Assistant Config Name",
1854
+ });
1785
1855
  ```
1786
1856
 
1787
1857
  </dd>
@@ -1797,7 +1867,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1797
1867
  <dl>
1798
1868
  <dd>
1799
1869
 
1800
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1870
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1801
1871
 
1802
1872
  </dd>
1803
1873
  </dl>
@@ -1805,13 +1875,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
1805
1875
  <dl>
1806
1876
  <dd>
1807
1877
 
1808
- **version:** `number`
1809
-
1810
- Version number for a Prompt.
1811
-
1812
- 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.
1813
-
1814
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1878
+ **request:** `Hume.empathicVoice.PostedConfigName`
1815
1879
 
1816
1880
  </dd>
1817
1881
  </dl>
@@ -1819,7 +1883,7 @@ Version numbers are integer values representing different iterations of the Prom
1819
1883
  <dl>
1820
1884
  <dd>
1821
1885
 
1822
- **requestOptions:** `Prompts.RequestOptions`
1886
+ **requestOptions:** `Configs.RequestOptions`
1823
1887
 
1824
1888
  </dd>
1825
1889
  </dl>
@@ -1830,7 +1894,7 @@ Version numbers are integer values representing different iterations of the Prom
1830
1894
  </dl>
1831
1895
  </details>
1832
1896
 
1833
- <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>
1897
+ <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>
1834
1898
  <dl>
1835
1899
  <dd>
1836
1900
 
@@ -1842,9 +1906,9 @@ Version numbers are integer values representing different iterations of the Prom
1842
1906
  <dl>
1843
1907
  <dd>
1844
1908
 
1845
- Updates the description of a **Prompt**.
1909
+ Fetches a specified version of a **Config**.
1846
1910
 
1847
- See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
1911
+ For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1848
1912
 
1849
1913
  </dd>
1850
1914
  </dl>
@@ -1860,9 +1924,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
1860
1924
  <dd>
1861
1925
 
1862
1926
  ```typescript
1863
- await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
1864
- versionDescription: "This is an updated version_description.",
1865
- });
1927
+ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1866
1928
  ```
1867
1929
 
1868
1930
  </dd>
@@ -1878,7 +1940,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1878
1940
  <dl>
1879
1941
  <dd>
1880
1942
 
1881
- **id:** `string` — Identifier for a Prompt. Formatted as a UUID.
1943
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
1882
1944
 
1883
1945
  </dd>
1884
1946
  </dl>
@@ -1888,19 +1950,11 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
1888
1950
 
1889
1951
  **version:** `number`
1890
1952
 
1891
- Version number for a Prompt.
1892
-
1893
- 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.
1894
-
1895
- Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
1896
-
1897
- </dd>
1898
- </dl>
1953
+ Version number for a Config.
1899
1954
 
1900
- <dl>
1901
- <dd>
1955
+ 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.
1902
1956
 
1903
- **request:** `Hume.empathicVoice.PostedPromptVersionDescription`
1957
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1904
1958
 
1905
1959
  </dd>
1906
1960
  </dl>
@@ -1908,7 +1962,7 @@ Version numbers are integer values representing different iterations of the Prom
1908
1962
  <dl>
1909
1963
  <dd>
1910
1964
 
1911
- **requestOptions:** `Prompts.RequestOptions`
1965
+ **requestOptions:** `Configs.RequestOptions`
1912
1966
 
1913
1967
  </dd>
1914
1968
  </dl>
@@ -1919,9 +1973,7 @@ Version numbers are integer values representing different iterations of the Prom
1919
1973
  </dl>
1920
1974
  </details>
1921
1975
 
1922
- ## EmpathicVoice Configs
1923
-
1924
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig></code></summary>
1976
+ <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
1925
1977
  <dl>
1926
1978
  <dd>
1927
1979
 
@@ -1933,7 +1985,7 @@ Version numbers are integer values representing different iterations of the Prom
1933
1985
  <dl>
1934
1986
  <dd>
1935
1987
 
1936
- Fetches a paginated list of **Configs**.
1988
+ Deletes a specified version of a **Config**.
1937
1989
 
1938
1990
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
1939
1991
 
@@ -1951,22 +2003,7 @@ For more details on configuration options and how to configure EVI, see our [con
1951
2003
  <dd>
1952
2004
 
1953
2005
  ```typescript
1954
- const response = await client.empathicVoice.configs.listConfigs({
1955
- pageNumber: 0,
1956
- pageSize: 1,
1957
- });
1958
- for await (const item of response) {
1959
- console.log(item);
1960
- }
1961
-
1962
- // Or you can manually iterate page-by-page
1963
- const page = await client.empathicVoice.configs.listConfigs({
1964
- pageNumber: 0,
1965
- pageSize: 1,
1966
- });
1967
- while (page.hasNextPage()) {
1968
- page = page.getNextPage();
1969
- }
2006
+ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
1970
2007
  ```
1971
2008
 
1972
2009
  </dd>
@@ -1982,7 +2019,21 @@ while (page.hasNextPage()) {
1982
2019
  <dl>
1983
2020
  <dd>
1984
2021
 
1985
- **request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
2022
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2023
+
2024
+ </dd>
2025
+ </dl>
2026
+
2027
+ <dl>
2028
+ <dd>
2029
+
2030
+ **version:** `number`
2031
+
2032
+ Version number for a Config.
2033
+
2034
+ 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.
2035
+
2036
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
1986
2037
 
1987
2038
  </dd>
1988
2039
  </dl>
@@ -2001,7 +2052,7 @@ while (page.hasNextPage()) {
2001
2052
  </dl>
2002
2053
  </details>
2003
2054
 
2004
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
2055
+ <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>
2005
2056
  <dl>
2006
2057
  <dd>
2007
2058
 
@@ -2013,7 +2064,7 @@ while (page.hasNextPage()) {
2013
2064
  <dl>
2014
2065
  <dd>
2015
2066
 
2016
- Creates a **Config** which can be applied to EVI.
2067
+ Updates the description of a **Config**.
2017
2068
 
2018
2069
  For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2019
2070
 
@@ -2031,36 +2082,8 @@ For more details on configuration options and how to configure EVI, see our [con
2031
2082
  <dd>
2032
2083
 
2033
2084
  ```typescript
2034
- await client.empathicVoice.configs.createConfig({
2035
- name: "Weather Assistant Config",
2036
- prompt: {
2037
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2038
- version: 0,
2039
- },
2040
- eviVersion: "3",
2041
- voice: {
2042
- provider: "HUME_AI",
2043
- name: "Ava Song",
2044
- },
2045
- languageModel: {
2046
- modelProvider: "ANTHROPIC",
2047
- modelResource: "claude-3-7-sonnet-latest",
2048
- temperature: 1,
2049
- },
2050
- eventMessages: {
2051
- onNewChat: {
2052
- enabled: false,
2053
- text: "",
2054
- },
2055
- onInactivityTimeout: {
2056
- enabled: false,
2057
- text: "",
2058
- },
2059
- onMaxDurationTimeout: {
2060
- enabled: false,
2061
- text: "",
2062
- },
2063
- },
2085
+ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2086
+ versionDescription: "This is an updated version_description.",
2064
2087
  });
2065
2088
  ```
2066
2089
 
@@ -2077,7 +2100,29 @@ await client.empathicVoice.configs.createConfig({
2077
2100
  <dl>
2078
2101
  <dd>
2079
2102
 
2080
- **request:** `Hume.empathicVoice.PostedConfig`
2103
+ **id:** `string` — Identifier for a Config. Formatted as a UUID.
2104
+
2105
+ </dd>
2106
+ </dl>
2107
+
2108
+ <dl>
2109
+ <dd>
2110
+
2111
+ **version:** `number`
2112
+
2113
+ Version number for a Config.
2114
+
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.
2116
+
2117
+ Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2118
+
2119
+ </dd>
2120
+ </dl>
2121
+
2122
+ <dl>
2123
+ <dd>
2124
+
2125
+ **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2081
2126
 
2082
2127
  </dd>
2083
2128
  </dl>
@@ -2096,7 +2141,9 @@ await client.empathicVoice.configs.createConfig({
2096
2141
  </dl>
2097
2142
  </details>
2098
2143
 
2099
- <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></code></summary>
2144
+ ## EmpathicVoice Chats
2145
+
2146
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
2100
2147
  <dl>
2101
2148
  <dd>
2102
2149
 
@@ -2108,9 +2155,7 @@ await client.empathicVoice.configs.createConfig({
2108
2155
  <dl>
2109
2156
  <dd>
2110
2157
 
2111
- Fetches a list of a **Config's** versions.
2112
-
2113
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2158
+ Fetches a paginated list of **Chats**.
2114
2159
 
2115
2160
  </dd>
2116
2161
  </dl>
@@ -2126,13 +2171,21 @@ For more details on configuration options and how to configure EVI, see our [con
2126
2171
  <dd>
2127
2172
 
2128
2173
  ```typescript
2129
- const response = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2174
+ const response = await client.empathicVoice.chats.listChats({
2175
+ pageNumber: 0,
2176
+ pageSize: 1,
2177
+ ascendingOrder: true,
2178
+ });
2130
2179
  for await (const item of response) {
2131
2180
  console.log(item);
2132
2181
  }
2133
2182
 
2134
2183
  // Or you can manually iterate page-by-page
2135
- const page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2184
+ const page = await client.empathicVoice.chats.listChats({
2185
+ pageNumber: 0,
2186
+ pageSize: 1,
2187
+ ascendingOrder: true,
2188
+ });
2136
2189
  while (page.hasNextPage()) {
2137
2190
  page = page.getNextPage();
2138
2191
  }
@@ -2151,15 +2204,7 @@ while (page.hasNextPage()) {
2151
2204
  <dl>
2152
2205
  <dd>
2153
2206
 
2154
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2155
-
2156
- </dd>
2157
- </dl>
2158
-
2159
- <dl>
2160
- <dd>
2161
-
2162
- **request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
2207
+ **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2163
2208
 
2164
2209
  </dd>
2165
2210
  </dl>
@@ -2167,7 +2212,7 @@ while (page.hasNextPage()) {
2167
2212
  <dl>
2168
2213
  <dd>
2169
2214
 
2170
- **requestOptions:** `Configs.RequestOptions`
2215
+ **requestOptions:** `Chats.RequestOptions`
2171
2216
 
2172
2217
  </dd>
2173
2218
  </dl>
@@ -2178,7 +2223,7 @@ while (page.hasNextPage()) {
2178
2223
  </dl>
2179
2224
  </details>
2180
2225
 
2181
- <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>
2226
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
2182
2227
  <dl>
2183
2228
  <dd>
2184
2229
 
@@ -2190,9 +2235,7 @@ while (page.hasNextPage()) {
2190
2235
  <dl>
2191
2236
  <dd>
2192
2237
 
2193
- Updates a **Config** by creating a new version of the **Config**.
2194
-
2195
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2238
+ Fetches a paginated list of **Chat** events.
2196
2239
 
2197
2240
  </dd>
2198
2241
  </dl>
@@ -2208,40 +2251,24 @@ For more details on configuration options and how to configure EVI, see our [con
2208
2251
  <dd>
2209
2252
 
2210
2253
  ```typescript
2211
- await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2212
- versionDescription: "This is an updated version of the Weather Assistant Config.",
2213
- eviVersion: "3",
2214
- prompt: {
2215
- id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
2216
- version: 0,
2217
- },
2218
- voice: {
2219
- provider: "HUME_AI",
2220
- name: "Ava Song",
2221
- },
2222
- languageModel: {
2223
- modelProvider: "ANTHROPIC",
2224
- modelResource: "claude-3-7-sonnet-latest",
2225
- temperature: 1,
2226
- },
2227
- ellmModel: {
2228
- allowShortResponses: true,
2229
- },
2230
- eventMessages: {
2231
- onNewChat: {
2232
- enabled: false,
2233
- text: "",
2234
- },
2235
- onInactivityTimeout: {
2236
- enabled: false,
2237
- text: "",
2238
- },
2239
- onMaxDurationTimeout: {
2240
- enabled: false,
2241
- text: "",
2242
- },
2243
- },
2254
+ const response = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2255
+ pageNumber: 0,
2256
+ pageSize: 3,
2257
+ ascendingOrder: true,
2244
2258
  });
2259
+ for await (const item of response) {
2260
+ console.log(item);
2261
+ }
2262
+
2263
+ // Or you can manually iterate page-by-page
2264
+ const page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2265
+ pageNumber: 0,
2266
+ pageSize: 3,
2267
+ ascendingOrder: true,
2268
+ });
2269
+ while (page.hasNextPage()) {
2270
+ page = page.getNextPage();
2271
+ }
2245
2272
  ```
2246
2273
 
2247
2274
  </dd>
@@ -2257,7 +2284,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2257
2284
  <dl>
2258
2285
  <dd>
2259
2286
 
2260
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2287
+ **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2261
2288
 
2262
2289
  </dd>
2263
2290
  </dl>
@@ -2265,7 +2292,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2265
2292
  <dl>
2266
2293
  <dd>
2267
2294
 
2268
- **request:** `Hume.empathicVoice.PostedConfigVersion`
2295
+ **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2269
2296
 
2270
2297
  </dd>
2271
2298
  </dl>
@@ -2273,7 +2300,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2273
2300
  <dl>
2274
2301
  <dd>
2275
2302
 
2276
- **requestOptions:** `Configs.RequestOptions`
2303
+ **requestOptions:** `Chats.RequestOptions`
2277
2304
 
2278
2305
  </dd>
2279
2306
  </dl>
@@ -2284,7 +2311,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2284
2311
  </dl>
2285
2312
  </details>
2286
2313
 
2287
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
2314
+ <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2288
2315
  <dl>
2289
2316
  <dd>
2290
2317
 
@@ -2296,9 +2323,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
2296
2323
  <dl>
2297
2324
  <dd>
2298
2325
 
2299
- Deletes a **Config** and its versions.
2300
-
2301
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2326
+ 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).
2302
2327
 
2303
2328
  </dd>
2304
2329
  </dl>
@@ -2314,7 +2339,7 @@ For more details on configuration options and how to configure EVI, see our [con
2314
2339
  <dd>
2315
2340
 
2316
2341
  ```typescript
2317
- await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
2342
+ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
2318
2343
  ```
2319
2344
 
2320
2345
  </dd>
@@ -2330,7 +2355,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2330
2355
  <dl>
2331
2356
  <dd>
2332
2357
 
2333
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2358
+ **id:** `string` — Identifier for a chat. Formatted as a UUID.
2334
2359
 
2335
2360
  </dd>
2336
2361
  </dl>
@@ -2338,7 +2363,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2338
2363
  <dl>
2339
2364
  <dd>
2340
2365
 
2341
- **requestOptions:** `Configs.RequestOptions`
2366
+ **requestOptions:** `Chats.RequestOptions`
2342
2367
 
2343
2368
  </dd>
2344
2369
  </dl>
@@ -2349,7 +2374,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2349
2374
  </dl>
2350
2375
  </details>
2351
2376
 
2352
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
2377
+ ## EmpathicVoice ChatGroups
2378
+
2379
+ <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup></code></summary>
2353
2380
  <dl>
2354
2381
  <dd>
2355
2382
 
@@ -2361,9 +2388,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
2361
2388
  <dl>
2362
2389
  <dd>
2363
2390
 
2364
- Updates the name of a **Config**.
2365
-
2366
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2391
+ Fetches a paginated list of **Chat Groups**.
2367
2392
 
2368
2393
  </dd>
2369
2394
  </dl>
@@ -2379,11 +2404,28 @@ For more details on configuration options and how to configure EVI, see our [con
2379
2404
  <dd>
2380
2405
 
2381
2406
  ```typescript
2382
- await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
2383
- name: "Updated Weather Assistant Config Name",
2407
+ const response = await client.empathicVoice.chatGroups.listChatGroups({
2408
+ pageNumber: 0,
2409
+ pageSize: 1,
2410
+ ascendingOrder: true,
2411
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2384
2412
  });
2385
- ```
2386
-
2413
+ for await (const item of response) {
2414
+ console.log(item);
2415
+ }
2416
+
2417
+ // Or you can manually iterate page-by-page
2418
+ const page = await client.empathicVoice.chatGroups.listChatGroups({
2419
+ pageNumber: 0,
2420
+ pageSize: 1,
2421
+ ascendingOrder: true,
2422
+ configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2423
+ });
2424
+ while (page.hasNextPage()) {
2425
+ page = page.getNextPage();
2426
+ }
2427
+ ```
2428
+
2387
2429
  </dd>
2388
2430
  </dl>
2389
2431
  </dd>
@@ -2397,15 +2439,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2397
2439
  <dl>
2398
2440
  <dd>
2399
2441
 
2400
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2401
-
2402
- </dd>
2403
- </dl>
2404
-
2405
- <dl>
2406
- <dd>
2407
-
2408
- **request:** `Hume.empathicVoice.PostedConfigName`
2442
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
2409
2443
 
2410
2444
  </dd>
2411
2445
  </dl>
@@ -2413,7 +2447,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2413
2447
  <dl>
2414
2448
  <dd>
2415
2449
 
2416
- **requestOptions:** `Configs.RequestOptions`
2450
+ **requestOptions:** `ChatGroups.RequestOptions`
2417
2451
 
2418
2452
  </dd>
2419
2453
  </dl>
@@ -2424,7 +2458,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2424
2458
  </dl>
2425
2459
  </details>
2426
2460
 
2427
- <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>
2461
+ <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>
2428
2462
  <dl>
2429
2463
  <dd>
2430
2464
 
@@ -2436,9 +2470,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
2436
2470
  <dl>
2437
2471
  <dd>
2438
2472
 
2439
- Fetches a specified version of a **Config**.
2440
-
2441
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2473
+ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
2442
2474
 
2443
2475
  </dd>
2444
2476
  </dl>
@@ -2454,7 +2486,11 @@ For more details on configuration options and how to configure EVI, see our [con
2454
2486
  <dd>
2455
2487
 
2456
2488
  ```typescript
2457
- await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2489
+ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2490
+ pageNumber: 0,
2491
+ pageSize: 1,
2492
+ ascendingOrder: true,
2493
+ });
2458
2494
  ```
2459
2495
 
2460
2496
  </dd>
@@ -2470,7 +2506,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2470
2506
  <dl>
2471
2507
  <dd>
2472
2508
 
2473
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2509
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2474
2510
 
2475
2511
  </dd>
2476
2512
  </dl>
@@ -2478,13 +2514,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
2478
2514
  <dl>
2479
2515
  <dd>
2480
2516
 
2481
- **version:** `number`
2482
-
2483
- Version number for a Config.
2484
-
2485
- 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.
2486
-
2487
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2517
+ **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
2488
2518
 
2489
2519
  </dd>
2490
2520
  </dl>
@@ -2492,7 +2522,7 @@ Version numbers are integer values representing different iterations of the Conf
2492
2522
  <dl>
2493
2523
  <dd>
2494
2524
 
2495
- **requestOptions:** `Configs.RequestOptions`
2525
+ **requestOptions:** `ChatGroups.RequestOptions`
2496
2526
 
2497
2527
  </dd>
2498
2528
  </dl>
@@ -2503,7 +2533,7 @@ Version numbers are integer values representing different iterations of the Conf
2503
2533
  </dl>
2504
2534
  </details>
2505
2535
 
2506
- <details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
2536
+ <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></code></summary>
2507
2537
  <dl>
2508
2538
  <dd>
2509
2539
 
@@ -2515,9 +2545,7 @@ Version numbers are integer values representing different iterations of the Conf
2515
2545
  <dl>
2516
2546
  <dd>
2517
2547
 
2518
- Deletes a specified version of a **Config**.
2519
-
2520
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2548
+ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
2521
2549
 
2522
2550
  </dd>
2523
2551
  </dl>
@@ -2533,7 +2561,24 @@ For more details on configuration options and how to configure EVI, see our [con
2533
2561
  <dd>
2534
2562
 
2535
2563
  ```typescript
2536
- await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
2564
+ const response = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2565
+ pageNumber: 0,
2566
+ pageSize: 3,
2567
+ ascendingOrder: true,
2568
+ });
2569
+ for await (const item of response) {
2570
+ console.log(item);
2571
+ }
2572
+
2573
+ // Or you can manually iterate page-by-page
2574
+ const page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
2575
+ pageNumber: 0,
2576
+ pageSize: 3,
2577
+ ascendingOrder: true,
2578
+ });
2579
+ while (page.hasNextPage()) {
2580
+ page = page.getNextPage();
2581
+ }
2537
2582
  ```
2538
2583
 
2539
2584
  </dd>
@@ -2549,7 +2594,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2549
2594
  <dl>
2550
2595
  <dd>
2551
2596
 
2552
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2597
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2553
2598
 
2554
2599
  </dd>
2555
2600
  </dl>
@@ -2557,13 +2602,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
2557
2602
  <dl>
2558
2603
  <dd>
2559
2604
 
2560
- **version:** `number`
2561
-
2562
- Version number for a Config.
2563
-
2564
- 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.
2565
-
2566
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2605
+ **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
2567
2606
 
2568
2607
  </dd>
2569
2608
  </dl>
@@ -2571,7 +2610,7 @@ Version numbers are integer values representing different iterations of the Conf
2571
2610
  <dl>
2572
2611
  <dd>
2573
2612
 
2574
- **requestOptions:** `Configs.RequestOptions`
2613
+ **requestOptions:** `ChatGroups.RequestOptions`
2575
2614
 
2576
2615
  </dd>
2577
2616
  </dl>
@@ -2582,7 +2621,7 @@ Version numbers are integer values representing different iterations of the Conf
2582
2621
  </dl>
2583
2622
  </details>
2584
2623
 
2585
- <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>
2624
+ <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>
2586
2625
  <dl>
2587
2626
  <dd>
2588
2627
 
@@ -2594,9 +2633,7 @@ Version numbers are integer values representing different iterations of the Conf
2594
2633
  <dl>
2595
2634
  <dd>
2596
2635
 
2597
- Updates the description of a **Config**.
2598
-
2599
- For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
2636
+ 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).
2600
2637
 
2601
2638
  </dd>
2602
2639
  </dl>
@@ -2612,8 +2649,10 @@ For more details on configuration options and how to configure EVI, see our [con
2612
2649
  <dd>
2613
2650
 
2614
2651
  ```typescript
2615
- await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
2616
- versionDescription: "This is an updated version_description.",
2652
+ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
2653
+ pageNumber: 0,
2654
+ pageSize: 10,
2655
+ ascendingOrder: true,
2617
2656
  });
2618
2657
  ```
2619
2658
 
@@ -2630,21 +2669,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
2630
2669
  <dl>
2631
2670
  <dd>
2632
2671
 
2633
- **id:** `string` — Identifier for a Config. Formatted as a UUID.
2634
-
2635
- </dd>
2636
- </dl>
2637
-
2638
- <dl>
2639
- <dd>
2640
-
2641
- **version:** `number`
2642
-
2643
- Version number for a Config.
2644
-
2645
- 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.
2646
-
2647
- Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
2672
+ **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
2648
2673
 
2649
2674
  </dd>
2650
2675
  </dl>
@@ -2652,7 +2677,7 @@ Version numbers are integer values representing different iterations of the Conf
2652
2677
  <dl>
2653
2678
  <dd>
2654
2679
 
2655
- **request:** `Hume.empathicVoice.PostedConfigVersionDescription`
2680
+ **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
2656
2681
 
2657
2682
  </dd>
2658
2683
  </dl>
@@ -2660,7 +2685,7 @@ Version numbers are integer values representing different iterations of the Conf
2660
2685
  <dl>
2661
2686
  <dd>
2662
2687
 
2663
- **requestOptions:** `Configs.RequestOptions`
2688
+ **requestOptions:** `ChatGroups.RequestOptions`
2664
2689
 
2665
2690
  </dd>
2666
2691
  </dl>
@@ -2671,9 +2696,9 @@ Version numbers are integer values representing different iterations of the Conf
2671
2696
  </dl>
2672
2697
  </details>
2673
2698
 
2674
- ## EmpathicVoice Chats
2699
+ ## Tts
2675
2700
 
2676
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
2701
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
2677
2702
  <dl>
2678
2703
  <dd>
2679
2704
 
@@ -2685,7 +2710,9 @@ Version numbers are integer values representing different iterations of the Conf
2685
2710
  <dl>
2686
2711
  <dd>
2687
2712
 
2688
- Fetches a paginated list of **Chats**.
2713
+ 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.
2714
+
2715
+ The response includes the base64-encoded audio and metadata in JSON format.
2689
2716
 
2690
2717
  </dd>
2691
2718
  </dl>
@@ -2701,24 +2728,28 @@ Fetches a paginated list of **Chats**.
2701
2728
  <dd>
2702
2729
 
2703
2730
  ```typescript
2704
- const response = await client.empathicVoice.chats.listChats({
2705
- pageNumber: 0,
2706
- pageSize: 1,
2707
- ascendingOrder: true,
2708
- });
2709
- for await (const item of response) {
2710
- console.log(item);
2711
- }
2712
-
2713
- // Or you can manually iterate page-by-page
2714
- const page = await client.empathicVoice.chats.listChats({
2715
- pageNumber: 0,
2716
- pageSize: 1,
2717
- ascendingOrder: true,
2731
+ await client.tts.synthesizeJson({
2732
+ context: {
2733
+ utterances: [
2734
+ {
2735
+ text: "How can people see beauty so differently?",
2736
+ description:
2737
+ "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
2738
+ },
2739
+ ],
2740
+ },
2741
+ format: {
2742
+ type: "mp3",
2743
+ },
2744
+ numGenerations: 1,
2745
+ utterances: [
2746
+ {
2747
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2748
+ description:
2749
+ "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
2750
+ },
2751
+ ],
2718
2752
  });
2719
- while (page.hasNextPage()) {
2720
- page = page.getNextPage();
2721
- }
2722
2753
  ```
2723
2754
 
2724
2755
  </dd>
@@ -2734,7 +2765,7 @@ while (page.hasNextPage()) {
2734
2765
  <dl>
2735
2766
  <dd>
2736
2767
 
2737
- **request:** `Hume.empathicVoice.ChatsListChatsRequest`
2768
+ **request:** `Hume.PostedTts`
2738
2769
 
2739
2770
  </dd>
2740
2771
  </dl>
@@ -2742,7 +2773,7 @@ while (page.hasNextPage()) {
2742
2773
  <dl>
2743
2774
  <dd>
2744
2775
 
2745
- **requestOptions:** `Chats.RequestOptions`
2776
+ **requestOptions:** `Tts.RequestOptions`
2746
2777
 
2747
2778
  </dd>
2748
2779
  </dl>
@@ -2753,7 +2784,7 @@ while (page.hasNextPage()) {
2753
2784
  </dl>
2754
2785
  </details>
2755
2786
 
2756
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
2787
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> stream.Readable</code></summary>
2757
2788
  <dl>
2758
2789
  <dd>
2759
2790
 
@@ -2765,7 +2796,9 @@ while (page.hasNextPage()) {
2765
2796
  <dl>
2766
2797
  <dd>
2767
2798
 
2768
- Fetches a paginated list of **Chat** events.
2799
+ 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.
2800
+
2801
+ The response contains the generated audio file in the requested format.
2769
2802
 
2770
2803
  </dd>
2771
2804
  </dl>
@@ -2781,24 +2814,22 @@ Fetches a paginated list of **Chat** events.
2781
2814
  <dd>
2782
2815
 
2783
2816
  ```typescript
2784
- const response = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2785
- pageNumber: 0,
2786
- pageSize: 3,
2787
- ascendingOrder: true,
2788
- });
2789
- for await (const item of response) {
2790
- console.log(item);
2791
- }
2792
-
2793
- // Or you can manually iterate page-by-page
2794
- const page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
2795
- pageNumber: 0,
2796
- pageSize: 3,
2797
- ascendingOrder: true,
2817
+ await client.tts.synthesizeFile({
2818
+ context: {
2819
+ generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
2820
+ },
2821
+ format: {
2822
+ type: "mp3",
2823
+ },
2824
+ numGenerations: 1,
2825
+ utterances: [
2826
+ {
2827
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2828
+ description:
2829
+ "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
2830
+ },
2831
+ ],
2798
2832
  });
2799
- while (page.hasNextPage()) {
2800
- page = page.getNextPage();
2801
- }
2802
2833
  ```
2803
2834
 
2804
2835
  </dd>
@@ -2814,15 +2845,7 @@ while (page.hasNextPage()) {
2814
2845
  <dl>
2815
2846
  <dd>
2816
2847
 
2817
- **id:** `string` — Identifier for a Chat. Formatted as a UUID.
2818
-
2819
- </dd>
2820
- </dl>
2821
-
2822
- <dl>
2823
- <dd>
2824
-
2825
- **request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
2848
+ **request:** `Hume.PostedTts`
2826
2849
 
2827
2850
  </dd>
2828
2851
  </dl>
@@ -2830,7 +2853,7 @@ while (page.hasNextPage()) {
2830
2853
  <dl>
2831
2854
  <dd>
2832
2855
 
2833
- **requestOptions:** `Chats.RequestOptions`
2856
+ **requestOptions:** `Tts.RequestOptions`
2834
2857
 
2835
2858
  </dd>
2836
2859
  </dl>
@@ -2841,7 +2864,7 @@ while (page.hasNextPage()) {
2841
2864
  </dl>
2842
2865
  </details>
2843
2866
 
2844
- <details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
2867
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.SnippetAudioChunk></code></summary>
2845
2868
  <dl>
2846
2869
  <dd>
2847
2870
 
@@ -2853,7 +2876,9 @@ while (page.hasNextPage()) {
2853
2876
  <dl>
2854
2877
  <dd>
2855
2878
 
2856
- 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).
2879
+ 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.
2880
+
2881
+ The response is a stream of JSON objects including audio encoded in base64.
2857
2882
 
2858
2883
  </dd>
2859
2884
  </dl>
@@ -2869,7 +2894,20 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
2869
2894
  <dd>
2870
2895
 
2871
2896
  ```typescript
2872
- await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
2897
+ const response = await client.tts.synthesizeJsonStreaming({
2898
+ utterances: [
2899
+ {
2900
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2901
+ voice: {
2902
+ name: "Male English Actor",
2903
+ provider: "HUME_AI",
2904
+ },
2905
+ },
2906
+ ],
2907
+ });
2908
+ for await (const item of response) {
2909
+ console.log(item);
2910
+ }
2873
2911
  ```
2874
2912
 
2875
2913
  </dd>
@@ -2885,7 +2923,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2885
2923
  <dl>
2886
2924
  <dd>
2887
2925
 
2888
- **id:** `string` — Identifier for a chat. Formatted as a UUID.
2926
+ **request:** `Hume.PostedTts`
2889
2927
 
2890
2928
  </dd>
2891
2929
  </dl>
@@ -2893,7 +2931,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2893
2931
  <dl>
2894
2932
  <dd>
2895
2933
 
2896
- **requestOptions:** `Chats.RequestOptions`
2934
+ **requestOptions:** `Tts.RequestOptions`
2897
2935
 
2898
2936
  </dd>
2899
2937
  </dl>
@@ -2904,9 +2942,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2904
2942
  </dl>
2905
2943
  </details>
2906
2944
 
2907
- ## EmpathicVoice ChatGroups
2908
-
2909
- <details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup></code></summary>
2945
+ <details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
2910
2946
  <dl>
2911
2947
  <dd>
2912
2948
 
@@ -2918,7 +2954,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
2918
2954
  <dl>
2919
2955
  <dd>
2920
2956
 
2921
- Fetches a paginated list of **Chat Groups**.
2957
+ 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.
2922
2958
 
2923
2959
  </dd>
2924
2960
  </dl>
@@ -2934,26 +2970,17 @@ Fetches a paginated list of **Chat Groups**.
2934
2970
  <dd>
2935
2971
 
2936
2972
  ```typescript
2937
- const response = await client.empathicVoice.chatGroups.listChatGroups({
2938
- pageNumber: 0,
2939
- pageSize: 1,
2940
- ascendingOrder: true,
2941
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2942
- });
2943
- for await (const item of response) {
2944
- console.log(item);
2945
- }
2946
-
2947
- // Or you can manually iterate page-by-page
2948
- const page = await client.empathicVoice.chatGroups.listChatGroups({
2949
- pageNumber: 0,
2950
- pageSize: 1,
2951
- ascendingOrder: true,
2952
- configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
2973
+ await client.tts.synthesizeFileStreaming({
2974
+ utterances: [
2975
+ {
2976
+ text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
2977
+ voice: {
2978
+ name: "Male English Actor",
2979
+ provider: "HUME_AI",
2980
+ },
2981
+ },
2982
+ ],
2953
2983
  });
2954
- while (page.hasNextPage()) {
2955
- page = page.getNextPage();
2956
- }
2957
2984
  ```
2958
2985
 
2959
2986
  </dd>
@@ -2969,7 +2996,7 @@ while (page.hasNextPage()) {
2969
2996
  <dl>
2970
2997
  <dd>
2971
2998
 
2972
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
2999
+ **request:** `Hume.PostedTts`
2973
3000
 
2974
3001
  </dd>
2975
3002
  </dl>
@@ -2977,7 +3004,7 @@ while (page.hasNextPage()) {
2977
3004
  <dl>
2978
3005
  <dd>
2979
3006
 
2980
- **requestOptions:** `ChatGroups.RequestOptions`
3007
+ **requestOptions:** `Tts.RequestOptions`
2981
3008
 
2982
3009
  </dd>
2983
3010
  </dl>
@@ -2988,7 +3015,9 @@ while (page.hasNextPage()) {
2988
3015
  </dl>
2989
3016
  </details>
2990
3017
 
2991
- <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>
3018
+ ## Tts Voices
3019
+
3020
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice></code></summary>
2992
3021
  <dl>
2993
3022
  <dd>
2994
3023
 
@@ -3000,7 +3029,7 @@ while (page.hasNextPage()) {
3000
3029
  <dl>
3001
3030
  <dd>
3002
3031
 
3003
- Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
3032
+ Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
3004
3033
 
3005
3034
  </dd>
3006
3035
  </dl>
@@ -3016,11 +3045,20 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
3016
3045
  <dd>
3017
3046
 
3018
3047
  ```typescript
3019
- await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3020
- pageNumber: 0,
3021
- pageSize: 1,
3022
- ascendingOrder: true,
3048
+ const response = await client.tts.voices.list({
3049
+ provider: "CUSTOM_VOICE",
3023
3050
  });
3051
+ for await (const item of response) {
3052
+ console.log(item);
3053
+ }
3054
+
3055
+ // Or you can manually iterate page-by-page
3056
+ const page = await client.tts.voices.list({
3057
+ provider: "CUSTOM_VOICE",
3058
+ });
3059
+ while (page.hasNextPage()) {
3060
+ page = page.getNextPage();
3061
+ }
3024
3062
  ```
3025
3063
 
3026
3064
  </dd>
@@ -3036,15 +3074,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3036
3074
  <dl>
3037
3075
  <dd>
3038
3076
 
3039
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3040
-
3041
- </dd>
3042
- </dl>
3043
-
3044
- <dl>
3045
- <dd>
3046
-
3047
- **request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
3077
+ **request:** `Hume.tts.VoicesListRequest`
3048
3078
 
3049
3079
  </dd>
3050
3080
  </dl>
@@ -3052,7 +3082,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3052
3082
  <dl>
3053
3083
  <dd>
3054
3084
 
3055
- **requestOptions:** `ChatGroups.RequestOptions`
3085
+ **requestOptions:** `Voices.RequestOptions`
3056
3086
 
3057
3087
  </dd>
3058
3088
  </dl>
@@ -3063,7 +3093,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3063
3093
  </dl>
3064
3094
  </details>
3065
3095
 
3066
- <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></code></summary>
3096
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
3067
3097
  <dl>
3068
3098
  <dd>
3069
3099
 
@@ -3075,7 +3105,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
3075
3105
  <dl>
3076
3106
  <dd>
3077
3107
 
3078
- Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3108
+ Saves a new custom voice to your account using the specified TTS generation ID.
3109
+
3110
+ 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).
3079
3111
 
3080
3112
  </dd>
3081
3113
  </dl>
@@ -3091,24 +3123,10 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
3091
3123
  <dd>
3092
3124
 
3093
3125
  ```typescript
3094
- const response = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3095
- pageNumber: 0,
3096
- pageSize: 3,
3097
- ascendingOrder: true,
3098
- });
3099
- for await (const item of response) {
3100
- console.log(item);
3101
- }
3102
-
3103
- // Or you can manually iterate page-by-page
3104
- const page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
3105
- pageNumber: 0,
3106
- pageSize: 3,
3107
- ascendingOrder: true,
3126
+ await client.tts.voices.create({
3127
+ generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
3128
+ name: "David Hume",
3108
3129
  });
3109
- while (page.hasNextPage()) {
3110
- page = page.getNextPage();
3111
- }
3112
3130
  ```
3113
3131
 
3114
3132
  </dd>
@@ -3124,15 +3142,7 @@ while (page.hasNextPage()) {
3124
3142
  <dl>
3125
3143
  <dd>
3126
3144
 
3127
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3128
-
3129
- </dd>
3130
- </dl>
3131
-
3132
- <dl>
3133
- <dd>
3134
-
3135
- **request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
3145
+ **request:** `Hume.tts.PostedVoice`
3136
3146
 
3137
3147
  </dd>
3138
3148
  </dl>
@@ -3140,7 +3150,7 @@ while (page.hasNextPage()) {
3140
3150
  <dl>
3141
3151
  <dd>
3142
3152
 
3143
- **requestOptions:** `ChatGroups.RequestOptions`
3153
+ **requestOptions:** `Voices.RequestOptions`
3144
3154
 
3145
3155
  </dd>
3146
3156
  </dl>
@@ -3151,7 +3161,7 @@ while (page.hasNextPage()) {
3151
3161
  </dl>
3152
3162
  </details>
3153
3163
 
3154
- <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>
3164
+ <details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
3155
3165
  <dl>
3156
3166
  <dd>
3157
3167
 
@@ -3163,7 +3173,7 @@ while (page.hasNextPage()) {
3163
3173
  <dl>
3164
3174
  <dd>
3165
3175
 
3166
- 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).
3176
+ Deletes a previously generated custom voice.
3167
3177
 
3168
3178
  </dd>
3169
3179
  </dl>
@@ -3179,10 +3189,8 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
3179
3189
  <dd>
3180
3190
 
3181
3191
  ```typescript
3182
- await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
3183
- pageNumber: 0,
3184
- pageSize: 10,
3185
- ascendingOrder: true,
3192
+ await client.tts.voices.delete({
3193
+ name: "David Hume",
3186
3194
  });
3187
3195
  ```
3188
3196
 
@@ -3199,15 +3207,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3199
3207
  <dl>
3200
3208
  <dd>
3201
3209
 
3202
- **id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
3203
-
3204
- </dd>
3205
- </dl>
3206
-
3207
- <dl>
3208
- <dd>
3209
-
3210
- **request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
3210
+ **request:** `Hume.tts.VoicesDeleteRequest`
3211
3211
 
3212
3212
  </dd>
3213
3213
  </dl>
@@ -3215,7 +3215,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
3215
3215
  <dl>
3216
3216
  <dd>
3217
3217
 
3218
- **requestOptions:** `ChatGroups.RequestOptions`
3218
+ **requestOptions:** `Voices.RequestOptions`
3219
3219
 
3220
3220
  </dd>
3221
3221
  </dl>