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