hume 0.9.0 → 0.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/empathic-voice/__package__.yml +1 -1
- package/.prettierignore +1 -0
- package/api/resources/empathicVoice/resources/chat/client/Socket.d.ts +4 -1
- package/api/resources/empathicVoice/resources/chat/client/Socket.js +6 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +3 -3
- package/api/resources/empathicVoice/resources/chats/client/Client.js +2 -2
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/dist/api/resources/empathicVoice/resources/chat/client/Socket.d.ts +4 -1
- package/dist/api/resources/empathicVoice/resources/chat/client/Socket.js +6 -1
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +3 -3
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +2 -2
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.js +1 -1
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/HumeClient.d.ts +7 -3
- package/dist/wrapper/HumeClient.js +2 -2
- package/package.json +1 -1
- package/reference.md +566 -566
- package/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ReturnVoice.js +1 -1
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/HumeClient.d.ts +7 -3
- package/wrapper/HumeClient.js +2 -2
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## ExpressionMeasurement Batch
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,9 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
17
|
+
Sort and filter jobs.
|
|
20
18
|
|
|
21
19
|
</dd>
|
|
22
20
|
</dl>
|
|
@@ -32,10 +30,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
32
30
|
<dd>
|
|
33
31
|
|
|
34
32
|
```typescript
|
|
35
|
-
await client.
|
|
36
|
-
pageNumber: 0,
|
|
37
|
-
pageSize: 2,
|
|
38
|
-
});
|
|
33
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
39
34
|
```
|
|
40
35
|
|
|
41
36
|
</dd>
|
|
@@ -51,7 +46,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
51
46
|
<dl>
|
|
52
47
|
<dd>
|
|
53
48
|
|
|
54
|
-
**request:** `Hume.
|
|
49
|
+
**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
|
|
55
50
|
|
|
56
51
|
</dd>
|
|
57
52
|
</dl>
|
|
@@ -59,7 +54,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
59
54
|
<dl>
|
|
60
55
|
<dd>
|
|
61
56
|
|
|
62
|
-
**requestOptions:** `
|
|
57
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
63
58
|
|
|
64
59
|
</dd>
|
|
65
60
|
</dl>
|
|
@@ -70,7 +65,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
70
65
|
</dl>
|
|
71
66
|
</details>
|
|
72
67
|
|
|
73
|
-
<details><summary><code>client.
|
|
68
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
|
|
74
69
|
<dl>
|
|
75
70
|
<dd>
|
|
76
71
|
|
|
@@ -82,9 +77,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
82
77
|
<dl>
|
|
83
78
|
<dd>
|
|
84
79
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
80
|
+
Start a new measurement inference job.
|
|
88
81
|
|
|
89
82
|
</dd>
|
|
90
83
|
</dl>
|
|
@@ -100,13 +93,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
100
93
|
<dd>
|
|
101
94
|
|
|
102
95
|
```typescript
|
|
103
|
-
await client.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
'{ "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"] }',
|
|
107
|
-
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
108
|
-
description: "This tool is for getting the current weather.",
|
|
109
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
96
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
97
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
98
|
+
notify: true,
|
|
110
99
|
});
|
|
111
100
|
```
|
|
112
101
|
|
|
@@ -123,7 +112,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
123
112
|
<dl>
|
|
124
113
|
<dd>
|
|
125
114
|
|
|
126
|
-
**request:** `Hume.
|
|
115
|
+
**request:** `Hume.InferenceBaseRequest`
|
|
127
116
|
|
|
128
117
|
</dd>
|
|
129
118
|
</dl>
|
|
@@ -131,7 +120,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
131
120
|
<dl>
|
|
132
121
|
<dd>
|
|
133
122
|
|
|
134
|
-
**requestOptions:** `
|
|
123
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
135
124
|
|
|
136
125
|
</dd>
|
|
137
126
|
</dl>
|
|
@@ -142,7 +131,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
142
131
|
</dl>
|
|
143
132
|
</details>
|
|
144
133
|
|
|
145
|
-
<details><summary><code>client.
|
|
134
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
|
|
146
135
|
<dl>
|
|
147
136
|
<dd>
|
|
148
137
|
|
|
@@ -154,9 +143,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
154
143
|
<dl>
|
|
155
144
|
<dd>
|
|
156
145
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
146
|
+
Get the request details and state of a given job.
|
|
160
147
|
|
|
161
148
|
</dd>
|
|
162
149
|
</dl>
|
|
@@ -172,7 +159,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
172
159
|
<dd>
|
|
173
160
|
|
|
174
161
|
```typescript
|
|
175
|
-
await client.
|
|
162
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
176
163
|
```
|
|
177
164
|
|
|
178
165
|
</dd>
|
|
@@ -188,15 +175,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
188
175
|
<dl>
|
|
189
176
|
<dd>
|
|
190
177
|
|
|
191
|
-
**id:** `string` —
|
|
192
|
-
|
|
193
|
-
</dd>
|
|
194
|
-
</dl>
|
|
195
|
-
|
|
196
|
-
<dl>
|
|
197
|
-
<dd>
|
|
198
|
-
|
|
199
|
-
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
178
|
+
**id:** `string` — The unique identifier for the job.
|
|
200
179
|
|
|
201
180
|
</dd>
|
|
202
181
|
</dl>
|
|
@@ -204,7 +183,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
204
183
|
<dl>
|
|
205
184
|
<dd>
|
|
206
185
|
|
|
207
|
-
**requestOptions:** `
|
|
186
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
208
187
|
|
|
209
188
|
</dd>
|
|
210
189
|
</dl>
|
|
@@ -215,7 +194,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
215
194
|
</dl>
|
|
216
195
|
</details>
|
|
217
196
|
|
|
218
|
-
<details><summary><code>client.
|
|
197
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
|
|
219
198
|
<dl>
|
|
220
199
|
<dd>
|
|
221
200
|
|
|
@@ -227,9 +206,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
227
206
|
<dl>
|
|
228
207
|
<dd>
|
|
229
208
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
209
|
+
Get the JSON predictions of a completed inference job.
|
|
233
210
|
|
|
234
211
|
</dd>
|
|
235
212
|
</dl>
|
|
@@ -245,13 +222,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
245
222
|
<dd>
|
|
246
223
|
|
|
247
224
|
```typescript
|
|
248
|
-
await client.
|
|
249
|
-
parameters:
|
|
250
|
-
'{ "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"] }',
|
|
251
|
-
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
252
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
253
|
-
description: "This tool is for getting the current weather.",
|
|
254
|
-
});
|
|
225
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
255
226
|
```
|
|
256
227
|
|
|
257
228
|
</dd>
|
|
@@ -267,15 +238,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
267
238
|
<dl>
|
|
268
239
|
<dd>
|
|
269
240
|
|
|
270
|
-
**id:** `string` —
|
|
271
|
-
|
|
272
|
-
</dd>
|
|
273
|
-
</dl>
|
|
274
|
-
|
|
275
|
-
<dl>
|
|
276
|
-
<dd>
|
|
277
|
-
|
|
278
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
241
|
+
**id:** `string` — The unique identifier for the job.
|
|
279
242
|
|
|
280
243
|
</dd>
|
|
281
244
|
</dl>
|
|
@@ -283,7 +246,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
283
246
|
<dl>
|
|
284
247
|
<dd>
|
|
285
248
|
|
|
286
|
-
**requestOptions:** `
|
|
249
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
287
250
|
|
|
288
251
|
</dd>
|
|
289
252
|
</dl>
|
|
@@ -294,7 +257,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
294
257
|
</dl>
|
|
295
258
|
</details>
|
|
296
259
|
|
|
297
|
-
<details><summary><code>client.
|
|
260
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobArtifacts</a>(id) -> stream.Readable</code></summary>
|
|
298
261
|
<dl>
|
|
299
262
|
<dd>
|
|
300
263
|
|
|
@@ -306,9 +269,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
306
269
|
<dl>
|
|
307
270
|
<dd>
|
|
308
271
|
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
272
|
+
Get the artifacts ZIP of a completed inference job.
|
|
312
273
|
|
|
313
274
|
</dd>
|
|
314
275
|
</dl>
|
|
@@ -324,7 +285,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
324
285
|
<dd>
|
|
325
286
|
|
|
326
287
|
```typescript
|
|
327
|
-
await client.
|
|
288
|
+
await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
328
289
|
```
|
|
329
290
|
|
|
330
291
|
</dd>
|
|
@@ -340,7 +301,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
340
301
|
<dl>
|
|
341
302
|
<dd>
|
|
342
303
|
|
|
343
|
-
**id:** `string` —
|
|
304
|
+
**id:** `string` — The unique identifier for the job.
|
|
344
305
|
|
|
345
306
|
</dd>
|
|
346
307
|
</dl>
|
|
@@ -348,7 +309,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
348
309
|
<dl>
|
|
349
310
|
<dd>
|
|
350
311
|
|
|
351
|
-
**requestOptions:** `
|
|
312
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
352
313
|
|
|
353
314
|
</dd>
|
|
354
315
|
</dl>
|
|
@@ -359,7 +320,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
359
320
|
</dl>
|
|
360
321
|
</details>
|
|
361
322
|
|
|
362
|
-
<details><summary><code>client.
|
|
323
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
|
|
363
324
|
<dl>
|
|
364
325
|
<dd>
|
|
365
326
|
|
|
@@ -371,9 +332,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
371
332
|
<dl>
|
|
372
333
|
<dd>
|
|
373
334
|
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
335
|
+
Start a new batch inference job.
|
|
377
336
|
|
|
378
337
|
</dd>
|
|
379
338
|
</dl>
|
|
@@ -389,9 +348,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
389
348
|
<dd>
|
|
390
349
|
|
|
391
350
|
```typescript
|
|
392
|
-
await client.
|
|
393
|
-
|
|
394
|
-
}
|
|
351
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
352
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
353
|
+
{}
|
|
354
|
+
);
|
|
395
355
|
```
|
|
396
356
|
|
|
397
357
|
</dd>
|
|
@@ -407,7 +367,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
407
367
|
<dl>
|
|
408
368
|
<dd>
|
|
409
369
|
|
|
410
|
-
**
|
|
370
|
+
**file:** `File[] | fs.ReadStream[] | Blob[]`
|
|
411
371
|
|
|
412
372
|
</dd>
|
|
413
373
|
</dl>
|
|
@@ -415,7 +375,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
415
375
|
<dl>
|
|
416
376
|
<dd>
|
|
417
377
|
|
|
418
|
-
**request:** `Hume.
|
|
378
|
+
**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
|
|
419
379
|
|
|
420
380
|
</dd>
|
|
421
381
|
</dl>
|
|
@@ -423,7 +383,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
423
383
|
<dl>
|
|
424
384
|
<dd>
|
|
425
385
|
|
|
426
|
-
**requestOptions:** `
|
|
386
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
427
387
|
|
|
428
388
|
</dd>
|
|
429
389
|
</dl>
|
|
@@ -434,7 +394,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
434
394
|
</dl>
|
|
435
395
|
</details>
|
|
436
396
|
|
|
437
|
-
|
|
397
|
+
## EmpathicVoice Tools
|
|
398
|
+
|
|
399
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
|
|
438
400
|
<dl>
|
|
439
401
|
<dd>
|
|
440
402
|
|
|
@@ -446,7 +408,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
446
408
|
<dl>
|
|
447
409
|
<dd>
|
|
448
410
|
|
|
449
|
-
Fetches a
|
|
411
|
+
Fetches a paginated list of **Tools**.
|
|
450
412
|
|
|
451
413
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
452
414
|
|
|
@@ -464,7 +426,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
464
426
|
<dd>
|
|
465
427
|
|
|
466
428
|
```typescript
|
|
467
|
-
await client.empathicVoice.tools.
|
|
429
|
+
await client.empathicVoice.tools.listTools({
|
|
430
|
+
pageNumber: 0,
|
|
431
|
+
pageSize: 2,
|
|
432
|
+
});
|
|
468
433
|
```
|
|
469
434
|
|
|
470
435
|
</dd>
|
|
@@ -480,21 +445,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
480
445
|
<dl>
|
|
481
446
|
<dd>
|
|
482
447
|
|
|
483
|
-
**
|
|
484
|
-
|
|
485
|
-
</dd>
|
|
486
|
-
</dl>
|
|
487
|
-
|
|
488
|
-
<dl>
|
|
489
|
-
<dd>
|
|
490
|
-
|
|
491
|
-
**version:** `number`
|
|
492
|
-
|
|
493
|
-
Version number for a Tool.
|
|
494
|
-
|
|
495
|
-
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.
|
|
496
|
-
|
|
497
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
448
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
498
449
|
|
|
499
450
|
</dd>
|
|
500
451
|
</dl>
|
|
@@ -513,7 +464,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
513
464
|
</dl>
|
|
514
465
|
</details>
|
|
515
466
|
|
|
516
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
467
|
+
<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>
|
|
517
468
|
<dl>
|
|
518
469
|
<dd>
|
|
519
470
|
|
|
@@ -525,7 +476,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
525
476
|
<dl>
|
|
526
477
|
<dd>
|
|
527
478
|
|
|
528
|
-
|
|
479
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
529
480
|
|
|
530
481
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
531
482
|
|
|
@@ -543,7 +494,14 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
543
494
|
<dd>
|
|
544
495
|
|
|
545
496
|
```typescript
|
|
546
|
-
await client.empathicVoice.tools.
|
|
497
|
+
await client.empathicVoice.tools.createTool({
|
|
498
|
+
name: "get_current_weather",
|
|
499
|
+
parameters:
|
|
500
|
+
'{ "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"] }',
|
|
501
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
502
|
+
description: "This tool is for getting the current weather.",
|
|
503
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
504
|
+
});
|
|
547
505
|
```
|
|
548
506
|
|
|
549
507
|
</dd>
|
|
@@ -559,21 +517,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
559
517
|
<dl>
|
|
560
518
|
<dd>
|
|
561
519
|
|
|
562
|
-
**
|
|
563
|
-
|
|
564
|
-
</dd>
|
|
565
|
-
</dl>
|
|
566
|
-
|
|
567
|
-
<dl>
|
|
568
|
-
<dd>
|
|
569
|
-
|
|
570
|
-
**version:** `number`
|
|
571
|
-
|
|
572
|
-
Version number for a Tool.
|
|
573
|
-
|
|
574
|
-
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.
|
|
575
|
-
|
|
576
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
520
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
577
521
|
|
|
578
522
|
</dd>
|
|
579
523
|
</dl>
|
|
@@ -592,7 +536,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
592
536
|
</dl>
|
|
593
537
|
</details>
|
|
594
538
|
|
|
595
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
539
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools</code></summary>
|
|
596
540
|
<dl>
|
|
597
541
|
<dd>
|
|
598
542
|
|
|
@@ -604,7 +548,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
604
548
|
<dl>
|
|
605
549
|
<dd>
|
|
606
550
|
|
|
607
|
-
|
|
551
|
+
Fetches a list of a **Tool's** versions.
|
|
608
552
|
|
|
609
553
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
610
554
|
|
|
@@ -622,10 +566,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
622
566
|
<dd>
|
|
623
567
|
|
|
624
568
|
```typescript
|
|
625
|
-
await client.empathicVoice.tools.
|
|
626
|
-
versionDescription:
|
|
627
|
-
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
628
|
-
});
|
|
569
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
629
570
|
```
|
|
630
571
|
|
|
631
572
|
</dd>
|
|
@@ -649,21 +590,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
649
590
|
<dl>
|
|
650
591
|
<dd>
|
|
651
592
|
|
|
652
|
-
**
|
|
653
|
-
|
|
654
|
-
Version number for a Tool.
|
|
655
|
-
|
|
656
|
-
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.
|
|
657
|
-
|
|
658
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
659
|
-
|
|
660
|
-
</dd>
|
|
661
|
-
</dl>
|
|
662
|
-
|
|
663
|
-
<dl>
|
|
664
|
-
<dd>
|
|
665
|
-
|
|
666
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
593
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
667
594
|
|
|
668
595
|
</dd>
|
|
669
596
|
</dl>
|
|
@@ -682,9 +609,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
682
609
|
</dl>
|
|
683
610
|
</details>
|
|
684
611
|
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
612
|
+
<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>
|
|
688
613
|
<dl>
|
|
689
614
|
<dd>
|
|
690
615
|
|
|
@@ -696,9 +621,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
696
621
|
<dl>
|
|
697
622
|
<dd>
|
|
698
623
|
|
|
699
|
-
|
|
624
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
700
625
|
|
|
701
|
-
|
|
626
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
702
627
|
|
|
703
628
|
</dd>
|
|
704
629
|
</dl>
|
|
@@ -714,9 +639,12 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
714
639
|
<dd>
|
|
715
640
|
|
|
716
641
|
```typescript
|
|
717
|
-
await client.empathicVoice.
|
|
718
|
-
|
|
719
|
-
|
|
642
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
643
|
+
parameters:
|
|
644
|
+
'{ "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"] }',
|
|
645
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
646
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
647
|
+
description: "This tool is for getting the current weather.",
|
|
720
648
|
});
|
|
721
649
|
```
|
|
722
650
|
|
|
@@ -733,7 +661,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
733
661
|
<dl>
|
|
734
662
|
<dd>
|
|
735
663
|
|
|
736
|
-
**
|
|
664
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
737
665
|
|
|
738
666
|
</dd>
|
|
739
667
|
</dl>
|
|
@@ -741,7 +669,15 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
741
669
|
<dl>
|
|
742
670
|
<dd>
|
|
743
671
|
|
|
744
|
-
**
|
|
672
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
673
|
+
|
|
674
|
+
</dd>
|
|
675
|
+
</dl>
|
|
676
|
+
|
|
677
|
+
<dl>
|
|
678
|
+
<dd>
|
|
679
|
+
|
|
680
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
745
681
|
|
|
746
682
|
</dd>
|
|
747
683
|
</dl>
|
|
@@ -752,7 +688,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
752
688
|
</dl>
|
|
753
689
|
</details>
|
|
754
690
|
|
|
755
|
-
<details><summary><code>client.empathicVoice.
|
|
691
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
756
692
|
<dl>
|
|
757
693
|
<dd>
|
|
758
694
|
|
|
@@ -764,9 +700,9 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
764
700
|
<dl>
|
|
765
701
|
<dd>
|
|
766
702
|
|
|
767
|
-
|
|
703
|
+
Deletes a **Tool** and its versions.
|
|
768
704
|
|
|
769
|
-
|
|
705
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
770
706
|
|
|
771
707
|
</dd>
|
|
772
708
|
</dl>
|
|
@@ -782,10 +718,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
782
718
|
<dd>
|
|
783
719
|
|
|
784
720
|
```typescript
|
|
785
|
-
await client.empathicVoice.
|
|
786
|
-
name: "Weather Assistant Prompt",
|
|
787
|
-
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>",
|
|
788
|
-
});
|
|
721
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
789
722
|
```
|
|
790
723
|
|
|
791
724
|
</dd>
|
|
@@ -801,7 +734,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
801
734
|
<dl>
|
|
802
735
|
<dd>
|
|
803
736
|
|
|
804
|
-
**
|
|
737
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
805
738
|
|
|
806
739
|
</dd>
|
|
807
740
|
</dl>
|
|
@@ -809,7 +742,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
809
742
|
<dl>
|
|
810
743
|
<dd>
|
|
811
744
|
|
|
812
|
-
**requestOptions:** `
|
|
745
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
813
746
|
|
|
814
747
|
</dd>
|
|
815
748
|
</dl>
|
|
@@ -820,7 +753,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
820
753
|
</dl>
|
|
821
754
|
</details>
|
|
822
755
|
|
|
823
|
-
<details><summary><code>client.empathicVoice.
|
|
756
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
824
757
|
<dl>
|
|
825
758
|
<dd>
|
|
826
759
|
|
|
@@ -832,9 +765,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
832
765
|
<dl>
|
|
833
766
|
<dd>
|
|
834
767
|
|
|
835
|
-
|
|
768
|
+
Updates the name of a **Tool**.
|
|
836
769
|
|
|
837
|
-
|
|
770
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
838
771
|
|
|
839
772
|
</dd>
|
|
840
773
|
</dl>
|
|
@@ -850,7 +783,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
850
783
|
<dd>
|
|
851
784
|
|
|
852
785
|
```typescript
|
|
853
|
-
await client.empathicVoice.
|
|
786
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
787
|
+
name: "get_current_temperature",
|
|
788
|
+
});
|
|
854
789
|
```
|
|
855
790
|
|
|
856
791
|
</dd>
|
|
@@ -866,7 +801,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
866
801
|
<dl>
|
|
867
802
|
<dd>
|
|
868
803
|
|
|
869
|
-
**id:** `string` — Identifier for a
|
|
804
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
870
805
|
|
|
871
806
|
</dd>
|
|
872
807
|
</dl>
|
|
@@ -874,7 +809,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
874
809
|
<dl>
|
|
875
810
|
<dd>
|
|
876
811
|
|
|
877
|
-
**request:** `Hume.empathicVoice.
|
|
812
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
878
813
|
|
|
879
814
|
</dd>
|
|
880
815
|
</dl>
|
|
@@ -882,7 +817,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
882
817
|
<dl>
|
|
883
818
|
<dd>
|
|
884
819
|
|
|
885
|
-
**requestOptions:** `
|
|
820
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
886
821
|
|
|
887
822
|
</dd>
|
|
888
823
|
</dl>
|
|
@@ -893,7 +828,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
893
828
|
</dl>
|
|
894
829
|
</details>
|
|
895
830
|
|
|
896
|
-
<details><summary><code>client.empathicVoice.
|
|
831
|
+
<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>
|
|
897
832
|
<dl>
|
|
898
833
|
<dd>
|
|
899
834
|
|
|
@@ -905,9 +840,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
905
840
|
<dl>
|
|
906
841
|
<dd>
|
|
907
842
|
|
|
908
|
-
|
|
843
|
+
Fetches a specified version of a **Tool**.
|
|
909
844
|
|
|
910
|
-
|
|
845
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
911
846
|
|
|
912
847
|
</dd>
|
|
913
848
|
</dl>
|
|
@@ -923,10 +858,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
923
858
|
<dd>
|
|
924
859
|
|
|
925
860
|
```typescript
|
|
926
|
-
await client.empathicVoice.
|
|
927
|
-
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>",
|
|
928
|
-
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
929
|
-
});
|
|
861
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
930
862
|
```
|
|
931
863
|
|
|
932
864
|
</dd>
|
|
@@ -942,7 +874,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
942
874
|
<dl>
|
|
943
875
|
<dd>
|
|
944
876
|
|
|
945
|
-
**id:** `string` — Identifier for a
|
|
877
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
946
878
|
|
|
947
879
|
</dd>
|
|
948
880
|
</dl>
|
|
@@ -950,7 +882,13 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
950
882
|
<dl>
|
|
951
883
|
<dd>
|
|
952
884
|
|
|
953
|
-
**
|
|
885
|
+
**version:** `number`
|
|
886
|
+
|
|
887
|
+
Version number for a Tool.
|
|
888
|
+
|
|
889
|
+
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.
|
|
890
|
+
|
|
891
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
954
892
|
|
|
955
893
|
</dd>
|
|
956
894
|
</dl>
|
|
@@ -958,7 +896,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
958
896
|
<dl>
|
|
959
897
|
<dd>
|
|
960
898
|
|
|
961
|
-
**requestOptions:** `
|
|
899
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
962
900
|
|
|
963
901
|
</dd>
|
|
964
902
|
</dl>
|
|
@@ -969,7 +907,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
969
907
|
</dl>
|
|
970
908
|
</details>
|
|
971
909
|
|
|
972
|
-
<details><summary><code>client.empathicVoice.
|
|
910
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
973
911
|
<dl>
|
|
974
912
|
<dd>
|
|
975
913
|
|
|
@@ -981,9 +919,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
981
919
|
<dl>
|
|
982
920
|
<dd>
|
|
983
921
|
|
|
984
|
-
Deletes a
|
|
922
|
+
Deletes a specified version of a **Tool**.
|
|
985
923
|
|
|
986
|
-
|
|
924
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
987
925
|
|
|
988
926
|
</dd>
|
|
989
927
|
</dl>
|
|
@@ -999,7 +937,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
999
937
|
<dd>
|
|
1000
938
|
|
|
1001
939
|
```typescript
|
|
1002
|
-
await client.empathicVoice.
|
|
940
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1003
941
|
```
|
|
1004
942
|
|
|
1005
943
|
</dd>
|
|
@@ -1015,7 +953,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1015
953
|
<dl>
|
|
1016
954
|
<dd>
|
|
1017
955
|
|
|
1018
|
-
**id:** `string` — Identifier for a
|
|
956
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1019
957
|
|
|
1020
958
|
</dd>
|
|
1021
959
|
</dl>
|
|
@@ -1023,7 +961,21 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1023
961
|
<dl>
|
|
1024
962
|
<dd>
|
|
1025
963
|
|
|
1026
|
-
**
|
|
964
|
+
**version:** `number`
|
|
965
|
+
|
|
966
|
+
Version number for a Tool.
|
|
967
|
+
|
|
968
|
+
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.
|
|
969
|
+
|
|
970
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
971
|
+
|
|
972
|
+
</dd>
|
|
973
|
+
</dl>
|
|
974
|
+
|
|
975
|
+
<dl>
|
|
976
|
+
<dd>
|
|
977
|
+
|
|
978
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1027
979
|
|
|
1028
980
|
</dd>
|
|
1029
981
|
</dl>
|
|
@@ -1034,7 +986,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1034
986
|
</dl>
|
|
1035
987
|
</details>
|
|
1036
988
|
|
|
1037
|
-
<details><summary><code>client.empathicVoice.
|
|
989
|
+
<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>
|
|
1038
990
|
<dl>
|
|
1039
991
|
<dd>
|
|
1040
992
|
|
|
@@ -1046,9 +998,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1046
998
|
<dl>
|
|
1047
999
|
<dd>
|
|
1048
1000
|
|
|
1049
|
-
Updates the
|
|
1001
|
+
Updates the description of a specified **Tool** version.
|
|
1050
1002
|
|
|
1051
|
-
|
|
1003
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1052
1004
|
|
|
1053
1005
|
</dd>
|
|
1054
1006
|
</dl>
|
|
@@ -1064,8 +1016,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1064
1016
|
<dd>
|
|
1065
1017
|
|
|
1066
1018
|
```typescript
|
|
1067
|
-
await client.empathicVoice.
|
|
1068
|
-
|
|
1019
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
1020
|
+
versionDescription:
|
|
1021
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1069
1022
|
});
|
|
1070
1023
|
```
|
|
1071
1024
|
|
|
@@ -1082,7 +1035,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1082
1035
|
<dl>
|
|
1083
1036
|
<dd>
|
|
1084
1037
|
|
|
1085
|
-
**id:** `string` — Identifier for a
|
|
1038
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1086
1039
|
|
|
1087
1040
|
</dd>
|
|
1088
1041
|
</dl>
|
|
@@ -1090,7 +1043,13 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1090
1043
|
<dl>
|
|
1091
1044
|
<dd>
|
|
1092
1045
|
|
|
1093
|
-
**
|
|
1046
|
+
**version:** `number`
|
|
1047
|
+
|
|
1048
|
+
Version number for a Tool.
|
|
1049
|
+
|
|
1050
|
+
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.
|
|
1051
|
+
|
|
1052
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1094
1053
|
|
|
1095
1054
|
</dd>
|
|
1096
1055
|
</dl>
|
|
@@ -1098,7 +1057,15 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1098
1057
|
<dl>
|
|
1099
1058
|
<dd>
|
|
1100
1059
|
|
|
1101
|
-
**
|
|
1060
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
1061
|
+
|
|
1062
|
+
</dd>
|
|
1063
|
+
</dl>
|
|
1064
|
+
|
|
1065
|
+
<dl>
|
|
1066
|
+
<dd>
|
|
1067
|
+
|
|
1068
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1102
1069
|
|
|
1103
1070
|
</dd>
|
|
1104
1071
|
</dl>
|
|
@@ -1109,7 +1076,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1109
1076
|
</dl>
|
|
1110
1077
|
</details>
|
|
1111
1078
|
|
|
1112
|
-
|
|
1079
|
+
## EmpathicVoice Prompts
|
|
1080
|
+
|
|
1081
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
1113
1082
|
<dl>
|
|
1114
1083
|
<dd>
|
|
1115
1084
|
|
|
@@ -1121,7 +1090,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1121
1090
|
<dl>
|
|
1122
1091
|
<dd>
|
|
1123
1092
|
|
|
1124
|
-
Fetches a
|
|
1093
|
+
Fetches a paginated list of **Prompts**.
|
|
1125
1094
|
|
|
1126
1095
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1127
1096
|
|
|
@@ -1139,7 +1108,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1139
1108
|
<dd>
|
|
1140
1109
|
|
|
1141
1110
|
```typescript
|
|
1142
|
-
await client.empathicVoice.prompts.
|
|
1111
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
1112
|
+
pageNumber: 0,
|
|
1113
|
+
pageSize: 2,
|
|
1114
|
+
});
|
|
1143
1115
|
```
|
|
1144
1116
|
|
|
1145
1117
|
</dd>
|
|
@@ -1155,21 +1127,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1155
1127
|
<dl>
|
|
1156
1128
|
<dd>
|
|
1157
1129
|
|
|
1158
|
-
**
|
|
1159
|
-
|
|
1160
|
-
</dd>
|
|
1161
|
-
</dl>
|
|
1162
|
-
|
|
1163
|
-
<dl>
|
|
1164
|
-
<dd>
|
|
1165
|
-
|
|
1166
|
-
**version:** `number`
|
|
1167
|
-
|
|
1168
|
-
Version number for a Prompt.
|
|
1169
|
-
|
|
1170
|
-
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.
|
|
1171
|
-
|
|
1172
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1130
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
1173
1131
|
|
|
1174
1132
|
</dd>
|
|
1175
1133
|
</dl>
|
|
@@ -1188,7 +1146,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1188
1146
|
</dl>
|
|
1189
1147
|
</details>
|
|
1190
1148
|
|
|
1191
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1149
|
+
<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>
|
|
1192
1150
|
<dl>
|
|
1193
1151
|
<dd>
|
|
1194
1152
|
|
|
@@ -1200,7 +1158,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1200
1158
|
<dl>
|
|
1201
1159
|
<dd>
|
|
1202
1160
|
|
|
1203
|
-
|
|
1161
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1204
1162
|
|
|
1205
1163
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1206
1164
|
|
|
@@ -1218,7 +1176,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1218
1176
|
<dd>
|
|
1219
1177
|
|
|
1220
1178
|
```typescript
|
|
1221
|
-
await client.empathicVoice.prompts.
|
|
1179
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1180
|
+
name: "Weather Assistant Prompt",
|
|
1181
|
+
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>",
|
|
1182
|
+
});
|
|
1222
1183
|
```
|
|
1223
1184
|
|
|
1224
1185
|
</dd>
|
|
@@ -1234,21 +1195,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1234
1195
|
<dl>
|
|
1235
1196
|
<dd>
|
|
1236
1197
|
|
|
1237
|
-
**
|
|
1238
|
-
|
|
1239
|
-
</dd>
|
|
1240
|
-
</dl>
|
|
1241
|
-
|
|
1242
|
-
<dl>
|
|
1243
|
-
<dd>
|
|
1244
|
-
|
|
1245
|
-
**version:** `number`
|
|
1246
|
-
|
|
1247
|
-
Version number for a Prompt.
|
|
1248
|
-
|
|
1249
|
-
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.
|
|
1250
|
-
|
|
1251
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1198
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
1252
1199
|
|
|
1253
1200
|
</dd>
|
|
1254
1201
|
</dl>
|
|
@@ -1267,7 +1214,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1267
1214
|
</dl>
|
|
1268
1215
|
</details>
|
|
1269
1216
|
|
|
1270
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1217
|
+
<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>
|
|
1271
1218
|
<dl>
|
|
1272
1219
|
<dd>
|
|
1273
1220
|
|
|
@@ -1279,7 +1226,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1279
1226
|
<dl>
|
|
1280
1227
|
<dd>
|
|
1281
1228
|
|
|
1282
|
-
|
|
1229
|
+
Fetches a list of a **Prompt's** versions.
|
|
1283
1230
|
|
|
1284
1231
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1285
1232
|
|
|
@@ -1297,9 +1244,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1297
1244
|
<dd>
|
|
1298
1245
|
|
|
1299
1246
|
```typescript
|
|
1300
|
-
await client.empathicVoice.prompts.
|
|
1301
|
-
versionDescription: "This is an updated version_description.",
|
|
1302
|
-
});
|
|
1247
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1303
1248
|
```
|
|
1304
1249
|
|
|
1305
1250
|
</dd>
|
|
@@ -1323,21 +1268,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1323
1268
|
<dl>
|
|
1324
1269
|
<dd>
|
|
1325
1270
|
|
|
1326
|
-
**
|
|
1327
|
-
|
|
1328
|
-
Version number for a Prompt.
|
|
1329
|
-
|
|
1330
|
-
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.
|
|
1331
|
-
|
|
1332
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1333
|
-
|
|
1334
|
-
</dd>
|
|
1335
|
-
</dl>
|
|
1336
|
-
|
|
1337
|
-
<dl>
|
|
1338
|
-
<dd>
|
|
1339
|
-
|
|
1340
|
-
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1271
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1341
1272
|
|
|
1342
1273
|
</dd>
|
|
1343
1274
|
</dl>
|
|
@@ -1356,9 +1287,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1356
1287
|
</dl>
|
|
1357
1288
|
</details>
|
|
1358
1289
|
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1290
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVerison</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
1362
1291
|
<dl>
|
|
1363
1292
|
<dd>
|
|
1364
1293
|
|
|
@@ -1370,9 +1299,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1370
1299
|
<dl>
|
|
1371
1300
|
<dd>
|
|
1372
1301
|
|
|
1373
|
-
|
|
1302
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1374
1303
|
|
|
1375
|
-
|
|
1304
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1376
1305
|
|
|
1377
1306
|
</dd>
|
|
1378
1307
|
</dl>
|
|
@@ -1388,7 +1317,10 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1388
1317
|
<dd>
|
|
1389
1318
|
|
|
1390
1319
|
```typescript
|
|
1391
|
-
await client.empathicVoice.
|
|
1320
|
+
await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1321
|
+
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>",
|
|
1322
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1323
|
+
});
|
|
1392
1324
|
```
|
|
1393
1325
|
|
|
1394
1326
|
</dd>
|
|
@@ -1404,7 +1336,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1404
1336
|
<dl>
|
|
1405
1337
|
<dd>
|
|
1406
1338
|
|
|
1407
|
-
**
|
|
1339
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1408
1340
|
|
|
1409
1341
|
</dd>
|
|
1410
1342
|
</dl>
|
|
@@ -1412,7 +1344,15 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1412
1344
|
<dl>
|
|
1413
1345
|
<dd>
|
|
1414
1346
|
|
|
1415
|
-
**
|
|
1347
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1348
|
+
|
|
1349
|
+
</dd>
|
|
1350
|
+
</dl>
|
|
1351
|
+
|
|
1352
|
+
<dl>
|
|
1353
|
+
<dd>
|
|
1354
|
+
|
|
1355
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1416
1356
|
|
|
1417
1357
|
</dd>
|
|
1418
1358
|
</dl>
|
|
@@ -1423,7 +1363,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1423
1363
|
</dl>
|
|
1424
1364
|
</details>
|
|
1425
1365
|
|
|
1426
|
-
<details><summary><code>client.empathicVoice.
|
|
1366
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
1427
1367
|
<dl>
|
|
1428
1368
|
<dd>
|
|
1429
1369
|
|
|
@@ -1435,9 +1375,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1435
1375
|
<dl>
|
|
1436
1376
|
<dd>
|
|
1437
1377
|
|
|
1438
|
-
|
|
1378
|
+
Deletes a **Prompt** and its versions.
|
|
1439
1379
|
|
|
1440
|
-
|
|
1380
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1441
1381
|
|
|
1442
1382
|
</dd>
|
|
1443
1383
|
</dl>
|
|
@@ -1453,11 +1393,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1453
1393
|
<dd>
|
|
1454
1394
|
|
|
1455
1395
|
```typescript
|
|
1456
|
-
await client.empathicVoice.
|
|
1457
|
-
name: "name",
|
|
1458
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1459
|
-
parameterModel: "20240715-4parameter",
|
|
1460
|
-
});
|
|
1396
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1461
1397
|
```
|
|
1462
1398
|
|
|
1463
1399
|
</dd>
|
|
@@ -1473,7 +1409,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1473
1409
|
<dl>
|
|
1474
1410
|
<dd>
|
|
1475
1411
|
|
|
1476
|
-
**
|
|
1412
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1477
1413
|
|
|
1478
1414
|
</dd>
|
|
1479
1415
|
</dl>
|
|
@@ -1481,7 +1417,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1481
1417
|
<dl>
|
|
1482
1418
|
<dd>
|
|
1483
1419
|
|
|
1484
|
-
**requestOptions:** `
|
|
1420
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1485
1421
|
|
|
1486
1422
|
</dd>
|
|
1487
1423
|
</dl>
|
|
@@ -1492,7 +1428,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1492
1428
|
</dl>
|
|
1493
1429
|
</details>
|
|
1494
1430
|
|
|
1495
|
-
<details><summary><code>client.empathicVoice.
|
|
1431
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1496
1432
|
<dl>
|
|
1497
1433
|
<dd>
|
|
1498
1434
|
|
|
@@ -1504,9 +1440,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1504
1440
|
<dl>
|
|
1505
1441
|
<dd>
|
|
1506
1442
|
|
|
1507
|
-
|
|
1443
|
+
Updates the name of a **Prompt**.
|
|
1508
1444
|
|
|
1509
|
-
|
|
1445
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1510
1446
|
|
|
1511
1447
|
</dd>
|
|
1512
1448
|
</dl>
|
|
@@ -1522,7 +1458,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1522
1458
|
<dd>
|
|
1523
1459
|
|
|
1524
1460
|
```typescript
|
|
1525
|
-
await client.empathicVoice.
|
|
1461
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1462
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
1463
|
+
});
|
|
1526
1464
|
```
|
|
1527
1465
|
|
|
1528
1466
|
</dd>
|
|
@@ -1538,7 +1476,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1538
1476
|
<dl>
|
|
1539
1477
|
<dd>
|
|
1540
1478
|
|
|
1541
|
-
**id:** `string` — Identifier for a
|
|
1479
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1542
1480
|
|
|
1543
1481
|
</dd>
|
|
1544
1482
|
</dl>
|
|
@@ -1546,7 +1484,15 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1546
1484
|
<dl>
|
|
1547
1485
|
<dd>
|
|
1548
1486
|
|
|
1549
|
-
**
|
|
1487
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1488
|
+
|
|
1489
|
+
</dd>
|
|
1490
|
+
</dl>
|
|
1491
|
+
|
|
1492
|
+
<dl>
|
|
1493
|
+
<dd>
|
|
1494
|
+
|
|
1495
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1550
1496
|
|
|
1551
1497
|
</dd>
|
|
1552
1498
|
</dl>
|
|
@@ -1557,7 +1503,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1557
1503
|
</dl>
|
|
1558
1504
|
</details>
|
|
1559
1505
|
|
|
1560
|
-
<details><summary><code>client.empathicVoice.
|
|
1506
|
+
<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>
|
|
1561
1507
|
<dl>
|
|
1562
1508
|
<dd>
|
|
1563
1509
|
|
|
@@ -1569,9 +1515,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1569
1515
|
<dl>
|
|
1570
1516
|
<dd>
|
|
1571
1517
|
|
|
1572
|
-
|
|
1518
|
+
Fetches a specified version of a **Prompt**.
|
|
1573
1519
|
|
|
1574
|
-
|
|
1520
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1575
1521
|
|
|
1576
1522
|
</dd>
|
|
1577
1523
|
</dl>
|
|
@@ -1587,11 +1533,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1587
1533
|
<dd>
|
|
1588
1534
|
|
|
1589
1535
|
```typescript
|
|
1590
|
-
await client.empathicVoice.
|
|
1591
|
-
name: "name",
|
|
1592
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1593
|
-
parameterModel: "20240715-4parameter",
|
|
1594
|
-
});
|
|
1536
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
1595
1537
|
```
|
|
1596
1538
|
|
|
1597
1539
|
</dd>
|
|
@@ -1607,7 +1549,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1607
1549
|
<dl>
|
|
1608
1550
|
<dd>
|
|
1609
1551
|
|
|
1610
|
-
**id:** `string` — Identifier for a
|
|
1552
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1611
1553
|
|
|
1612
1554
|
</dd>
|
|
1613
1555
|
</dl>
|
|
@@ -1615,7 +1557,13 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1615
1557
|
<dl>
|
|
1616
1558
|
<dd>
|
|
1617
1559
|
|
|
1618
|
-
**
|
|
1560
|
+
**version:** `number`
|
|
1561
|
+
|
|
1562
|
+
Version number for a Prompt.
|
|
1563
|
+
|
|
1564
|
+
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.
|
|
1565
|
+
|
|
1566
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1619
1567
|
|
|
1620
1568
|
</dd>
|
|
1621
1569
|
</dl>
|
|
@@ -1623,7 +1571,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1623
1571
|
<dl>
|
|
1624
1572
|
<dd>
|
|
1625
1573
|
|
|
1626
|
-
**requestOptions:** `
|
|
1574
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1627
1575
|
|
|
1628
1576
|
</dd>
|
|
1629
1577
|
</dl>
|
|
@@ -1634,7 +1582,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1634
1582
|
</dl>
|
|
1635
1583
|
</details>
|
|
1636
1584
|
|
|
1637
|
-
<details><summary><code>client.empathicVoice.
|
|
1585
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
1638
1586
|
<dl>
|
|
1639
1587
|
<dd>
|
|
1640
1588
|
|
|
@@ -1646,9 +1594,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1646
1594
|
<dl>
|
|
1647
1595
|
<dd>
|
|
1648
1596
|
|
|
1649
|
-
Deletes a
|
|
1597
|
+
Deletes a specified version of a **Prompt**.
|
|
1650
1598
|
|
|
1651
|
-
|
|
1599
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1652
1600
|
|
|
1653
1601
|
</dd>
|
|
1654
1602
|
</dl>
|
|
@@ -1664,7 +1612,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1664
1612
|
<dd>
|
|
1665
1613
|
|
|
1666
1614
|
```typescript
|
|
1667
|
-
await client.empathicVoice.
|
|
1615
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
1668
1616
|
```
|
|
1669
1617
|
|
|
1670
1618
|
</dd>
|
|
@@ -1680,7 +1628,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1680
1628
|
<dl>
|
|
1681
1629
|
<dd>
|
|
1682
1630
|
|
|
1683
|
-
**id:** `string` — Identifier for a
|
|
1631
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1684
1632
|
|
|
1685
1633
|
</dd>
|
|
1686
1634
|
</dl>
|
|
@@ -1688,10 +1636,24 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1688
1636
|
<dl>
|
|
1689
1637
|
<dd>
|
|
1690
1638
|
|
|
1691
|
-
**
|
|
1639
|
+
**version:** `number`
|
|
1640
|
+
|
|
1641
|
+
Version number for a Prompt.
|
|
1642
|
+
|
|
1643
|
+
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.
|
|
1644
|
+
|
|
1645
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1692
1646
|
|
|
1693
|
-
</dd>
|
|
1694
|
-
</dl>
|
|
1647
|
+
</dd>
|
|
1648
|
+
</dl>
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1654
|
+
|
|
1655
|
+
</dd>
|
|
1656
|
+
</dl>
|
|
1695
1657
|
</dd>
|
|
1696
1658
|
</dl>
|
|
1697
1659
|
|
|
@@ -1699,7 +1661,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1699
1661
|
</dl>
|
|
1700
1662
|
</details>
|
|
1701
1663
|
|
|
1702
|
-
<details><summary><code>client.empathicVoice.
|
|
1664
|
+
<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>
|
|
1703
1665
|
<dl>
|
|
1704
1666
|
<dd>
|
|
1705
1667
|
|
|
@@ -1711,9 +1673,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1711
1673
|
<dl>
|
|
1712
1674
|
<dd>
|
|
1713
1675
|
|
|
1714
|
-
Updates the
|
|
1676
|
+
Updates the description of a **Prompt**.
|
|
1715
1677
|
|
|
1716
|
-
|
|
1678
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1717
1679
|
|
|
1718
1680
|
</dd>
|
|
1719
1681
|
</dl>
|
|
@@ -1729,8 +1691,8 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1729
1691
|
<dd>
|
|
1730
1692
|
|
|
1731
1693
|
```typescript
|
|
1732
|
-
await client.empathicVoice.
|
|
1733
|
-
|
|
1694
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1695
|
+
versionDescription: "This is an updated version_description.",
|
|
1734
1696
|
});
|
|
1735
1697
|
```
|
|
1736
1698
|
|
|
@@ -1747,7 +1709,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
|
1747
1709
|
<dl>
|
|
1748
1710
|
<dd>
|
|
1749
1711
|
|
|
1750
|
-
**id:** `string` — Identifier for a
|
|
1712
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1751
1713
|
|
|
1752
1714
|
</dd>
|
|
1753
1715
|
</dl>
|
|
@@ -1755,7 +1717,13 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
|
1755
1717
|
<dl>
|
|
1756
1718
|
<dd>
|
|
1757
1719
|
|
|
1758
|
-
**
|
|
1720
|
+
**version:** `number`
|
|
1721
|
+
|
|
1722
|
+
Version number for a Prompt.
|
|
1723
|
+
|
|
1724
|
+
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.
|
|
1725
|
+
|
|
1726
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1759
1727
|
|
|
1760
1728
|
</dd>
|
|
1761
1729
|
</dl>
|
|
@@ -1763,7 +1731,15 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
|
1763
1731
|
<dl>
|
|
1764
1732
|
<dd>
|
|
1765
1733
|
|
|
1766
|
-
**
|
|
1734
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1735
|
+
|
|
1736
|
+
</dd>
|
|
1737
|
+
</dl>
|
|
1738
|
+
|
|
1739
|
+
<dl>
|
|
1740
|
+
<dd>
|
|
1741
|
+
|
|
1742
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1767
1743
|
|
|
1768
1744
|
</dd>
|
|
1769
1745
|
</dl>
|
|
@@ -1774,9 +1750,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
|
1774
1750
|
</dl>
|
|
1775
1751
|
</details>
|
|
1776
1752
|
|
|
1777
|
-
## EmpathicVoice
|
|
1753
|
+
## EmpathicVoice CustomVoices
|
|
1778
1754
|
|
|
1779
|
-
<details><summary><code>client.empathicVoice.
|
|
1755
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1780
1756
|
<dl>
|
|
1781
1757
|
<dd>
|
|
1782
1758
|
|
|
@@ -1788,9 +1764,9 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
|
1788
1764
|
<dl>
|
|
1789
1765
|
<dd>
|
|
1790
1766
|
|
|
1791
|
-
Fetches a paginated list of **
|
|
1767
|
+
Fetches a paginated list of **Custom Voices**.
|
|
1792
1768
|
|
|
1793
|
-
|
|
1769
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1794
1770
|
|
|
1795
1771
|
</dd>
|
|
1796
1772
|
</dl>
|
|
@@ -1806,10 +1782,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1806
1782
|
<dd>
|
|
1807
1783
|
|
|
1808
1784
|
```typescript
|
|
1809
|
-
await client.empathicVoice.
|
|
1810
|
-
pageNumber: 0,
|
|
1811
|
-
pageSize: 1,
|
|
1812
|
-
});
|
|
1785
|
+
await client.empathicVoice.customVoices.listCustomVoices();
|
|
1813
1786
|
```
|
|
1814
1787
|
|
|
1815
1788
|
</dd>
|
|
@@ -1825,7 +1798,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1825
1798
|
<dl>
|
|
1826
1799
|
<dd>
|
|
1827
1800
|
|
|
1828
|
-
**request:** `Hume.empathicVoice.
|
|
1801
|
+
**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
|
|
1829
1802
|
|
|
1830
1803
|
</dd>
|
|
1831
1804
|
</dl>
|
|
@@ -1833,7 +1806,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1833
1806
|
<dl>
|
|
1834
1807
|
<dd>
|
|
1835
1808
|
|
|
1836
|
-
**requestOptions:** `
|
|
1809
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1837
1810
|
|
|
1838
1811
|
</dd>
|
|
1839
1812
|
</dl>
|
|
@@ -1844,7 +1817,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1844
1817
|
</dl>
|
|
1845
1818
|
</details>
|
|
1846
1819
|
|
|
1847
|
-
<details><summary><code>client.empathicVoice.
|
|
1820
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
1848
1821
|
<dl>
|
|
1849
1822
|
<dd>
|
|
1850
1823
|
|
|
@@ -1856,9 +1829,9 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1856
1829
|
<dl>
|
|
1857
1830
|
<dd>
|
|
1858
1831
|
|
|
1859
|
-
Creates a **
|
|
1832
|
+
Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1860
1833
|
|
|
1861
|
-
|
|
1834
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1862
1835
|
|
|
1863
1836
|
</dd>
|
|
1864
1837
|
</dl>
|
|
@@ -1874,36 +1847,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1874
1847
|
<dd>
|
|
1875
1848
|
|
|
1876
1849
|
```typescript
|
|
1877
|
-
await client.empathicVoice.
|
|
1878
|
-
name: "
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
version: 0,
|
|
1882
|
-
},
|
|
1883
|
-
eviVersion: "2",
|
|
1884
|
-
voice: {
|
|
1885
|
-
provider: "HUME_AI",
|
|
1886
|
-
name: "SAMPLE VOICE",
|
|
1887
|
-
},
|
|
1888
|
-
languageModel: {
|
|
1889
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1890
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
1891
|
-
temperature: 1,
|
|
1892
|
-
},
|
|
1893
|
-
eventMessages: {
|
|
1894
|
-
onNewChat: {
|
|
1895
|
-
enabled: false,
|
|
1896
|
-
text: "",
|
|
1897
|
-
},
|
|
1898
|
-
onInactivityTimeout: {
|
|
1899
|
-
enabled: false,
|
|
1900
|
-
text: "",
|
|
1901
|
-
},
|
|
1902
|
-
onMaxDurationTimeout: {
|
|
1903
|
-
enabled: false,
|
|
1904
|
-
text: "",
|
|
1905
|
-
},
|
|
1906
|
-
},
|
|
1850
|
+
await client.empathicVoice.customVoices.createCustomVoice({
|
|
1851
|
+
name: "name",
|
|
1852
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1853
|
+
parameterModel: "20240715-4parameter",
|
|
1907
1854
|
});
|
|
1908
1855
|
```
|
|
1909
1856
|
|
|
@@ -1920,7 +1867,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1920
1867
|
<dl>
|
|
1921
1868
|
<dd>
|
|
1922
1869
|
|
|
1923
|
-
**request:** `Hume.
|
|
1870
|
+
**request:** `Hume.PostedCustomVoice`
|
|
1924
1871
|
|
|
1925
1872
|
</dd>
|
|
1926
1873
|
</dl>
|
|
@@ -1928,7 +1875,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1928
1875
|
<dl>
|
|
1929
1876
|
<dd>
|
|
1930
1877
|
|
|
1931
|
-
**requestOptions:** `
|
|
1878
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1932
1879
|
|
|
1933
1880
|
</dd>
|
|
1934
1881
|
</dl>
|
|
@@ -1939,7 +1886,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1939
1886
|
</dl>
|
|
1940
1887
|
</details>
|
|
1941
1888
|
|
|
1942
|
-
<details><summary><code>client.empathicVoice.
|
|
1889
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
|
|
1943
1890
|
<dl>
|
|
1944
1891
|
<dd>
|
|
1945
1892
|
|
|
@@ -1951,9 +1898,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1951
1898
|
<dl>
|
|
1952
1899
|
<dd>
|
|
1953
1900
|
|
|
1954
|
-
Fetches a
|
|
1901
|
+
Fetches a specific **Custom Voice** by ID.
|
|
1955
1902
|
|
|
1956
|
-
|
|
1903
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1957
1904
|
|
|
1958
1905
|
</dd>
|
|
1959
1906
|
</dl>
|
|
@@ -1969,7 +1916,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1969
1916
|
<dd>
|
|
1970
1917
|
|
|
1971
1918
|
```typescript
|
|
1972
|
-
await client.empathicVoice.
|
|
1919
|
+
await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
1973
1920
|
```
|
|
1974
1921
|
|
|
1975
1922
|
</dd>
|
|
@@ -1985,15 +1932,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1985
1932
|
<dl>
|
|
1986
1933
|
<dd>
|
|
1987
1934
|
|
|
1988
|
-
**id:** `string` — Identifier for a
|
|
1989
|
-
|
|
1990
|
-
</dd>
|
|
1991
|
-
</dl>
|
|
1992
|
-
|
|
1993
|
-
<dl>
|
|
1994
|
-
<dd>
|
|
1995
|
-
|
|
1996
|
-
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
1935
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1997
1936
|
|
|
1998
1937
|
</dd>
|
|
1999
1938
|
</dl>
|
|
@@ -2001,7 +1940,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2001
1940
|
<dl>
|
|
2002
1941
|
<dd>
|
|
2003
1942
|
|
|
2004
|
-
**requestOptions:** `
|
|
1943
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2005
1944
|
|
|
2006
1945
|
</dd>
|
|
2007
1946
|
</dl>
|
|
@@ -2012,7 +1951,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2012
1951
|
</dl>
|
|
2013
1952
|
</details>
|
|
2014
1953
|
|
|
2015
|
-
<details><summary><code>client.empathicVoice.
|
|
1954
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoiceVersion</a>(id, { ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
2016
1955
|
<dl>
|
|
2017
1956
|
<dd>
|
|
2018
1957
|
|
|
@@ -2024,9 +1963,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2024
1963
|
<dl>
|
|
2025
1964
|
<dd>
|
|
2026
1965
|
|
|
2027
|
-
Updates a **
|
|
1966
|
+
Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
|
|
2028
1967
|
|
|
2029
|
-
|
|
1968
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
2030
1969
|
|
|
2031
1970
|
</dd>
|
|
2032
1971
|
</dl>
|
|
@@ -2042,39 +1981,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2042
1981
|
<dd>
|
|
2043
1982
|
|
|
2044
1983
|
```typescript
|
|
2045
|
-
await client.empathicVoice.
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2050
|
-
version: 0,
|
|
2051
|
-
},
|
|
2052
|
-
voice: {
|
|
2053
|
-
provider: "HUME_AI",
|
|
2054
|
-
name: "ITO",
|
|
2055
|
-
},
|
|
2056
|
-
languageModel: {
|
|
2057
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2058
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
2059
|
-
temperature: 1,
|
|
2060
|
-
},
|
|
2061
|
-
ellmModel: {
|
|
2062
|
-
allowShortResponses: true,
|
|
2063
|
-
},
|
|
2064
|
-
eventMessages: {
|
|
2065
|
-
onNewChat: {
|
|
2066
|
-
enabled: false,
|
|
2067
|
-
text: "",
|
|
2068
|
-
},
|
|
2069
|
-
onInactivityTimeout: {
|
|
2070
|
-
enabled: false,
|
|
2071
|
-
text: "",
|
|
2072
|
-
},
|
|
2073
|
-
onMaxDurationTimeout: {
|
|
2074
|
-
enabled: false,
|
|
2075
|
-
text: "",
|
|
2076
|
-
},
|
|
2077
|
-
},
|
|
1984
|
+
await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
1985
|
+
name: "name",
|
|
1986
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1987
|
+
parameterModel: "20240715-4parameter",
|
|
2078
1988
|
});
|
|
2079
1989
|
```
|
|
2080
1990
|
|
|
@@ -2091,7 +2001,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2091
2001
|
<dl>
|
|
2092
2002
|
<dd>
|
|
2093
2003
|
|
|
2094
|
-
**id:** `string` — Identifier for a
|
|
2004
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2095
2005
|
|
|
2096
2006
|
</dd>
|
|
2097
2007
|
</dl>
|
|
@@ -2099,7 +2009,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2099
2009
|
<dl>
|
|
2100
2010
|
<dd>
|
|
2101
2011
|
|
|
2102
|
-
**request:** `Hume.
|
|
2012
|
+
**request:** `Hume.PostedCustomVoice`
|
|
2103
2013
|
|
|
2104
2014
|
</dd>
|
|
2105
2015
|
</dl>
|
|
@@ -2107,7 +2017,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2107
2017
|
<dl>
|
|
2108
2018
|
<dd>
|
|
2109
2019
|
|
|
2110
|
-
**requestOptions:** `
|
|
2020
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2111
2021
|
|
|
2112
2022
|
</dd>
|
|
2113
2023
|
</dl>
|
|
@@ -2118,7 +2028,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2118
2028
|
</dl>
|
|
2119
2029
|
</details>
|
|
2120
2030
|
|
|
2121
|
-
<details><summary><code>client.empathicVoice.
|
|
2031
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
|
|
2122
2032
|
<dl>
|
|
2123
2033
|
<dd>
|
|
2124
2034
|
|
|
@@ -2130,9 +2040,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2130
2040
|
<dl>
|
|
2131
2041
|
<dd>
|
|
2132
2042
|
|
|
2133
|
-
Deletes a **
|
|
2043
|
+
Deletes a **Custom Voice** and its versions.
|
|
2134
2044
|
|
|
2135
|
-
|
|
2045
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
2136
2046
|
|
|
2137
2047
|
</dd>
|
|
2138
2048
|
</dl>
|
|
@@ -2148,7 +2058,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2148
2058
|
<dd>
|
|
2149
2059
|
|
|
2150
2060
|
```typescript
|
|
2151
|
-
await client.empathicVoice.
|
|
2061
|
+
await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
2152
2062
|
```
|
|
2153
2063
|
|
|
2154
2064
|
</dd>
|
|
@@ -2164,7 +2074,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2164
2074
|
<dl>
|
|
2165
2075
|
<dd>
|
|
2166
2076
|
|
|
2167
|
-
**id:** `string` — Identifier for a
|
|
2077
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2168
2078
|
|
|
2169
2079
|
</dd>
|
|
2170
2080
|
</dl>
|
|
@@ -2172,7 +2082,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2172
2082
|
<dl>
|
|
2173
2083
|
<dd>
|
|
2174
2084
|
|
|
2175
|
-
**requestOptions:** `
|
|
2085
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2176
2086
|
|
|
2177
2087
|
</dd>
|
|
2178
2088
|
</dl>
|
|
@@ -2183,7 +2093,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2183
2093
|
</dl>
|
|
2184
2094
|
</details>
|
|
2185
2095
|
|
|
2186
|
-
<details><summary><code>client.empathicVoice.
|
|
2096
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
|
|
2187
2097
|
<dl>
|
|
2188
2098
|
<dd>
|
|
2189
2099
|
|
|
@@ -2195,9 +2105,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2195
2105
|
<dl>
|
|
2196
2106
|
<dd>
|
|
2197
2107
|
|
|
2198
|
-
Updates the name of a **
|
|
2108
|
+
Updates the name of a **Custom Voice**.
|
|
2199
2109
|
|
|
2200
|
-
|
|
2110
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
2201
2111
|
|
|
2202
2112
|
</dd>
|
|
2203
2113
|
</dl>
|
|
@@ -2213,8 +2123,8 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2213
2123
|
<dd>
|
|
2214
2124
|
|
|
2215
2125
|
```typescript
|
|
2216
|
-
await client.empathicVoice.
|
|
2217
|
-
name: "
|
|
2126
|
+
await client.empathicVoice.customVoices.updateCustomVoiceName("string", {
|
|
2127
|
+
name: "string",
|
|
2218
2128
|
});
|
|
2219
2129
|
```
|
|
2220
2130
|
|
|
@@ -2231,7 +2141,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2231
2141
|
<dl>
|
|
2232
2142
|
<dd>
|
|
2233
2143
|
|
|
2234
|
-
**id:** `string` — Identifier for a
|
|
2144
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2235
2145
|
|
|
2236
2146
|
</dd>
|
|
2237
2147
|
</dl>
|
|
@@ -2239,7 +2149,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2239
2149
|
<dl>
|
|
2240
2150
|
<dd>
|
|
2241
2151
|
|
|
2242
|
-
**request:** `Hume.empathicVoice.
|
|
2152
|
+
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
2243
2153
|
|
|
2244
2154
|
</dd>
|
|
2245
2155
|
</dl>
|
|
@@ -2247,7 +2157,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2247
2157
|
<dl>
|
|
2248
2158
|
<dd>
|
|
2249
2159
|
|
|
2250
|
-
**requestOptions:** `
|
|
2160
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2251
2161
|
|
|
2252
2162
|
</dd>
|
|
2253
2163
|
</dl>
|
|
@@ -2258,7 +2168,9 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2258
2168
|
</dl>
|
|
2259
2169
|
</details>
|
|
2260
2170
|
|
|
2261
|
-
|
|
2171
|
+
## EmpathicVoice Configs
|
|
2172
|
+
|
|
2173
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2262
2174
|
<dl>
|
|
2263
2175
|
<dd>
|
|
2264
2176
|
|
|
@@ -2270,7 +2182,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2270
2182
|
<dl>
|
|
2271
2183
|
<dd>
|
|
2272
2184
|
|
|
2273
|
-
Fetches a
|
|
2185
|
+
Fetches a paginated list of **Configs**.
|
|
2274
2186
|
|
|
2275
2187
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2276
2188
|
|
|
@@ -2288,7 +2200,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2288
2200
|
<dd>
|
|
2289
2201
|
|
|
2290
2202
|
```typescript
|
|
2291
|
-
await client.empathicVoice.configs.
|
|
2203
|
+
await client.empathicVoice.configs.listConfigs({
|
|
2204
|
+
pageNumber: 0,
|
|
2205
|
+
pageSize: 1,
|
|
2206
|
+
});
|
|
2292
2207
|
```
|
|
2293
2208
|
|
|
2294
2209
|
</dd>
|
|
@@ -2304,21 +2219,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2304
2219
|
<dl>
|
|
2305
2220
|
<dd>
|
|
2306
2221
|
|
|
2307
|
-
**
|
|
2308
|
-
|
|
2309
|
-
</dd>
|
|
2310
|
-
</dl>
|
|
2311
|
-
|
|
2312
|
-
<dl>
|
|
2313
|
-
<dd>
|
|
2314
|
-
|
|
2315
|
-
**version:** `number`
|
|
2316
|
-
|
|
2317
|
-
Version number for a Config.
|
|
2318
|
-
|
|
2319
|
-
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.
|
|
2320
|
-
|
|
2321
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2222
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
2322
2223
|
|
|
2323
2224
|
</dd>
|
|
2324
2225
|
</dl>
|
|
@@ -2337,7 +2238,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2337
2238
|
</dl>
|
|
2338
2239
|
</details>
|
|
2339
2240
|
|
|
2340
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2241
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2341
2242
|
<dl>
|
|
2342
2243
|
<dd>
|
|
2343
2244
|
|
|
@@ -2349,7 +2250,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2349
2250
|
<dl>
|
|
2350
2251
|
<dd>
|
|
2351
2252
|
|
|
2352
|
-
|
|
2253
|
+
Creates a **Config** which can be applied to EVI.
|
|
2353
2254
|
|
|
2354
2255
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2355
2256
|
|
|
@@ -2367,7 +2268,37 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2367
2268
|
<dd>
|
|
2368
2269
|
|
|
2369
2270
|
```typescript
|
|
2370
|
-
await client.empathicVoice.configs.
|
|
2271
|
+
await client.empathicVoice.configs.createConfig({
|
|
2272
|
+
name: "Weather Assistant Config",
|
|
2273
|
+
prompt: {
|
|
2274
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2275
|
+
version: 0,
|
|
2276
|
+
},
|
|
2277
|
+
eviVersion: "2",
|
|
2278
|
+
voice: {
|
|
2279
|
+
provider: "HUME_AI",
|
|
2280
|
+
name: "SAMPLE VOICE",
|
|
2281
|
+
},
|
|
2282
|
+
languageModel: {
|
|
2283
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2284
|
+
modelResource: "claude-3-5-sonnet-20240620",
|
|
2285
|
+
temperature: 1,
|
|
2286
|
+
},
|
|
2287
|
+
eventMessages: {
|
|
2288
|
+
onNewChat: {
|
|
2289
|
+
enabled: false,
|
|
2290
|
+
text: "",
|
|
2291
|
+
},
|
|
2292
|
+
onInactivityTimeout: {
|
|
2293
|
+
enabled: false,
|
|
2294
|
+
text: "",
|
|
2295
|
+
},
|
|
2296
|
+
onMaxDurationTimeout: {
|
|
2297
|
+
enabled: false,
|
|
2298
|
+
text: "",
|
|
2299
|
+
},
|
|
2300
|
+
},
|
|
2301
|
+
});
|
|
2371
2302
|
```
|
|
2372
2303
|
|
|
2373
2304
|
</dd>
|
|
@@ -2383,21 +2314,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2383
2314
|
<dl>
|
|
2384
2315
|
<dd>
|
|
2385
2316
|
|
|
2386
|
-
**
|
|
2387
|
-
|
|
2388
|
-
</dd>
|
|
2389
|
-
</dl>
|
|
2390
|
-
|
|
2391
|
-
<dl>
|
|
2392
|
-
<dd>
|
|
2393
|
-
|
|
2394
|
-
**version:** `number`
|
|
2395
|
-
|
|
2396
|
-
Version number for a Config.
|
|
2397
|
-
|
|
2398
|
-
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.
|
|
2399
|
-
|
|
2400
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2317
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
2401
2318
|
|
|
2402
2319
|
</dd>
|
|
2403
2320
|
</dl>
|
|
@@ -2416,7 +2333,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2416
2333
|
</dl>
|
|
2417
2334
|
</details>
|
|
2418
2335
|
|
|
2419
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2336
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2420
2337
|
<dl>
|
|
2421
2338
|
<dd>
|
|
2422
2339
|
|
|
@@ -2428,7 +2345,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2428
2345
|
<dl>
|
|
2429
2346
|
<dd>
|
|
2430
2347
|
|
|
2431
|
-
|
|
2348
|
+
Fetches a list of a **Config's** versions.
|
|
2432
2349
|
|
|
2433
2350
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2434
2351
|
|
|
@@ -2446,9 +2363,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2446
2363
|
<dd>
|
|
2447
2364
|
|
|
2448
2365
|
```typescript
|
|
2449
|
-
await client.empathicVoice.configs.
|
|
2450
|
-
versionDescription: "This is an updated version_description.",
|
|
2451
|
-
});
|
|
2366
|
+
await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2452
2367
|
```
|
|
2453
2368
|
|
|
2454
2369
|
</dd>
|
|
@@ -2472,21 +2387,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
2472
2387
|
<dl>
|
|
2473
2388
|
<dd>
|
|
2474
2389
|
|
|
2475
|
-
**
|
|
2476
|
-
|
|
2477
|
-
Version number for a Config.
|
|
2478
|
-
|
|
2479
|
-
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.
|
|
2480
|
-
|
|
2481
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2482
|
-
|
|
2483
|
-
</dd>
|
|
2484
|
-
</dl>
|
|
2485
|
-
|
|
2486
|
-
<dl>
|
|
2487
|
-
<dd>
|
|
2488
|
-
|
|
2489
|
-
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2390
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2490
2391
|
|
|
2491
2392
|
</dd>
|
|
2492
2393
|
</dl>
|
|
@@ -2505,9 +2406,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2505
2406
|
</dl>
|
|
2506
2407
|
</details>
|
|
2507
2408
|
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2409
|
+
<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>
|
|
2511
2410
|
<dl>
|
|
2512
2411
|
<dd>
|
|
2513
2412
|
|
|
@@ -2519,14 +2418,66 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2519
2418
|
<dl>
|
|
2520
2419
|
<dd>
|
|
2521
2420
|
|
|
2522
|
-
|
|
2421
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
2422
|
+
|
|
2423
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2424
|
+
|
|
2425
|
+
</dd>
|
|
2426
|
+
</dl>
|
|
2427
|
+
</dd>
|
|
2428
|
+
</dl>
|
|
2429
|
+
|
|
2430
|
+
#### 🔌 Usage
|
|
2431
|
+
|
|
2432
|
+
<dl>
|
|
2433
|
+
<dd>
|
|
2434
|
+
|
|
2435
|
+
<dl>
|
|
2436
|
+
<dd>
|
|
2437
|
+
|
|
2438
|
+
```typescript
|
|
2439
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2440
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2441
|
+
eviVersion: "2",
|
|
2442
|
+
prompt: {
|
|
2443
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2444
|
+
version: 0,
|
|
2445
|
+
},
|
|
2446
|
+
voice: {
|
|
2447
|
+
provider: "HUME_AI",
|
|
2448
|
+
name: "ITO",
|
|
2449
|
+
},
|
|
2450
|
+
languageModel: {
|
|
2451
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2452
|
+
modelResource: "claude-3-5-sonnet-20240620",
|
|
2453
|
+
temperature: 1,
|
|
2454
|
+
},
|
|
2455
|
+
ellmModel: {
|
|
2456
|
+
allowShortResponses: true,
|
|
2457
|
+
},
|
|
2458
|
+
eventMessages: {
|
|
2459
|
+
onNewChat: {
|
|
2460
|
+
enabled: false,
|
|
2461
|
+
text: "",
|
|
2462
|
+
},
|
|
2463
|
+
onInactivityTimeout: {
|
|
2464
|
+
enabled: false,
|
|
2465
|
+
text: "",
|
|
2466
|
+
},
|
|
2467
|
+
onMaxDurationTimeout: {
|
|
2468
|
+
enabled: false,
|
|
2469
|
+
text: "",
|
|
2470
|
+
},
|
|
2471
|
+
},
|
|
2472
|
+
});
|
|
2473
|
+
```
|
|
2523
2474
|
|
|
2524
2475
|
</dd>
|
|
2525
2476
|
</dl>
|
|
2526
2477
|
</dd>
|
|
2527
2478
|
</dl>
|
|
2528
2479
|
|
|
2529
|
-
####
|
|
2480
|
+
#### ⚙️ Parameters
|
|
2530
2481
|
|
|
2531
2482
|
<dl>
|
|
2532
2483
|
<dd>
|
|
@@ -2534,28 +2485,15 @@ Fetches a paginated list of **Chats**.
|
|
|
2534
2485
|
<dl>
|
|
2535
2486
|
<dd>
|
|
2536
2487
|
|
|
2537
|
-
|
|
2538
|
-
await client.empathicVoice.chats.listChats({
|
|
2539
|
-
pageNumber: 0,
|
|
2540
|
-
pageSize: 1,
|
|
2541
|
-
ascendingOrder: true,
|
|
2542
|
-
});
|
|
2543
|
-
```
|
|
2488
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2544
2489
|
|
|
2545
2490
|
</dd>
|
|
2546
2491
|
</dl>
|
|
2547
|
-
</dd>
|
|
2548
|
-
</dl>
|
|
2549
|
-
|
|
2550
|
-
#### ⚙️ Parameters
|
|
2551
|
-
|
|
2552
|
-
<dl>
|
|
2553
|
-
<dd>
|
|
2554
2492
|
|
|
2555
2493
|
<dl>
|
|
2556
2494
|
<dd>
|
|
2557
2495
|
|
|
2558
|
-
**request:** `Hume.empathicVoice.
|
|
2496
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2559
2497
|
|
|
2560
2498
|
</dd>
|
|
2561
2499
|
</dl>
|
|
@@ -2563,7 +2501,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2563
2501
|
<dl>
|
|
2564
2502
|
<dd>
|
|
2565
2503
|
|
|
2566
|
-
**requestOptions:** `
|
|
2504
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2567
2505
|
|
|
2568
2506
|
</dd>
|
|
2569
2507
|
</dl>
|
|
@@ -2574,7 +2512,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2574
2512
|
</dl>
|
|
2575
2513
|
</details>
|
|
2576
2514
|
|
|
2577
|
-
<details><summary><code>client.empathicVoice.
|
|
2515
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
2578
2516
|
<dl>
|
|
2579
2517
|
<dd>
|
|
2580
2518
|
|
|
@@ -2586,7 +2524,9 @@ await client.empathicVoice.chats.listChats({
|
|
|
2586
2524
|
<dl>
|
|
2587
2525
|
<dd>
|
|
2588
2526
|
|
|
2589
|
-
|
|
2527
|
+
Deletes a **Config** and its versions.
|
|
2528
|
+
|
|
2529
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2590
2530
|
|
|
2591
2531
|
</dd>
|
|
2592
2532
|
</dl>
|
|
@@ -2602,11 +2542,7 @@ Fetches a paginated list of **Chat** events.
|
|
|
2602
2542
|
<dd>
|
|
2603
2543
|
|
|
2604
2544
|
```typescript
|
|
2605
|
-
await client.empathicVoice.
|
|
2606
|
-
pageNumber: 0,
|
|
2607
|
-
pageSize: 3,
|
|
2608
|
-
ascendingOrder: true,
|
|
2609
|
-
});
|
|
2545
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2610
2546
|
```
|
|
2611
2547
|
|
|
2612
2548
|
</dd>
|
|
@@ -2622,15 +2558,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2622
2558
|
<dl>
|
|
2623
2559
|
<dd>
|
|
2624
2560
|
|
|
2625
|
-
**id:** `string` — Identifier for a
|
|
2626
|
-
|
|
2627
|
-
</dd>
|
|
2628
|
-
</dl>
|
|
2629
|
-
|
|
2630
|
-
<dl>
|
|
2631
|
-
<dd>
|
|
2632
|
-
|
|
2633
|
-
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
2561
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2634
2562
|
|
|
2635
2563
|
</dd>
|
|
2636
2564
|
</dl>
|
|
@@ -2638,7 +2566,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2638
2566
|
<dl>
|
|
2639
2567
|
<dd>
|
|
2640
2568
|
|
|
2641
|
-
**requestOptions:** `
|
|
2569
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2642
2570
|
|
|
2643
2571
|
</dd>
|
|
2644
2572
|
</dl>
|
|
@@ -2649,9 +2577,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2649
2577
|
</dl>
|
|
2650
2578
|
</details>
|
|
2651
2579
|
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
2580
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
2655
2581
|
<dl>
|
|
2656
2582
|
<dd>
|
|
2657
2583
|
|
|
@@ -2663,7 +2589,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2663
2589
|
<dl>
|
|
2664
2590
|
<dd>
|
|
2665
2591
|
|
|
2666
|
-
|
|
2592
|
+
Updates the name of a **Config**.
|
|
2593
|
+
|
|
2594
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2667
2595
|
|
|
2668
2596
|
</dd>
|
|
2669
2597
|
</dl>
|
|
@@ -2679,11 +2607,8 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
2679
2607
|
<dd>
|
|
2680
2608
|
|
|
2681
2609
|
```typescript
|
|
2682
|
-
await client.empathicVoice.
|
|
2683
|
-
|
|
2684
|
-
pageSize: 1,
|
|
2685
|
-
ascendingOrder: true,
|
|
2686
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2610
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2611
|
+
name: "Updated Weather Assistant Config Name",
|
|
2687
2612
|
});
|
|
2688
2613
|
```
|
|
2689
2614
|
|
|
@@ -2700,7 +2625,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2700
2625
|
<dl>
|
|
2701
2626
|
<dd>
|
|
2702
2627
|
|
|
2703
|
-
**
|
|
2628
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2704
2629
|
|
|
2705
2630
|
</dd>
|
|
2706
2631
|
</dl>
|
|
@@ -2708,7 +2633,15 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2708
2633
|
<dl>
|
|
2709
2634
|
<dd>
|
|
2710
2635
|
|
|
2711
|
-
**
|
|
2636
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2637
|
+
|
|
2638
|
+
</dd>
|
|
2639
|
+
</dl>
|
|
2640
|
+
|
|
2641
|
+
<dl>
|
|
2642
|
+
<dd>
|
|
2643
|
+
|
|
2644
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2712
2645
|
|
|
2713
2646
|
</dd>
|
|
2714
2647
|
</dl>
|
|
@@ -2719,7 +2652,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2719
2652
|
</dl>
|
|
2720
2653
|
</details>
|
|
2721
2654
|
|
|
2722
|
-
<details><summary><code>client.empathicVoice.
|
|
2655
|
+
<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>
|
|
2723
2656
|
<dl>
|
|
2724
2657
|
<dd>
|
|
2725
2658
|
|
|
@@ -2731,7 +2664,9 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2731
2664
|
<dl>
|
|
2732
2665
|
<dd>
|
|
2733
2666
|
|
|
2734
|
-
Fetches a
|
|
2667
|
+
Fetches a specified version of a **Config**.
|
|
2668
|
+
|
|
2669
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2735
2670
|
|
|
2736
2671
|
</dd>
|
|
2737
2672
|
</dl>
|
|
@@ -2747,11 +2682,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
2747
2682
|
<dd>
|
|
2748
2683
|
|
|
2749
2684
|
```typescript
|
|
2750
|
-
await client.empathicVoice.
|
|
2751
|
-
pageNumber: 0,
|
|
2752
|
-
pageSize: 1,
|
|
2753
|
-
ascendingOrder: true,
|
|
2754
|
-
});
|
|
2685
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2755
2686
|
```
|
|
2756
2687
|
|
|
2757
2688
|
</dd>
|
|
@@ -2767,7 +2698,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2767
2698
|
<dl>
|
|
2768
2699
|
<dd>
|
|
2769
2700
|
|
|
2770
|
-
**id:** `string` — Identifier for a
|
|
2701
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2771
2702
|
|
|
2772
2703
|
</dd>
|
|
2773
2704
|
</dl>
|
|
@@ -2775,7 +2706,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2775
2706
|
<dl>
|
|
2776
2707
|
<dd>
|
|
2777
2708
|
|
|
2778
|
-
**
|
|
2709
|
+
**version:** `number`
|
|
2710
|
+
|
|
2711
|
+
Version number for a Config.
|
|
2712
|
+
|
|
2713
|
+
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.
|
|
2714
|
+
|
|
2715
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2779
2716
|
|
|
2780
2717
|
</dd>
|
|
2781
2718
|
</dl>
|
|
@@ -2783,7 +2720,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2783
2720
|
<dl>
|
|
2784
2721
|
<dd>
|
|
2785
2722
|
|
|
2786
|
-
**requestOptions:** `
|
|
2723
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2787
2724
|
|
|
2788
2725
|
</dd>
|
|
2789
2726
|
</dl>
|
|
@@ -2794,7 +2731,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2794
2731
|
</dl>
|
|
2795
2732
|
</details>
|
|
2796
2733
|
|
|
2797
|
-
<details><summary><code>client.empathicVoice.
|
|
2734
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
2798
2735
|
<dl>
|
|
2799
2736
|
<dd>
|
|
2800
2737
|
|
|
@@ -2806,7 +2743,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2806
2743
|
<dl>
|
|
2807
2744
|
<dd>
|
|
2808
2745
|
|
|
2809
|
-
|
|
2746
|
+
Deletes a specified version of a **Config**.
|
|
2747
|
+
|
|
2748
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2810
2749
|
|
|
2811
2750
|
</dd>
|
|
2812
2751
|
</dl>
|
|
@@ -2822,11 +2761,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
2822
2761
|
<dd>
|
|
2823
2762
|
|
|
2824
2763
|
```typescript
|
|
2825
|
-
await client.empathicVoice.
|
|
2826
|
-
pageNumber: 0,
|
|
2827
|
-
pageSize: 3,
|
|
2828
|
-
ascendingOrder: true,
|
|
2829
|
-
});
|
|
2764
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2830
2765
|
```
|
|
2831
2766
|
|
|
2832
2767
|
</dd>
|
|
@@ -2842,7 +2777,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2842
2777
|
<dl>
|
|
2843
2778
|
<dd>
|
|
2844
2779
|
|
|
2845
|
-
**id:** `string` — Identifier for a
|
|
2780
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2846
2781
|
|
|
2847
2782
|
</dd>
|
|
2848
2783
|
</dl>
|
|
@@ -2850,7 +2785,13 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2850
2785
|
<dl>
|
|
2851
2786
|
<dd>
|
|
2852
2787
|
|
|
2853
|
-
**
|
|
2788
|
+
**version:** `number`
|
|
2789
|
+
|
|
2790
|
+
Version number for a Config.
|
|
2791
|
+
|
|
2792
|
+
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.
|
|
2793
|
+
|
|
2794
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2854
2795
|
|
|
2855
2796
|
</dd>
|
|
2856
2797
|
</dl>
|
|
@@ -2858,7 +2799,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2858
2799
|
<dl>
|
|
2859
2800
|
<dd>
|
|
2860
2801
|
|
|
2861
|
-
**requestOptions:** `
|
|
2802
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2862
2803
|
|
|
2863
2804
|
</dd>
|
|
2864
2805
|
</dl>
|
|
@@ -2869,9 +2810,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2869
2810
|
</dl>
|
|
2870
2811
|
</details>
|
|
2871
2812
|
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
2813
|
+
<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>
|
|
2875
2814
|
<dl>
|
|
2876
2815
|
<dd>
|
|
2877
2816
|
|
|
@@ -2883,7 +2822,9 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2883
2822
|
<dl>
|
|
2884
2823
|
<dd>
|
|
2885
2824
|
|
|
2886
|
-
|
|
2825
|
+
Updates the description of a **Config**.
|
|
2826
|
+
|
|
2827
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2887
2828
|
|
|
2888
2829
|
</dd>
|
|
2889
2830
|
</dl>
|
|
@@ -2899,7 +2840,9 @@ Sort and filter jobs.
|
|
|
2899
2840
|
<dd>
|
|
2900
2841
|
|
|
2901
2842
|
```typescript
|
|
2902
|
-
await client.
|
|
2843
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
2844
|
+
versionDescription: "This is an updated version_description.",
|
|
2845
|
+
});
|
|
2903
2846
|
```
|
|
2904
2847
|
|
|
2905
2848
|
</dd>
|
|
@@ -2915,7 +2858,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2915
2858
|
<dl>
|
|
2916
2859
|
<dd>
|
|
2917
2860
|
|
|
2918
|
-
**
|
|
2861
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2919
2862
|
|
|
2920
2863
|
</dd>
|
|
2921
2864
|
</dl>
|
|
@@ -2923,7 +2866,29 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2923
2866
|
<dl>
|
|
2924
2867
|
<dd>
|
|
2925
2868
|
|
|
2926
|
-
**
|
|
2869
|
+
**version:** `number`
|
|
2870
|
+
|
|
2871
|
+
Version number for a Config.
|
|
2872
|
+
|
|
2873
|
+
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.
|
|
2874
|
+
|
|
2875
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2876
|
+
|
|
2877
|
+
</dd>
|
|
2878
|
+
</dl>
|
|
2879
|
+
|
|
2880
|
+
<dl>
|
|
2881
|
+
<dd>
|
|
2882
|
+
|
|
2883
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2884
|
+
|
|
2885
|
+
</dd>
|
|
2886
|
+
</dl>
|
|
2887
|
+
|
|
2888
|
+
<dl>
|
|
2889
|
+
<dd>
|
|
2890
|
+
|
|
2891
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2927
2892
|
|
|
2928
2893
|
</dd>
|
|
2929
2894
|
</dl>
|
|
@@ -2934,7 +2899,9 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2934
2899
|
</dl>
|
|
2935
2900
|
</details>
|
|
2936
2901
|
|
|
2937
|
-
|
|
2902
|
+
## EmpathicVoice Chats
|
|
2903
|
+
|
|
2904
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2938
2905
|
<dl>
|
|
2939
2906
|
<dd>
|
|
2940
2907
|
|
|
@@ -2946,7 +2913,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2946
2913
|
<dl>
|
|
2947
2914
|
<dd>
|
|
2948
2915
|
|
|
2949
|
-
|
|
2916
|
+
Fetches a paginated list of **Chats**.
|
|
2950
2917
|
|
|
2951
2918
|
</dd>
|
|
2952
2919
|
</dl>
|
|
@@ -2962,9 +2929,10 @@ Start a new measurement inference job.
|
|
|
2962
2929
|
<dd>
|
|
2963
2930
|
|
|
2964
2931
|
```typescript
|
|
2965
|
-
await client.
|
|
2966
|
-
|
|
2967
|
-
|
|
2932
|
+
await client.empathicVoice.chats.listChats({
|
|
2933
|
+
pageNumber: 0,
|
|
2934
|
+
pageSize: 1,
|
|
2935
|
+
ascendingOrder: true,
|
|
2968
2936
|
});
|
|
2969
2937
|
```
|
|
2970
2938
|
|
|
@@ -2981,7 +2949,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2981
2949
|
<dl>
|
|
2982
2950
|
<dd>
|
|
2983
2951
|
|
|
2984
|
-
**request:** `Hume.
|
|
2952
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
2985
2953
|
|
|
2986
2954
|
</dd>
|
|
2987
2955
|
</dl>
|
|
@@ -2989,7 +2957,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2989
2957
|
<dl>
|
|
2990
2958
|
<dd>
|
|
2991
2959
|
|
|
2992
|
-
**requestOptions:** `
|
|
2960
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2993
2961
|
|
|
2994
2962
|
</dd>
|
|
2995
2963
|
</dl>
|
|
@@ -3000,7 +2968,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3000
2968
|
</dl>
|
|
3001
2969
|
</details>
|
|
3002
2970
|
|
|
3003
|
-
<details><summary><code>client.
|
|
2971
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
|
|
3004
2972
|
<dl>
|
|
3005
2973
|
<dd>
|
|
3006
2974
|
|
|
@@ -3012,7 +2980,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3012
2980
|
<dl>
|
|
3013
2981
|
<dd>
|
|
3014
2982
|
|
|
3015
|
-
|
|
2983
|
+
Fetches a paginated list of **Chat** events.
|
|
3016
2984
|
|
|
3017
2985
|
</dd>
|
|
3018
2986
|
</dl>
|
|
@@ -3028,7 +2996,11 @@ Get the request details and state of a given job.
|
|
|
3028
2996
|
<dd>
|
|
3029
2997
|
|
|
3030
2998
|
```typescript
|
|
3031
|
-
await client.
|
|
2999
|
+
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
3000
|
+
pageNumber: 0,
|
|
3001
|
+
pageSize: 3,
|
|
3002
|
+
ascendingOrder: true,
|
|
3003
|
+
});
|
|
3032
3004
|
```
|
|
3033
3005
|
|
|
3034
3006
|
</dd>
|
|
@@ -3044,7 +3016,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3044
3016
|
<dl>
|
|
3045
3017
|
<dd>
|
|
3046
3018
|
|
|
3047
|
-
**id:** `string` —
|
|
3019
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
3048
3020
|
|
|
3049
3021
|
</dd>
|
|
3050
3022
|
</dl>
|
|
@@ -3052,7 +3024,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3052
3024
|
<dl>
|
|
3053
3025
|
<dd>
|
|
3054
3026
|
|
|
3055
|
-
**
|
|
3027
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
3028
|
+
|
|
3029
|
+
</dd>
|
|
3030
|
+
</dl>
|
|
3031
|
+
|
|
3032
|
+
<dl>
|
|
3033
|
+
<dd>
|
|
3034
|
+
|
|
3035
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
3056
3036
|
|
|
3057
3037
|
</dd>
|
|
3058
3038
|
</dl>
|
|
@@ -3063,7 +3043,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3063
3043
|
</dl>
|
|
3064
3044
|
</details>
|
|
3065
3045
|
|
|
3066
|
-
|
|
3046
|
+
## EmpathicVoice ChatGroups
|
|
3047
|
+
|
|
3048
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
3067
3049
|
<dl>
|
|
3068
3050
|
<dd>
|
|
3069
3051
|
|
|
@@ -3075,7 +3057,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3075
3057
|
<dl>
|
|
3076
3058
|
<dd>
|
|
3077
3059
|
|
|
3078
|
-
|
|
3060
|
+
Fetches a paginated list of **Chat Groups**.
|
|
3079
3061
|
|
|
3080
3062
|
</dd>
|
|
3081
3063
|
</dl>
|
|
@@ -3091,7 +3073,12 @@ Get the JSON predictions of a completed inference job.
|
|
|
3091
3073
|
<dd>
|
|
3092
3074
|
|
|
3093
3075
|
```typescript
|
|
3094
|
-
await client.
|
|
3076
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
3077
|
+
pageNumber: 0,
|
|
3078
|
+
pageSize: 1,
|
|
3079
|
+
ascendingOrder: true,
|
|
3080
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
3081
|
+
});
|
|
3095
3082
|
```
|
|
3096
3083
|
|
|
3097
3084
|
</dd>
|
|
@@ -3107,7 +3094,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3107
3094
|
<dl>
|
|
3108
3095
|
<dd>
|
|
3109
3096
|
|
|
3110
|
-
**
|
|
3097
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
3111
3098
|
|
|
3112
3099
|
</dd>
|
|
3113
3100
|
</dl>
|
|
@@ -3115,7 +3102,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3115
3102
|
<dl>
|
|
3116
3103
|
<dd>
|
|
3117
3104
|
|
|
3118
|
-
**requestOptions:** `
|
|
3105
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3119
3106
|
|
|
3120
3107
|
</dd>
|
|
3121
3108
|
</dl>
|
|
@@ -3126,7 +3113,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3126
3113
|
</dl>
|
|
3127
3114
|
</details>
|
|
3128
3115
|
|
|
3129
|
-
<details><summary><code>client.
|
|
3116
|
+
<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>
|
|
3130
3117
|
<dl>
|
|
3131
3118
|
<dd>
|
|
3132
3119
|
|
|
@@ -3138,7 +3125,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3138
3125
|
<dl>
|
|
3139
3126
|
<dd>
|
|
3140
3127
|
|
|
3141
|
-
|
|
3128
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
3142
3129
|
|
|
3143
3130
|
</dd>
|
|
3144
3131
|
</dl>
|
|
@@ -3154,7 +3141,11 @@ Get the artifacts ZIP of a completed inference job.
|
|
|
3154
3141
|
<dd>
|
|
3155
3142
|
|
|
3156
3143
|
```typescript
|
|
3157
|
-
await client.
|
|
3144
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3145
|
+
pageNumber: 0,
|
|
3146
|
+
pageSize: 1,
|
|
3147
|
+
ascendingOrder: true,
|
|
3148
|
+
});
|
|
3158
3149
|
```
|
|
3159
3150
|
|
|
3160
3151
|
</dd>
|
|
@@ -3170,7 +3161,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
3170
3161
|
<dl>
|
|
3171
3162
|
<dd>
|
|
3172
3163
|
|
|
3173
|
-
**id:** `string` —
|
|
3164
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3174
3165
|
|
|
3175
3166
|
</dd>
|
|
3176
3167
|
</dl>
|
|
@@ -3178,7 +3169,15 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
3178
3169
|
<dl>
|
|
3179
3170
|
<dd>
|
|
3180
3171
|
|
|
3181
|
-
**
|
|
3172
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3173
|
+
|
|
3174
|
+
</dd>
|
|
3175
|
+
</dl>
|
|
3176
|
+
|
|
3177
|
+
<dl>
|
|
3178
|
+
<dd>
|
|
3179
|
+
|
|
3180
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3182
3181
|
|
|
3183
3182
|
</dd>
|
|
3184
3183
|
</dl>
|
|
@@ -3189,7 +3188,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
3189
3188
|
</dl>
|
|
3190
3189
|
</details>
|
|
3191
3190
|
|
|
3192
|
-
<details><summary><code>client.
|
|
3191
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents</code></summary>
|
|
3193
3192
|
<dl>
|
|
3194
3193
|
<dd>
|
|
3195
3194
|
|
|
@@ -3201,7 +3200,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
3201
3200
|
<dl>
|
|
3202
3201
|
<dd>
|
|
3203
3202
|
|
|
3204
|
-
|
|
3203
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
3205
3204
|
|
|
3206
3205
|
</dd>
|
|
3207
3206
|
</dl>
|
|
@@ -3217,10 +3216,11 @@ Start a new batch inference job.
|
|
|
3217
3216
|
<dd>
|
|
3218
3217
|
|
|
3219
3218
|
```typescript
|
|
3220
|
-
await client.
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
|
|
3219
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3220
|
+
pageNumber: 0,
|
|
3221
|
+
pageSize: 3,
|
|
3222
|
+
ascendingOrder: true,
|
|
3223
|
+
});
|
|
3224
3224
|
```
|
|
3225
3225
|
|
|
3226
3226
|
</dd>
|
|
@@ -3236,7 +3236,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3236
3236
|
<dl>
|
|
3237
3237
|
<dd>
|
|
3238
3238
|
|
|
3239
|
-
**
|
|
3239
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3240
3240
|
|
|
3241
3241
|
</dd>
|
|
3242
3242
|
</dl>
|
|
@@ -3244,7 +3244,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3244
3244
|
<dl>
|
|
3245
3245
|
<dd>
|
|
3246
3246
|
|
|
3247
|
-
**request:** `Hume.
|
|
3247
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3248
3248
|
|
|
3249
3249
|
</dd>
|
|
3250
3250
|
</dl>
|
|
@@ -3252,7 +3252,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3252
3252
|
<dl>
|
|
3253
3253
|
<dd>
|
|
3254
3254
|
|
|
3255
|
-
**requestOptions:** `
|
|
3255
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3256
3256
|
|
|
3257
3257
|
</dd>
|
|
3258
3258
|
</dl>
|