hume 0.8.1-beta2 → 0.8.1-beta4
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/.mock/definition/empathic-voice/chat.yml +81 -4
- package/Client.d.ts +3 -3
- package/Client.js +6 -6
- package/api/resources/empathicVoice/client/index.d.ts +1 -0
- package/api/resources/empathicVoice/client/index.js +2 -0
- package/api/resources/empathicVoice/index.d.ts +1 -0
- package/api/resources/empathicVoice/index.js +1 -0
- package/api/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/dist/Client.d.ts +3 -3
- package/dist/Client.js +6 -6
- package/dist/api/resources/empathicVoice/client/index.d.ts +1 -0
- package/dist/api/resources/empathicVoice/client/index.js +2 -0
- package/dist/api/resources/empathicVoice/index.d.ts +1 -0
- package/dist/api/resources/empathicVoice/index.js +1 -0
- package/dist/api/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/AssistantEnd.js +1 -1
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/wrapper/checkForAudioTracks.d.ts +8 -0
- package/dist/wrapper/checkForAudioTracks.js +24 -0
- package/dist/wrapper/index.d.ts +1 -0
- package/dist/wrapper/index.js +3 -1
- package/package.json +1 -1
- package/reference.md +444 -444
- package/serialization/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/AssistantEnd.js +1 -1
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/wrapper/checkForAudioTracks.d.ts +8 -0
- package/wrapper/checkForAudioTracks.js +24 -0
- package/wrapper/index.d.ts +1 -0
- package/wrapper/index.js +3 -1
package/reference.md
CHANGED
|
@@ -1,37 +1,12 @@
|
|
|
1
|
-
##
|
|
2
|
-
|
|
3
|
-
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> Hume.ReturnPagedUserDefinedTools</code> </summary>
|
|
4
|
-
|
|
5
|
-
<dl>
|
|
6
|
-
|
|
7
|
-
<dd>
|
|
8
|
-
|
|
9
|
-
#### 🔌 Usage
|
|
10
|
-
|
|
11
|
-
<dl>
|
|
1
|
+
## ExpressionMeasurement Batch
|
|
12
2
|
|
|
13
|
-
<
|
|
3
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code> </summary>
|
|
14
4
|
|
|
15
5
|
<dl>
|
|
16
6
|
|
|
17
7
|
<dd>
|
|
18
8
|
|
|
19
|
-
|
|
20
|
-
await client.empathicVoice.tools.listTools({
|
|
21
|
-
pageNumber: 0,
|
|
22
|
-
pageSize: 2,
|
|
23
|
-
});
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
</dd>
|
|
27
|
-
|
|
28
|
-
</dl>
|
|
29
|
-
|
|
30
|
-
</dd>
|
|
31
|
-
|
|
32
|
-
</dl>
|
|
33
|
-
|
|
34
|
-
#### ⚙️ Parameters
|
|
9
|
+
#### 📝 Description
|
|
35
10
|
|
|
36
11
|
<dl>
|
|
37
12
|
|
|
@@ -41,21 +16,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
41
16
|
|
|
42
17
|
<dd>
|
|
43
18
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</dd>
|
|
47
|
-
|
|
48
|
-
</dl>
|
|
49
|
-
|
|
50
|
-
<dl>
|
|
51
|
-
|
|
52
|
-
<dd>
|
|
53
|
-
|
|
54
|
-
**requestOptions: `Tools.RequestOptions`**
|
|
55
|
-
|
|
56
|
-
</dd>
|
|
57
|
-
|
|
58
|
-
</dl>
|
|
19
|
+
Sort and filter jobs.
|
|
59
20
|
|
|
60
21
|
</dd>
|
|
61
22
|
|
|
@@ -64,13 +25,6 @@ await client.empathicVoice.tools.listTools({
|
|
|
64
25
|
</dd>
|
|
65
26
|
|
|
66
27
|
</dl>
|
|
67
|
-
</details>
|
|
68
|
-
|
|
69
|
-
<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>
|
|
70
|
-
|
|
71
|
-
<dl>
|
|
72
|
-
|
|
73
|
-
<dd>
|
|
74
28
|
|
|
75
29
|
#### 🔌 Usage
|
|
76
30
|
|
|
@@ -83,14 +37,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
83
37
|
<dd>
|
|
84
38
|
|
|
85
39
|
```ts
|
|
86
|
-
await client.
|
|
87
|
-
name: "get_current_weather",
|
|
88
|
-
parameters:
|
|
89
|
-
'{ "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"] }',
|
|
90
|
-
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
91
|
-
description: "This tool is for getting the current weather.",
|
|
92
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
93
|
-
});
|
|
40
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
94
41
|
```
|
|
95
42
|
|
|
96
43
|
</dd>
|
|
@@ -111,7 +58,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
111
58
|
|
|
112
59
|
<dd>
|
|
113
60
|
|
|
114
|
-
**request: `Hume.
|
|
61
|
+
**request: `Hume.expressionMeasurement.BatchListJobsRequest`**
|
|
115
62
|
|
|
116
63
|
</dd>
|
|
117
64
|
|
|
@@ -121,7 +68,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
121
68
|
|
|
122
69
|
<dd>
|
|
123
70
|
|
|
124
|
-
**requestOptions: `
|
|
71
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
125
72
|
|
|
126
73
|
</dd>
|
|
127
74
|
|
|
@@ -136,13 +83,13 @@ await client.empathicVoice.tools.createTool({
|
|
|
136
83
|
</dl>
|
|
137
84
|
</details>
|
|
138
85
|
|
|
139
|
-
<details><summary> <code>client.
|
|
86
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code> </summary>
|
|
140
87
|
|
|
141
88
|
<dl>
|
|
142
89
|
|
|
143
90
|
<dd>
|
|
144
91
|
|
|
145
|
-
####
|
|
92
|
+
#### 📝 Description
|
|
146
93
|
|
|
147
94
|
<dl>
|
|
148
95
|
|
|
@@ -152,9 +99,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
152
99
|
|
|
153
100
|
<dd>
|
|
154
101
|
|
|
155
|
-
|
|
156
|
-
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
157
|
-
```
|
|
102
|
+
Start a new measurement inference job.
|
|
158
103
|
|
|
159
104
|
</dd>
|
|
160
105
|
|
|
@@ -164,7 +109,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
164
109
|
|
|
165
110
|
</dl>
|
|
166
111
|
|
|
167
|
-
####
|
|
112
|
+
#### 🔌 Usage
|
|
168
113
|
|
|
169
114
|
<dl>
|
|
170
115
|
|
|
@@ -174,17 +119,32 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
174
119
|
|
|
175
120
|
<dd>
|
|
176
121
|
|
|
177
|
-
|
|
122
|
+
```ts
|
|
123
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
124
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
125
|
+
notify: true,
|
|
126
|
+
});
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
</dd>
|
|
130
|
+
|
|
131
|
+
</dl>
|
|
178
132
|
|
|
179
133
|
</dd>
|
|
180
134
|
|
|
181
135
|
</dl>
|
|
182
136
|
|
|
137
|
+
#### ⚙️ Parameters
|
|
138
|
+
|
|
183
139
|
<dl>
|
|
184
140
|
|
|
185
141
|
<dd>
|
|
186
142
|
|
|
187
|
-
|
|
143
|
+
<dl>
|
|
144
|
+
|
|
145
|
+
<dd>
|
|
146
|
+
|
|
147
|
+
**request: `Hume.InferenceBaseRequest`**
|
|
188
148
|
|
|
189
149
|
</dd>
|
|
190
150
|
|
|
@@ -194,7 +154,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
194
154
|
|
|
195
155
|
<dd>
|
|
196
156
|
|
|
197
|
-
**requestOptions: `
|
|
157
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
198
158
|
|
|
199
159
|
</dd>
|
|
200
160
|
|
|
@@ -209,13 +169,13 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
209
169
|
</dl>
|
|
210
170
|
</details>
|
|
211
171
|
|
|
212
|
-
<details><summary> <code>client.
|
|
172
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code> </summary>
|
|
213
173
|
|
|
214
174
|
<dl>
|
|
215
175
|
|
|
216
176
|
<dd>
|
|
217
177
|
|
|
218
|
-
####
|
|
178
|
+
#### 📝 Description
|
|
219
179
|
|
|
220
180
|
<dl>
|
|
221
181
|
|
|
@@ -225,15 +185,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
225
185
|
|
|
226
186
|
<dd>
|
|
227
187
|
|
|
228
|
-
|
|
229
|
-
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
230
|
-
parameters:
|
|
231
|
-
'{ "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"] }',
|
|
232
|
-
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
233
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
234
|
-
description: "This tool is for getting the current weather.",
|
|
235
|
-
});
|
|
236
|
-
```
|
|
188
|
+
Get the request details and state of a given job.
|
|
237
189
|
|
|
238
190
|
</dd>
|
|
239
191
|
|
|
@@ -243,7 +195,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
243
195
|
|
|
244
196
|
</dl>
|
|
245
197
|
|
|
246
|
-
####
|
|
198
|
+
#### 🔌 Usage
|
|
247
199
|
|
|
248
200
|
<dl>
|
|
249
201
|
|
|
@@ -253,17 +205,29 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
253
205
|
|
|
254
206
|
<dd>
|
|
255
207
|
|
|
256
|
-
|
|
208
|
+
```ts
|
|
209
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
210
|
+
```
|
|
257
211
|
|
|
258
212
|
</dd>
|
|
259
213
|
|
|
260
214
|
</dl>
|
|
261
215
|
|
|
216
|
+
</dd>
|
|
217
|
+
|
|
218
|
+
</dl>
|
|
219
|
+
|
|
220
|
+
#### ⚙️ Parameters
|
|
221
|
+
|
|
262
222
|
<dl>
|
|
263
223
|
|
|
264
224
|
<dd>
|
|
265
225
|
|
|
266
|
-
|
|
226
|
+
<dl>
|
|
227
|
+
|
|
228
|
+
<dd>
|
|
229
|
+
|
|
230
|
+
**id: `string`**
|
|
267
231
|
|
|
268
232
|
</dd>
|
|
269
233
|
|
|
@@ -273,7 +237,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
273
237
|
|
|
274
238
|
<dd>
|
|
275
239
|
|
|
276
|
-
**requestOptions: `
|
|
240
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
277
241
|
|
|
278
242
|
</dd>
|
|
279
243
|
|
|
@@ -288,12 +252,32 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
288
252
|
</dl>
|
|
289
253
|
</details>
|
|
290
254
|
|
|
291
|
-
<details><summary> <code>client.
|
|
255
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code> </summary>
|
|
256
|
+
|
|
257
|
+
<dl>
|
|
258
|
+
|
|
259
|
+
<dd>
|
|
260
|
+
|
|
261
|
+
#### 📝 Description
|
|
262
|
+
|
|
263
|
+
<dl>
|
|
264
|
+
|
|
265
|
+
<dd>
|
|
292
266
|
|
|
293
267
|
<dl>
|
|
294
268
|
|
|
295
269
|
<dd>
|
|
296
270
|
|
|
271
|
+
Get the request details and state of a given job.
|
|
272
|
+
|
|
273
|
+
</dd>
|
|
274
|
+
|
|
275
|
+
</dl>
|
|
276
|
+
|
|
277
|
+
</dd>
|
|
278
|
+
|
|
279
|
+
</dl>
|
|
280
|
+
|
|
297
281
|
#### 🔌 Usage
|
|
298
282
|
|
|
299
283
|
<dl>
|
|
@@ -305,7 +289,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
305
289
|
<dd>
|
|
306
290
|
|
|
307
291
|
```ts
|
|
308
|
-
await client.
|
|
292
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
309
293
|
```
|
|
310
294
|
|
|
311
295
|
</dd>
|
|
@@ -326,7 +310,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
326
310
|
|
|
327
311
|
<dd>
|
|
328
312
|
|
|
329
|
-
**id: `string`**
|
|
313
|
+
**id: `string`**
|
|
330
314
|
|
|
331
315
|
</dd>
|
|
332
316
|
|
|
@@ -336,7 +320,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
336
320
|
|
|
337
321
|
<dd>
|
|
338
322
|
|
|
339
|
-
**requestOptions: `
|
|
323
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
340
324
|
|
|
341
325
|
</dd>
|
|
342
326
|
|
|
@@ -351,13 +335,13 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
351
335
|
</dl>
|
|
352
336
|
</details>
|
|
353
337
|
|
|
354
|
-
<details><summary> <code>client.
|
|
338
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code> </summary>
|
|
355
339
|
|
|
356
340
|
<dl>
|
|
357
341
|
|
|
358
342
|
<dd>
|
|
359
343
|
|
|
360
|
-
####
|
|
344
|
+
#### 📝 Description
|
|
361
345
|
|
|
362
346
|
<dl>
|
|
363
347
|
|
|
@@ -367,11 +351,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
367
351
|
|
|
368
352
|
<dd>
|
|
369
353
|
|
|
370
|
-
|
|
371
|
-
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
372
|
-
name: "get_current_temperature",
|
|
373
|
-
});
|
|
374
|
-
```
|
|
354
|
+
Get the JSON predictions of a completed measurement or custom models inference job.
|
|
375
355
|
|
|
376
356
|
</dd>
|
|
377
357
|
|
|
@@ -381,7 +361,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
381
361
|
|
|
382
362
|
</dl>
|
|
383
363
|
|
|
384
|
-
####
|
|
364
|
+
#### 🔌 Usage
|
|
385
365
|
|
|
386
366
|
<dl>
|
|
387
367
|
|
|
@@ -391,17 +371,29 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
391
371
|
|
|
392
372
|
<dd>
|
|
393
373
|
|
|
394
|
-
|
|
374
|
+
```ts
|
|
375
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
376
|
+
```
|
|
395
377
|
|
|
396
378
|
</dd>
|
|
397
379
|
|
|
398
380
|
</dl>
|
|
399
381
|
|
|
382
|
+
</dd>
|
|
383
|
+
|
|
384
|
+
</dl>
|
|
385
|
+
|
|
386
|
+
#### ⚙️ Parameters
|
|
387
|
+
|
|
400
388
|
<dl>
|
|
401
389
|
|
|
402
390
|
<dd>
|
|
403
391
|
|
|
404
|
-
|
|
392
|
+
<dl>
|
|
393
|
+
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
396
|
+
**id: `string`**
|
|
405
397
|
|
|
406
398
|
</dd>
|
|
407
399
|
|
|
@@ -411,7 +403,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
411
403
|
|
|
412
404
|
<dd>
|
|
413
405
|
|
|
414
|
-
**requestOptions: `
|
|
406
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
415
407
|
|
|
416
408
|
</dd>
|
|
417
409
|
|
|
@@ -426,13 +418,13 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
426
418
|
</dl>
|
|
427
419
|
</details>
|
|
428
420
|
|
|
429
|
-
<details><summary> <code>client.
|
|
421
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobArtifacts</a>(id) -> stream.Readable</code> </summary>
|
|
430
422
|
|
|
431
423
|
<dl>
|
|
432
424
|
|
|
433
425
|
<dd>
|
|
434
426
|
|
|
435
|
-
####
|
|
427
|
+
#### 📝 Description
|
|
436
428
|
|
|
437
429
|
<dl>
|
|
438
430
|
|
|
@@ -442,9 +434,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
442
434
|
|
|
443
435
|
<dd>
|
|
444
436
|
|
|
445
|
-
|
|
446
|
-
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
447
|
-
```
|
|
437
|
+
Get the artifacts ZIP of a completed measurement or custom models inference job.
|
|
448
438
|
|
|
449
439
|
</dd>
|
|
450
440
|
|
|
@@ -454,7 +444,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
454
444
|
|
|
455
445
|
</dl>
|
|
456
446
|
|
|
457
|
-
####
|
|
447
|
+
#### 🔌 Usage
|
|
458
448
|
|
|
459
449
|
<dl>
|
|
460
450
|
|
|
@@ -464,17 +454,29 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
464
454
|
|
|
465
455
|
<dd>
|
|
466
456
|
|
|
467
|
-
|
|
457
|
+
```ts
|
|
458
|
+
await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
</dd>
|
|
462
|
+
|
|
463
|
+
</dl>
|
|
468
464
|
|
|
469
465
|
</dd>
|
|
470
466
|
|
|
471
467
|
</dl>
|
|
472
468
|
|
|
469
|
+
#### ⚙️ Parameters
|
|
470
|
+
|
|
473
471
|
<dl>
|
|
474
472
|
|
|
475
473
|
<dd>
|
|
476
474
|
|
|
477
|
-
|
|
475
|
+
<dl>
|
|
476
|
+
|
|
477
|
+
<dd>
|
|
478
|
+
|
|
479
|
+
**id: `string`**
|
|
478
480
|
|
|
479
481
|
</dd>
|
|
480
482
|
|
|
@@ -484,7 +486,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
484
486
|
|
|
485
487
|
<dd>
|
|
486
488
|
|
|
487
|
-
**requestOptions: `
|
|
489
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
488
490
|
|
|
489
491
|
</dd>
|
|
490
492
|
|
|
@@ -499,12 +501,32 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
499
501
|
</dl>
|
|
500
502
|
</details>
|
|
501
503
|
|
|
502
|
-
<details><summary> <code>client.
|
|
504
|
+
<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>
|
|
503
505
|
|
|
504
506
|
<dl>
|
|
505
507
|
|
|
506
508
|
<dd>
|
|
507
509
|
|
|
510
|
+
#### 📝 Description
|
|
511
|
+
|
|
512
|
+
<dl>
|
|
513
|
+
|
|
514
|
+
<dd>
|
|
515
|
+
|
|
516
|
+
<dl>
|
|
517
|
+
|
|
518
|
+
<dd>
|
|
519
|
+
|
|
520
|
+
Start a new batch inference job.
|
|
521
|
+
|
|
522
|
+
</dd>
|
|
523
|
+
|
|
524
|
+
</dl>
|
|
525
|
+
|
|
526
|
+
</dd>
|
|
527
|
+
|
|
528
|
+
</dl>
|
|
529
|
+
|
|
508
530
|
#### 🔌 Usage
|
|
509
531
|
|
|
510
532
|
<dl>
|
|
@@ -516,7 +538,10 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
516
538
|
<dd>
|
|
517
539
|
|
|
518
540
|
```ts
|
|
519
|
-
await client.
|
|
541
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
542
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
543
|
+
{}
|
|
544
|
+
);
|
|
520
545
|
```
|
|
521
546
|
|
|
522
547
|
</dd>
|
|
@@ -537,7 +562,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
537
562
|
|
|
538
563
|
<dd>
|
|
539
564
|
|
|
540
|
-
**
|
|
565
|
+
**file: `File[] | fs.ReadStream[]`**
|
|
541
566
|
|
|
542
567
|
</dd>
|
|
543
568
|
|
|
@@ -547,7 +572,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
547
572
|
|
|
548
573
|
<dd>
|
|
549
574
|
|
|
550
|
-
**
|
|
575
|
+
**request: `Hume.expressionMeasurement.BatchStartInferenceJobFromLocalFileRequest`**
|
|
551
576
|
|
|
552
577
|
</dd>
|
|
553
578
|
|
|
@@ -557,7 +582,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
557
582
|
|
|
558
583
|
<dd>
|
|
559
584
|
|
|
560
|
-
**requestOptions: `
|
|
585
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
561
586
|
|
|
562
587
|
</dd>
|
|
563
588
|
|
|
@@ -572,7 +597,9 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
572
597
|
</dl>
|
|
573
598
|
</details>
|
|
574
599
|
|
|
575
|
-
|
|
600
|
+
## EmpathicVoice Tools
|
|
601
|
+
|
|
602
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> Hume.ReturnPagedUserDefinedTools</code> </summary>
|
|
576
603
|
|
|
577
604
|
<dl>
|
|
578
605
|
|
|
@@ -589,9 +616,9 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
589
616
|
<dd>
|
|
590
617
|
|
|
591
618
|
```ts
|
|
592
|
-
await client.empathicVoice.tools.
|
|
593
|
-
|
|
594
|
-
|
|
619
|
+
await client.empathicVoice.tools.listTools({
|
|
620
|
+
pageNumber: 0,
|
|
621
|
+
pageSize: 2,
|
|
595
622
|
});
|
|
596
623
|
```
|
|
597
624
|
|
|
@@ -613,27 +640,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
613
640
|
|
|
614
641
|
<dd>
|
|
615
642
|
|
|
616
|
-
**
|
|
617
|
-
|
|
618
|
-
</dd>
|
|
619
|
-
|
|
620
|
-
</dl>
|
|
621
|
-
|
|
622
|
-
<dl>
|
|
623
|
-
|
|
624
|
-
<dd>
|
|
625
|
-
|
|
626
|
-
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
627
|
-
|
|
628
|
-
</dd>
|
|
629
|
-
|
|
630
|
-
</dl>
|
|
631
|
-
|
|
632
|
-
<dl>
|
|
633
|
-
|
|
634
|
-
<dd>
|
|
635
|
-
|
|
636
|
-
**request: `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`**
|
|
643
|
+
**request: `Hume.empathicVoice.ToolsListToolsRequest`**
|
|
637
644
|
|
|
638
645
|
</dd>
|
|
639
646
|
|
|
@@ -658,9 +665,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
658
665
|
</dl>
|
|
659
666
|
</details>
|
|
660
667
|
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> Hume.ReturnPagedPrompts</code> </summary>
|
|
668
|
+
<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>
|
|
664
669
|
|
|
665
670
|
<dl>
|
|
666
671
|
|
|
@@ -677,7 +682,14 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
677
682
|
<dd>
|
|
678
683
|
|
|
679
684
|
```ts
|
|
680
|
-
await client.empathicVoice.
|
|
685
|
+
await client.empathicVoice.tools.createTool({
|
|
686
|
+
name: "get_current_weather",
|
|
687
|
+
parameters:
|
|
688
|
+
'{ "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"] }',
|
|
689
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
690
|
+
description: "This tool is for getting the current weather.",
|
|
691
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
692
|
+
});
|
|
681
693
|
```
|
|
682
694
|
|
|
683
695
|
</dd>
|
|
@@ -698,7 +710,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
698
710
|
|
|
699
711
|
<dd>
|
|
700
712
|
|
|
701
|
-
**request: `Hume.empathicVoice.
|
|
713
|
+
**request: `Hume.empathicVoice.PostedUserDefinedTool`**
|
|
702
714
|
|
|
703
715
|
</dd>
|
|
704
716
|
|
|
@@ -708,7 +720,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
708
720
|
|
|
709
721
|
<dd>
|
|
710
722
|
|
|
711
|
-
**requestOptions: `
|
|
723
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
712
724
|
|
|
713
725
|
</dd>
|
|
714
726
|
|
|
@@ -723,7 +735,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
723
735
|
</dl>
|
|
724
736
|
</details>
|
|
725
737
|
|
|
726
|
-
<details><summary> <code>client.empathicVoice.
|
|
738
|
+
<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>
|
|
727
739
|
|
|
728
740
|
<dl>
|
|
729
741
|
|
|
@@ -740,10 +752,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
740
752
|
<dd>
|
|
741
753
|
|
|
742
754
|
```ts
|
|
743
|
-
await client.empathicVoice.
|
|
744
|
-
name: "name",
|
|
745
|
-
text: "text",
|
|
746
|
-
});
|
|
755
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
747
756
|
```
|
|
748
757
|
|
|
749
758
|
</dd>
|
|
@@ -764,7 +773,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
764
773
|
|
|
765
774
|
<dd>
|
|
766
775
|
|
|
767
|
-
**
|
|
776
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
768
777
|
|
|
769
778
|
</dd>
|
|
770
779
|
|
|
@@ -774,7 +783,17 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
774
783
|
|
|
775
784
|
<dd>
|
|
776
785
|
|
|
777
|
-
**
|
|
786
|
+
**request: `Hume.empathicVoice.ToolsListToolVersionsRequest`**
|
|
787
|
+
|
|
788
|
+
</dd>
|
|
789
|
+
|
|
790
|
+
</dl>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
|
|
794
|
+
<dd>
|
|
795
|
+
|
|
796
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
778
797
|
|
|
779
798
|
</dd>
|
|
780
799
|
|
|
@@ -789,7 +808,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
789
808
|
</dl>
|
|
790
809
|
</details>
|
|
791
810
|
|
|
792
|
-
<details><summary> <code>client.empathicVoice.
|
|
811
|
+
<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>
|
|
793
812
|
|
|
794
813
|
<dl>
|
|
795
814
|
|
|
@@ -806,7 +825,13 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
806
825
|
<dd>
|
|
807
826
|
|
|
808
827
|
```ts
|
|
809
|
-
await client.empathicVoice.
|
|
828
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
829
|
+
parameters:
|
|
830
|
+
'{ "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"] }',
|
|
831
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
832
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
833
|
+
description: "This tool is for getting the current weather.",
|
|
834
|
+
});
|
|
810
835
|
```
|
|
811
836
|
|
|
812
837
|
</dd>
|
|
@@ -837,7 +862,7 @@ await client.empathicVoice.prompts.listPromptVersions("id");
|
|
|
837
862
|
|
|
838
863
|
<dd>
|
|
839
864
|
|
|
840
|
-
**request: `Hume.empathicVoice.
|
|
865
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolVersion`**
|
|
841
866
|
|
|
842
867
|
</dd>
|
|
843
868
|
|
|
@@ -847,7 +872,7 @@ await client.empathicVoice.prompts.listPromptVersions("id");
|
|
|
847
872
|
|
|
848
873
|
<dd>
|
|
849
874
|
|
|
850
|
-
**requestOptions: `
|
|
875
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
851
876
|
|
|
852
877
|
</dd>
|
|
853
878
|
|
|
@@ -862,7 +887,7 @@ await client.empathicVoice.prompts.listPromptVersions("id");
|
|
|
862
887
|
</dl>
|
|
863
888
|
</details>
|
|
864
889
|
|
|
865
|
-
<details><summary> <code>client.empathicVoice.
|
|
890
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code> </summary>
|
|
866
891
|
|
|
867
892
|
<dl>
|
|
868
893
|
|
|
@@ -879,9 +904,7 @@ await client.empathicVoice.prompts.listPromptVersions("id");
|
|
|
879
904
|
<dd>
|
|
880
905
|
|
|
881
906
|
```ts
|
|
882
|
-
await client.empathicVoice.
|
|
883
|
-
text: "text",
|
|
884
|
-
});
|
|
907
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
885
908
|
```
|
|
886
909
|
|
|
887
910
|
</dd>
|
|
@@ -902,17 +925,7 @@ await client.empathicVoice.prompts.createPromptVerison("id", {
|
|
|
902
925
|
|
|
903
926
|
<dd>
|
|
904
927
|
|
|
905
|
-
**id: `string`** — Identifier for a
|
|
906
|
-
|
|
907
|
-
</dd>
|
|
908
|
-
|
|
909
|
-
</dl>
|
|
910
|
-
|
|
911
|
-
<dl>
|
|
912
|
-
|
|
913
|
-
<dd>
|
|
914
|
-
|
|
915
|
-
**request: `Hume.empathicVoice.PostedPromptVersion`**
|
|
928
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
916
929
|
|
|
917
930
|
</dd>
|
|
918
931
|
|
|
@@ -922,7 +935,7 @@ await client.empathicVoice.prompts.createPromptVerison("id", {
|
|
|
922
935
|
|
|
923
936
|
<dd>
|
|
924
937
|
|
|
925
|
-
**requestOptions: `
|
|
938
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
926
939
|
|
|
927
940
|
</dd>
|
|
928
941
|
|
|
@@ -937,7 +950,7 @@ await client.empathicVoice.prompts.createPromptVerison("id", {
|
|
|
937
950
|
</dl>
|
|
938
951
|
</details>
|
|
939
952
|
|
|
940
|
-
<details><summary> <code>client.empathicVoice.
|
|
953
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code> </summary>
|
|
941
954
|
|
|
942
955
|
<dl>
|
|
943
956
|
|
|
@@ -954,7 +967,9 @@ await client.empathicVoice.prompts.createPromptVerison("id", {
|
|
|
954
967
|
<dd>
|
|
955
968
|
|
|
956
969
|
```ts
|
|
957
|
-
await client.empathicVoice.
|
|
970
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
971
|
+
name: "get_current_temperature",
|
|
972
|
+
});
|
|
958
973
|
```
|
|
959
974
|
|
|
960
975
|
</dd>
|
|
@@ -975,7 +990,7 @@ await client.empathicVoice.prompts.deletePrompt("id");
|
|
|
975
990
|
|
|
976
991
|
<dd>
|
|
977
992
|
|
|
978
|
-
**id: `string`** — Identifier for a
|
|
993
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
979
994
|
|
|
980
995
|
</dd>
|
|
981
996
|
|
|
@@ -985,7 +1000,17 @@ await client.empathicVoice.prompts.deletePrompt("id");
|
|
|
985
1000
|
|
|
986
1001
|
<dd>
|
|
987
1002
|
|
|
988
|
-
**
|
|
1003
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolName`**
|
|
1004
|
+
|
|
1005
|
+
</dd>
|
|
1006
|
+
|
|
1007
|
+
</dl>
|
|
1008
|
+
|
|
1009
|
+
<dl>
|
|
1010
|
+
|
|
1011
|
+
<dd>
|
|
1012
|
+
|
|
1013
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
989
1014
|
|
|
990
1015
|
</dd>
|
|
991
1016
|
|
|
@@ -1000,7 +1025,7 @@ await client.empathicVoice.prompts.deletePrompt("id");
|
|
|
1000
1025
|
</dl>
|
|
1001
1026
|
</details>
|
|
1002
1027
|
|
|
1003
|
-
<details><summary> <code>client.empathicVoice.
|
|
1028
|
+
<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>
|
|
1004
1029
|
|
|
1005
1030
|
<dl>
|
|
1006
1031
|
|
|
@@ -1017,9 +1042,7 @@ await client.empathicVoice.prompts.deletePrompt("id");
|
|
|
1017
1042
|
<dd>
|
|
1018
1043
|
|
|
1019
1044
|
```ts
|
|
1020
|
-
await client.empathicVoice.
|
|
1021
|
-
name: "string",
|
|
1022
|
-
});
|
|
1045
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1023
1046
|
```
|
|
1024
1047
|
|
|
1025
1048
|
</dd>
|
|
@@ -1040,7 +1063,7 @@ await client.empathicVoice.prompts.updatePromptName("string", {
|
|
|
1040
1063
|
|
|
1041
1064
|
<dd>
|
|
1042
1065
|
|
|
1043
|
-
**id: `string`** — Identifier for a
|
|
1066
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
1044
1067
|
|
|
1045
1068
|
</dd>
|
|
1046
1069
|
|
|
@@ -1050,7 +1073,7 @@ await client.empathicVoice.prompts.updatePromptName("string", {
|
|
|
1050
1073
|
|
|
1051
1074
|
<dd>
|
|
1052
1075
|
|
|
1053
|
-
**
|
|
1076
|
+
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
1054
1077
|
|
|
1055
1078
|
</dd>
|
|
1056
1079
|
|
|
@@ -1060,7 +1083,7 @@ await client.empathicVoice.prompts.updatePromptName("string", {
|
|
|
1060
1083
|
|
|
1061
1084
|
<dd>
|
|
1062
1085
|
|
|
1063
|
-
**requestOptions: `
|
|
1086
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1064
1087
|
|
|
1065
1088
|
</dd>
|
|
1066
1089
|
|
|
@@ -1075,7 +1098,7 @@ await client.empathicVoice.prompts.updatePromptName("string", {
|
|
|
1075
1098
|
</dl>
|
|
1076
1099
|
</details>
|
|
1077
1100
|
|
|
1078
|
-
<details><summary> <code>client.empathicVoice.
|
|
1101
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code> </summary>
|
|
1079
1102
|
|
|
1080
1103
|
<dl>
|
|
1081
1104
|
|
|
@@ -1092,7 +1115,7 @@ await client.empathicVoice.prompts.updatePromptName("string", {
|
|
|
1092
1115
|
<dd>
|
|
1093
1116
|
|
|
1094
1117
|
```ts
|
|
1095
|
-
await client.empathicVoice.
|
|
1118
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1096
1119
|
```
|
|
1097
1120
|
|
|
1098
1121
|
</dd>
|
|
@@ -1113,7 +1136,7 @@ await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
|
1113
1136
|
|
|
1114
1137
|
<dd>
|
|
1115
1138
|
|
|
1116
|
-
**id: `string`** — Identifier for a
|
|
1139
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
1117
1140
|
|
|
1118
1141
|
</dd>
|
|
1119
1142
|
|
|
@@ -1123,7 +1146,7 @@ await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
|
1123
1146
|
|
|
1124
1147
|
<dd>
|
|
1125
1148
|
|
|
1126
|
-
**version: `number`** — Version number for a
|
|
1149
|
+
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
1127
1150
|
|
|
1128
1151
|
</dd>
|
|
1129
1152
|
|
|
@@ -1133,7 +1156,7 @@ await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
|
1133
1156
|
|
|
1134
1157
|
<dd>
|
|
1135
1158
|
|
|
1136
|
-
**requestOptions: `
|
|
1159
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1137
1160
|
|
|
1138
1161
|
</dd>
|
|
1139
1162
|
|
|
@@ -1148,7 +1171,7 @@ await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
|
1148
1171
|
</dl>
|
|
1149
1172
|
</details>
|
|
1150
1173
|
|
|
1151
|
-
<details><summary> <code>client.empathicVoice.
|
|
1174
|
+
<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>
|
|
1152
1175
|
|
|
1153
1176
|
<dl>
|
|
1154
1177
|
|
|
@@ -1165,7 +1188,10 @@ await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
|
1165
1188
|
<dd>
|
|
1166
1189
|
|
|
1167
1190
|
```ts
|
|
1168
|
-
await client.empathicVoice.
|
|
1191
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
1192
|
+
versionDescription:
|
|
1193
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1194
|
+
});
|
|
1169
1195
|
```
|
|
1170
1196
|
|
|
1171
1197
|
</dd>
|
|
@@ -1186,7 +1212,7 @@ await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
|
1186
1212
|
|
|
1187
1213
|
<dd>
|
|
1188
1214
|
|
|
1189
|
-
**id: `string`** — Identifier for a
|
|
1215
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
1190
1216
|
|
|
1191
1217
|
</dd>
|
|
1192
1218
|
|
|
@@ -1196,7 +1222,7 @@ await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
|
1196
1222
|
|
|
1197
1223
|
<dd>
|
|
1198
1224
|
|
|
1199
|
-
**version: `number`** — Version number for a
|
|
1225
|
+
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
1200
1226
|
|
|
1201
1227
|
</dd>
|
|
1202
1228
|
|
|
@@ -1206,7 +1232,17 @@ await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
|
1206
1232
|
|
|
1207
1233
|
<dd>
|
|
1208
1234
|
|
|
1209
|
-
**
|
|
1235
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`**
|
|
1236
|
+
|
|
1237
|
+
</dd>
|
|
1238
|
+
|
|
1239
|
+
</dl>
|
|
1240
|
+
|
|
1241
|
+
<dl>
|
|
1242
|
+
|
|
1243
|
+
<dd>
|
|
1244
|
+
|
|
1245
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1210
1246
|
|
|
1211
1247
|
</dd>
|
|
1212
1248
|
|
|
@@ -1221,7 +1257,9 @@ await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
|
1221
1257
|
</dl>
|
|
1222
1258
|
</details>
|
|
1223
1259
|
|
|
1224
|
-
|
|
1260
|
+
## EmpathicVoice Prompts
|
|
1261
|
+
|
|
1262
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> Hume.ReturnPagedPrompts</code> </summary>
|
|
1225
1263
|
|
|
1226
1264
|
<dl>
|
|
1227
1265
|
|
|
@@ -1238,7 +1276,7 @@ await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
|
1238
1276
|
<dd>
|
|
1239
1277
|
|
|
1240
1278
|
```ts
|
|
1241
|
-
await client.empathicVoice.prompts.
|
|
1279
|
+
await client.empathicVoice.prompts.listPrompts();
|
|
1242
1280
|
```
|
|
1243
1281
|
|
|
1244
1282
|
</dd>
|
|
@@ -1259,27 +1297,7 @@ await client.empathicVoice.prompts.updatePromptDescription("id", 1);
|
|
|
1259
1297
|
|
|
1260
1298
|
<dd>
|
|
1261
1299
|
|
|
1262
|
-
**
|
|
1263
|
-
|
|
1264
|
-
</dd>
|
|
1265
|
-
|
|
1266
|
-
</dl>
|
|
1267
|
-
|
|
1268
|
-
<dl>
|
|
1269
|
-
|
|
1270
|
-
<dd>
|
|
1271
|
-
|
|
1272
|
-
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1273
|
-
|
|
1274
|
-
</dd>
|
|
1275
|
-
|
|
1276
|
-
</dl>
|
|
1277
|
-
|
|
1278
|
-
<dl>
|
|
1279
|
-
|
|
1280
|
-
<dd>
|
|
1281
|
-
|
|
1282
|
-
**request: `Hume.empathicVoice.PostedPromptVersionDescription`**
|
|
1300
|
+
**request: `Hume.empathicVoice.PromptsListPromptsRequest`**
|
|
1283
1301
|
|
|
1284
1302
|
</dd>
|
|
1285
1303
|
|
|
@@ -1304,9 +1322,7 @@ await client.empathicVoice.prompts.updatePromptDescription("id", 1);
|
|
|
1304
1322
|
</dl>
|
|
1305
1323
|
</details>
|
|
1306
1324
|
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code> </summary>
|
|
1325
|
+
<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>
|
|
1310
1326
|
|
|
1311
1327
|
<dl>
|
|
1312
1328
|
|
|
@@ -1323,7 +1339,10 @@ await client.empathicVoice.prompts.updatePromptDescription("id", 1);
|
|
|
1323
1339
|
<dd>
|
|
1324
1340
|
|
|
1325
1341
|
```ts
|
|
1326
|
-
await client.empathicVoice.
|
|
1342
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1343
|
+
name: "name",
|
|
1344
|
+
text: "text",
|
|
1345
|
+
});
|
|
1327
1346
|
```
|
|
1328
1347
|
|
|
1329
1348
|
</dd>
|
|
@@ -1344,7 +1363,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1344
1363
|
|
|
1345
1364
|
<dd>
|
|
1346
1365
|
|
|
1347
|
-
**request: `Hume.empathicVoice.
|
|
1366
|
+
**request: `Hume.empathicVoice.PostedPrompt`**
|
|
1348
1367
|
|
|
1349
1368
|
</dd>
|
|
1350
1369
|
|
|
@@ -1354,7 +1373,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1354
1373
|
|
|
1355
1374
|
<dd>
|
|
1356
1375
|
|
|
1357
|
-
**requestOptions: `
|
|
1376
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1358
1377
|
|
|
1359
1378
|
</dd>
|
|
1360
1379
|
|
|
@@ -1369,7 +1388,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1369
1388
|
</dl>
|
|
1370
1389
|
</details>
|
|
1371
1390
|
|
|
1372
|
-
<details><summary> <code>client.empathicVoice.
|
|
1391
|
+
<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>
|
|
1373
1392
|
|
|
1374
1393
|
<dl>
|
|
1375
1394
|
|
|
@@ -1386,9 +1405,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1386
1405
|
<dd>
|
|
1387
1406
|
|
|
1388
1407
|
```ts
|
|
1389
|
-
await client.empathicVoice.
|
|
1390
|
-
name: "name",
|
|
1391
|
-
});
|
|
1408
|
+
await client.empathicVoice.prompts.listPromptVersions("id");
|
|
1392
1409
|
```
|
|
1393
1410
|
|
|
1394
1411
|
</dd>
|
|
@@ -1409,7 +1426,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1409
1426
|
|
|
1410
1427
|
<dd>
|
|
1411
1428
|
|
|
1412
|
-
**
|
|
1429
|
+
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
1413
1430
|
|
|
1414
1431
|
</dd>
|
|
1415
1432
|
|
|
@@ -1419,7 +1436,17 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1419
1436
|
|
|
1420
1437
|
<dd>
|
|
1421
1438
|
|
|
1422
|
-
**
|
|
1439
|
+
**request: `Hume.empathicVoice.PromptsListPromptVersionsRequest`**
|
|
1440
|
+
|
|
1441
|
+
</dd>
|
|
1442
|
+
|
|
1443
|
+
</dl>
|
|
1444
|
+
|
|
1445
|
+
<dl>
|
|
1446
|
+
|
|
1447
|
+
<dd>
|
|
1448
|
+
|
|
1449
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1423
1450
|
|
|
1424
1451
|
</dd>
|
|
1425
1452
|
|
|
@@ -1434,7 +1461,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1434
1461
|
</dl>
|
|
1435
1462
|
</details>
|
|
1436
1463
|
|
|
1437
|
-
<details><summary> <code>client.empathicVoice.
|
|
1464
|
+
<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>
|
|
1438
1465
|
|
|
1439
1466
|
<dl>
|
|
1440
1467
|
|
|
@@ -1451,7 +1478,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1451
1478
|
<dd>
|
|
1452
1479
|
|
|
1453
1480
|
```ts
|
|
1454
|
-
await client.empathicVoice.
|
|
1481
|
+
await client.empathicVoice.prompts.createPromptVerison("id", {
|
|
1482
|
+
text: "text",
|
|
1483
|
+
});
|
|
1455
1484
|
```
|
|
1456
1485
|
|
|
1457
1486
|
</dd>
|
|
@@ -1472,7 +1501,7 @@ await client.empathicVoice.configs.listConfigVersions("id");
|
|
|
1472
1501
|
|
|
1473
1502
|
<dd>
|
|
1474
1503
|
|
|
1475
|
-
**id: `string`** — Identifier for a
|
|
1504
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1476
1505
|
|
|
1477
1506
|
</dd>
|
|
1478
1507
|
|
|
@@ -1482,7 +1511,7 @@ await client.empathicVoice.configs.listConfigVersions("id");
|
|
|
1482
1511
|
|
|
1483
1512
|
<dd>
|
|
1484
1513
|
|
|
1485
|
-
**request: `Hume.empathicVoice.
|
|
1514
|
+
**request: `Hume.empathicVoice.PostedPromptVersion`**
|
|
1486
1515
|
|
|
1487
1516
|
</dd>
|
|
1488
1517
|
|
|
@@ -1492,7 +1521,7 @@ await client.empathicVoice.configs.listConfigVersions("id");
|
|
|
1492
1521
|
|
|
1493
1522
|
<dd>
|
|
1494
1523
|
|
|
1495
|
-
**requestOptions: `
|
|
1524
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1496
1525
|
|
|
1497
1526
|
</dd>
|
|
1498
1527
|
|
|
@@ -1507,7 +1536,7 @@ await client.empathicVoice.configs.listConfigVersions("id");
|
|
|
1507
1536
|
</dl>
|
|
1508
1537
|
</details>
|
|
1509
1538
|
|
|
1510
|
-
<details><summary> <code>client.empathicVoice.
|
|
1539
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code> </summary>
|
|
1511
1540
|
|
|
1512
1541
|
<dl>
|
|
1513
1542
|
|
|
@@ -1524,7 +1553,7 @@ await client.empathicVoice.configs.listConfigVersions("id");
|
|
|
1524
1553
|
<dd>
|
|
1525
1554
|
|
|
1526
1555
|
```ts
|
|
1527
|
-
await client.empathicVoice.
|
|
1556
|
+
await client.empathicVoice.prompts.deletePrompt("id");
|
|
1528
1557
|
```
|
|
1529
1558
|
|
|
1530
1559
|
</dd>
|
|
@@ -1545,17 +1574,7 @@ await client.empathicVoice.configs.createConfigVersion("id");
|
|
|
1545
1574
|
|
|
1546
1575
|
<dd>
|
|
1547
1576
|
|
|
1548
|
-
**id: `string`** — Identifier for a
|
|
1549
|
-
|
|
1550
|
-
</dd>
|
|
1551
|
-
|
|
1552
|
-
</dl>
|
|
1553
|
-
|
|
1554
|
-
<dl>
|
|
1555
|
-
|
|
1556
|
-
<dd>
|
|
1557
|
-
|
|
1558
|
-
**request: `Hume.empathicVoice.PostedConfigVersion`**
|
|
1577
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1559
1578
|
|
|
1560
1579
|
</dd>
|
|
1561
1580
|
|
|
@@ -1565,7 +1584,7 @@ await client.empathicVoice.configs.createConfigVersion("id");
|
|
|
1565
1584
|
|
|
1566
1585
|
<dd>
|
|
1567
1586
|
|
|
1568
|
-
**requestOptions: `
|
|
1587
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1569
1588
|
|
|
1570
1589
|
</dd>
|
|
1571
1590
|
|
|
@@ -1580,7 +1599,7 @@ await client.empathicVoice.configs.createConfigVersion("id");
|
|
|
1580
1599
|
</dl>
|
|
1581
1600
|
</details>
|
|
1582
1601
|
|
|
1583
|
-
<details><summary> <code>client.empathicVoice.
|
|
1602
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code> </summary>
|
|
1584
1603
|
|
|
1585
1604
|
<dl>
|
|
1586
1605
|
|
|
@@ -1597,7 +1616,9 @@ await client.empathicVoice.configs.createConfigVersion("id");
|
|
|
1597
1616
|
<dd>
|
|
1598
1617
|
|
|
1599
1618
|
```ts
|
|
1600
|
-
await client.empathicVoice.
|
|
1619
|
+
await client.empathicVoice.prompts.updatePromptName("string", {
|
|
1620
|
+
name: "string",
|
|
1621
|
+
});
|
|
1601
1622
|
```
|
|
1602
1623
|
|
|
1603
1624
|
</dd>
|
|
@@ -1618,7 +1639,7 @@ await client.empathicVoice.configs.deleteConfig("id");
|
|
|
1618
1639
|
|
|
1619
1640
|
<dd>
|
|
1620
1641
|
|
|
1621
|
-
**id: `string`** — Identifier for a
|
|
1642
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1622
1643
|
|
|
1623
1644
|
</dd>
|
|
1624
1645
|
|
|
@@ -1628,7 +1649,17 @@ await client.empathicVoice.configs.deleteConfig("id");
|
|
|
1628
1649
|
|
|
1629
1650
|
<dd>
|
|
1630
1651
|
|
|
1631
|
-
**
|
|
1652
|
+
**request: `Hume.empathicVoice.PostedPromptName`**
|
|
1653
|
+
|
|
1654
|
+
</dd>
|
|
1655
|
+
|
|
1656
|
+
</dl>
|
|
1657
|
+
|
|
1658
|
+
<dl>
|
|
1659
|
+
|
|
1660
|
+
<dd>
|
|
1661
|
+
|
|
1662
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1632
1663
|
|
|
1633
1664
|
</dd>
|
|
1634
1665
|
|
|
@@ -1643,7 +1674,7 @@ await client.empathicVoice.configs.deleteConfig("id");
|
|
|
1643
1674
|
</dl>
|
|
1644
1675
|
</details>
|
|
1645
1676
|
|
|
1646
|
-
<details><summary> <code>client.empathicVoice.
|
|
1677
|
+
<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>
|
|
1647
1678
|
|
|
1648
1679
|
<dl>
|
|
1649
1680
|
|
|
@@ -1660,9 +1691,7 @@ await client.empathicVoice.configs.deleteConfig("id");
|
|
|
1660
1691
|
<dd>
|
|
1661
1692
|
|
|
1662
1693
|
```ts
|
|
1663
|
-
await client.empathicVoice.
|
|
1664
|
-
name: "string",
|
|
1665
|
-
});
|
|
1694
|
+
await client.empathicVoice.prompts.getPromptVersion("id", 1);
|
|
1666
1695
|
```
|
|
1667
1696
|
|
|
1668
1697
|
</dd>
|
|
@@ -1683,7 +1712,7 @@ await client.empathicVoice.configs.updateConfigName("string", {
|
|
|
1683
1712
|
|
|
1684
1713
|
<dd>
|
|
1685
1714
|
|
|
1686
|
-
**id: `string`** — Identifier for a
|
|
1715
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1687
1716
|
|
|
1688
1717
|
</dd>
|
|
1689
1718
|
|
|
@@ -1693,7 +1722,7 @@ await client.empathicVoice.configs.updateConfigName("string", {
|
|
|
1693
1722
|
|
|
1694
1723
|
<dd>
|
|
1695
1724
|
|
|
1696
|
-
**
|
|
1725
|
+
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1697
1726
|
|
|
1698
1727
|
</dd>
|
|
1699
1728
|
|
|
@@ -1703,7 +1732,7 @@ await client.empathicVoice.configs.updateConfigName("string", {
|
|
|
1703
1732
|
|
|
1704
1733
|
<dd>
|
|
1705
1734
|
|
|
1706
|
-
**requestOptions: `
|
|
1735
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1707
1736
|
|
|
1708
1737
|
</dd>
|
|
1709
1738
|
|
|
@@ -1718,7 +1747,7 @@ await client.empathicVoice.configs.updateConfigName("string", {
|
|
|
1718
1747
|
</dl>
|
|
1719
1748
|
</details>
|
|
1720
1749
|
|
|
1721
|
-
<details><summary> <code>client.empathicVoice.
|
|
1750
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code> </summary>
|
|
1722
1751
|
|
|
1723
1752
|
<dl>
|
|
1724
1753
|
|
|
@@ -1735,7 +1764,7 @@ await client.empathicVoice.configs.updateConfigName("string", {
|
|
|
1735
1764
|
<dd>
|
|
1736
1765
|
|
|
1737
1766
|
```ts
|
|
1738
|
-
await client.empathicVoice.
|
|
1767
|
+
await client.empathicVoice.prompts.deletePromptVersion("id", 1);
|
|
1739
1768
|
```
|
|
1740
1769
|
|
|
1741
1770
|
</dd>
|
|
@@ -1756,7 +1785,7 @@ await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
|
1756
1785
|
|
|
1757
1786
|
<dd>
|
|
1758
1787
|
|
|
1759
|
-
**id: `string`** — Identifier for a
|
|
1788
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1760
1789
|
|
|
1761
1790
|
</dd>
|
|
1762
1791
|
|
|
@@ -1766,7 +1795,7 @@ await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
|
1766
1795
|
|
|
1767
1796
|
<dd>
|
|
1768
1797
|
|
|
1769
|
-
**version: `number`** — Version number for a
|
|
1798
|
+
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1770
1799
|
|
|
1771
1800
|
</dd>
|
|
1772
1801
|
|
|
@@ -1776,7 +1805,7 @@ await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
|
1776
1805
|
|
|
1777
1806
|
<dd>
|
|
1778
1807
|
|
|
1779
|
-
**requestOptions: `
|
|
1808
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1780
1809
|
|
|
1781
1810
|
</dd>
|
|
1782
1811
|
|
|
@@ -1791,7 +1820,7 @@ await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
|
1791
1820
|
</dl>
|
|
1792
1821
|
</details>
|
|
1793
1822
|
|
|
1794
|
-
<details><summary> <code>client.empathicVoice.
|
|
1823
|
+
<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>
|
|
1795
1824
|
|
|
1796
1825
|
<dl>
|
|
1797
1826
|
|
|
@@ -1808,7 +1837,7 @@ await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
|
1808
1837
|
<dd>
|
|
1809
1838
|
|
|
1810
1839
|
```ts
|
|
1811
|
-
await client.empathicVoice.
|
|
1840
|
+
await client.empathicVoice.prompts.updatePromptDescription("id", 1);
|
|
1812
1841
|
```
|
|
1813
1842
|
|
|
1814
1843
|
</dd>
|
|
@@ -1829,7 +1858,7 @@ await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
|
1829
1858
|
|
|
1830
1859
|
<dd>
|
|
1831
1860
|
|
|
1832
|
-
**id: `string`** — Identifier for a
|
|
1861
|
+
**id: `string`** — Identifier for a prompt. Formatted as a UUID.
|
|
1833
1862
|
|
|
1834
1863
|
</dd>
|
|
1835
1864
|
|
|
@@ -1839,7 +1868,7 @@ await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
|
1839
1868
|
|
|
1840
1869
|
<dd>
|
|
1841
1870
|
|
|
1842
|
-
**version: `number`** — Version number for a
|
|
1871
|
+
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1843
1872
|
|
|
1844
1873
|
</dd>
|
|
1845
1874
|
|
|
@@ -1849,7 +1878,17 @@ await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
|
1849
1878
|
|
|
1850
1879
|
<dd>
|
|
1851
1880
|
|
|
1852
|
-
**
|
|
1881
|
+
**request: `Hume.empathicVoice.PostedPromptVersionDescription`**
|
|
1882
|
+
|
|
1883
|
+
</dd>
|
|
1884
|
+
|
|
1885
|
+
</dl>
|
|
1886
|
+
|
|
1887
|
+
<dl>
|
|
1888
|
+
|
|
1889
|
+
<dd>
|
|
1890
|
+
|
|
1891
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1853
1892
|
|
|
1854
1893
|
</dd>
|
|
1855
1894
|
|
|
@@ -1864,7 +1903,9 @@ await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
|
1864
1903
|
</dl>
|
|
1865
1904
|
</details>
|
|
1866
1905
|
|
|
1867
|
-
|
|
1906
|
+
## EmpathicVoice Configs
|
|
1907
|
+
|
|
1908
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code> </summary>
|
|
1868
1909
|
|
|
1869
1910
|
<dl>
|
|
1870
1911
|
|
|
@@ -1881,7 +1922,7 @@ await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
|
1881
1922
|
<dd>
|
|
1882
1923
|
|
|
1883
1924
|
```ts
|
|
1884
|
-
await client.empathicVoice.configs.
|
|
1925
|
+
await client.empathicVoice.configs.listConfigs();
|
|
1885
1926
|
```
|
|
1886
1927
|
|
|
1887
1928
|
</dd>
|
|
@@ -1902,7 +1943,7 @@ await client.empathicVoice.configs.updateConfigDescription("id", 1);
|
|
|
1902
1943
|
|
|
1903
1944
|
<dd>
|
|
1904
1945
|
|
|
1905
|
-
**
|
|
1946
|
+
**request: `Hume.empathicVoice.ConfigsListConfigsRequest`**
|
|
1906
1947
|
|
|
1907
1948
|
</dd>
|
|
1908
1949
|
|
|
@@ -1912,17 +1953,62 @@ await client.empathicVoice.configs.updateConfigDescription("id", 1);
|
|
|
1912
1953
|
|
|
1913
1954
|
<dd>
|
|
1914
1955
|
|
|
1915
|
-
**
|
|
1956
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
1957
|
+
|
|
1958
|
+
</dd>
|
|
1959
|
+
|
|
1960
|
+
</dl>
|
|
1961
|
+
|
|
1962
|
+
</dd>
|
|
1963
|
+
|
|
1964
|
+
</dl>
|
|
1916
1965
|
|
|
1917
1966
|
</dd>
|
|
1918
1967
|
|
|
1919
1968
|
</dl>
|
|
1969
|
+
</details>
|
|
1970
|
+
|
|
1971
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code> </summary>
|
|
1920
1972
|
|
|
1921
1973
|
<dl>
|
|
1922
1974
|
|
|
1923
1975
|
<dd>
|
|
1924
1976
|
|
|
1925
|
-
|
|
1977
|
+
#### 🔌 Usage
|
|
1978
|
+
|
|
1979
|
+
<dl>
|
|
1980
|
+
|
|
1981
|
+
<dd>
|
|
1982
|
+
|
|
1983
|
+
<dl>
|
|
1984
|
+
|
|
1985
|
+
<dd>
|
|
1986
|
+
|
|
1987
|
+
```ts
|
|
1988
|
+
await client.empathicVoice.configs.createConfig({
|
|
1989
|
+
name: "name",
|
|
1990
|
+
});
|
|
1991
|
+
```
|
|
1992
|
+
|
|
1993
|
+
</dd>
|
|
1994
|
+
|
|
1995
|
+
</dl>
|
|
1996
|
+
|
|
1997
|
+
</dd>
|
|
1998
|
+
|
|
1999
|
+
</dl>
|
|
2000
|
+
|
|
2001
|
+
#### ⚙️ Parameters
|
|
2002
|
+
|
|
2003
|
+
<dl>
|
|
2004
|
+
|
|
2005
|
+
<dd>
|
|
2006
|
+
|
|
2007
|
+
<dl>
|
|
2008
|
+
|
|
2009
|
+
<dd>
|
|
2010
|
+
|
|
2011
|
+
**request: `Hume.empathicVoice.PostedConfig`**
|
|
1926
2012
|
|
|
1927
2013
|
</dd>
|
|
1928
2014
|
|
|
@@ -1947,9 +2033,7 @@ await client.empathicVoice.configs.updateConfigDescription("id", 1);
|
|
|
1947
2033
|
</dl>
|
|
1948
2034
|
</details>
|
|
1949
2035
|
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
<details><summary> <code>client.empathicVoice.chats.<a href="./src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> Hume.ReturnPagedChats</code> </summary>
|
|
2036
|
+
<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>
|
|
1953
2037
|
|
|
1954
2038
|
<dl>
|
|
1955
2039
|
|
|
@@ -1966,7 +2050,7 @@ await client.empathicVoice.configs.updateConfigDescription("id", 1);
|
|
|
1966
2050
|
<dd>
|
|
1967
2051
|
|
|
1968
2052
|
```ts
|
|
1969
|
-
await client.empathicVoice.
|
|
2053
|
+
await client.empathicVoice.configs.listConfigVersions("id");
|
|
1970
2054
|
```
|
|
1971
2055
|
|
|
1972
2056
|
</dd>
|
|
@@ -1987,7 +2071,7 @@ await client.empathicVoice.chats.listChats();
|
|
|
1987
2071
|
|
|
1988
2072
|
<dd>
|
|
1989
2073
|
|
|
1990
|
-
**
|
|
2074
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
1991
2075
|
|
|
1992
2076
|
</dd>
|
|
1993
2077
|
|
|
@@ -1997,7 +2081,17 @@ await client.empathicVoice.chats.listChats();
|
|
|
1997
2081
|
|
|
1998
2082
|
<dd>
|
|
1999
2083
|
|
|
2000
|
-
**
|
|
2084
|
+
**request: `Hume.empathicVoice.ConfigsListConfigVersionsRequest`**
|
|
2085
|
+
|
|
2086
|
+
</dd>
|
|
2087
|
+
|
|
2088
|
+
</dl>
|
|
2089
|
+
|
|
2090
|
+
<dl>
|
|
2091
|
+
|
|
2092
|
+
<dd>
|
|
2093
|
+
|
|
2094
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2001
2095
|
|
|
2002
2096
|
</dd>
|
|
2003
2097
|
|
|
@@ -2012,7 +2106,7 @@ await client.empathicVoice.chats.listChats();
|
|
|
2012
2106
|
</dl>
|
|
2013
2107
|
</details>
|
|
2014
2108
|
|
|
2015
|
-
<details><summary> <code>client.empathicVoice.
|
|
2109
|
+
<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>
|
|
2016
2110
|
|
|
2017
2111
|
<dl>
|
|
2018
2112
|
|
|
@@ -2029,7 +2123,7 @@ await client.empathicVoice.chats.listChats();
|
|
|
2029
2123
|
<dd>
|
|
2030
2124
|
|
|
2031
2125
|
```ts
|
|
2032
|
-
await client.empathicVoice.
|
|
2126
|
+
await client.empathicVoice.configs.createConfigVersion("id");
|
|
2033
2127
|
```
|
|
2034
2128
|
|
|
2035
2129
|
</dd>
|
|
@@ -2050,7 +2144,7 @@ await client.empathicVoice.chats.listChatEvents("id");
|
|
|
2050
2144
|
|
|
2051
2145
|
<dd>
|
|
2052
2146
|
|
|
2053
|
-
**id: `string`** — Identifier for a
|
|
2147
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2054
2148
|
|
|
2055
2149
|
</dd>
|
|
2056
2150
|
|
|
@@ -2060,7 +2154,7 @@ await client.empathicVoice.chats.listChatEvents("id");
|
|
|
2060
2154
|
|
|
2061
2155
|
<dd>
|
|
2062
2156
|
|
|
2063
|
-
**request: `Hume.empathicVoice.
|
|
2157
|
+
**request: `Hume.empathicVoice.PostedConfigVersion`**
|
|
2064
2158
|
|
|
2065
2159
|
</dd>
|
|
2066
2160
|
|
|
@@ -2070,7 +2164,7 @@ await client.empathicVoice.chats.listChatEvents("id");
|
|
|
2070
2164
|
|
|
2071
2165
|
<dd>
|
|
2072
2166
|
|
|
2073
|
-
**requestOptions: `
|
|
2167
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2074
2168
|
|
|
2075
2169
|
</dd>
|
|
2076
2170
|
|
|
@@ -2085,9 +2179,7 @@ await client.empathicVoice.chats.listChatEvents("id");
|
|
|
2085
2179
|
</dl>
|
|
2086
2180
|
</details>
|
|
2087
2181
|
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
<details><summary> <code>client.empathicVoice.chatGroups.<a href="./src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code> </summary>
|
|
2182
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code> </summary>
|
|
2091
2183
|
|
|
2092
2184
|
<dl>
|
|
2093
2185
|
|
|
@@ -2104,7 +2196,7 @@ await client.empathicVoice.chats.listChatEvents("id");
|
|
|
2104
2196
|
<dd>
|
|
2105
2197
|
|
|
2106
2198
|
```ts
|
|
2107
|
-
await client.empathicVoice.
|
|
2199
|
+
await client.empathicVoice.configs.deleteConfig("id");
|
|
2108
2200
|
```
|
|
2109
2201
|
|
|
2110
2202
|
</dd>
|
|
@@ -2125,7 +2217,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2125
2217
|
|
|
2126
2218
|
<dd>
|
|
2127
2219
|
|
|
2128
|
-
**
|
|
2220
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2129
2221
|
|
|
2130
2222
|
</dd>
|
|
2131
2223
|
|
|
@@ -2135,7 +2227,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2135
2227
|
|
|
2136
2228
|
<dd>
|
|
2137
2229
|
|
|
2138
|
-
**requestOptions: `
|
|
2230
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2139
2231
|
|
|
2140
2232
|
</dd>
|
|
2141
2233
|
|
|
@@ -2150,7 +2242,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2150
2242
|
</dl>
|
|
2151
2243
|
</details>
|
|
2152
2244
|
|
|
2153
|
-
<details><summary> <code>client.empathicVoice.
|
|
2245
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code> </summary>
|
|
2154
2246
|
|
|
2155
2247
|
<dl>
|
|
2156
2248
|
|
|
@@ -2167,7 +2259,9 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2167
2259
|
<dd>
|
|
2168
2260
|
|
|
2169
2261
|
```ts
|
|
2170
|
-
await client.empathicVoice.
|
|
2262
|
+
await client.empathicVoice.configs.updateConfigName("string", {
|
|
2263
|
+
name: "string",
|
|
2264
|
+
});
|
|
2171
2265
|
```
|
|
2172
2266
|
|
|
2173
2267
|
</dd>
|
|
@@ -2188,7 +2282,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
|
2188
2282
|
|
|
2189
2283
|
<dd>
|
|
2190
2284
|
|
|
2191
|
-
**id: `string`** — Identifier for a
|
|
2285
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2192
2286
|
|
|
2193
2287
|
</dd>
|
|
2194
2288
|
|
|
@@ -2198,7 +2292,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
|
2198
2292
|
|
|
2199
2293
|
<dd>
|
|
2200
2294
|
|
|
2201
|
-
**request: `Hume.empathicVoice.
|
|
2295
|
+
**request: `Hume.empathicVoice.PostedConfigName`**
|
|
2202
2296
|
|
|
2203
2297
|
</dd>
|
|
2204
2298
|
|
|
@@ -2208,7 +2302,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
|
2208
2302
|
|
|
2209
2303
|
<dd>
|
|
2210
2304
|
|
|
2211
|
-
**requestOptions: `
|
|
2305
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2212
2306
|
|
|
2213
2307
|
</dd>
|
|
2214
2308
|
|
|
@@ -2223,15 +2317,13 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
|
2223
2317
|
</dl>
|
|
2224
2318
|
</details>
|
|
2225
2319
|
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code> </summary>
|
|
2320
|
+
<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>
|
|
2229
2321
|
|
|
2230
2322
|
<dl>
|
|
2231
2323
|
|
|
2232
2324
|
<dd>
|
|
2233
2325
|
|
|
2234
|
-
####
|
|
2326
|
+
#### 🔌 Usage
|
|
2235
2327
|
|
|
2236
2328
|
<dl>
|
|
2237
2329
|
|
|
@@ -2241,7 +2333,9 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
|
2241
2333
|
|
|
2242
2334
|
<dd>
|
|
2243
2335
|
|
|
2244
|
-
|
|
2336
|
+
```ts
|
|
2337
|
+
await client.empathicVoice.configs.getConfigVersion("id", 1);
|
|
2338
|
+
```
|
|
2245
2339
|
|
|
2246
2340
|
</dd>
|
|
2247
2341
|
|
|
@@ -2251,7 +2345,7 @@ Sort and filter jobs.
|
|
|
2251
2345
|
|
|
2252
2346
|
</dl>
|
|
2253
2347
|
|
|
2254
|
-
####
|
|
2348
|
+
#### ⚙️ Parameters
|
|
2255
2349
|
|
|
2256
2350
|
<dl>
|
|
2257
2351
|
|
|
@@ -2261,29 +2355,17 @@ Sort and filter jobs.
|
|
|
2261
2355
|
|
|
2262
2356
|
<dd>
|
|
2263
2357
|
|
|
2264
|
-
|
|
2265
|
-
await client.expressionMeasurement.batch.listJobs();
|
|
2266
|
-
```
|
|
2267
|
-
|
|
2268
|
-
</dd>
|
|
2269
|
-
|
|
2270
|
-
</dl>
|
|
2358
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2271
2359
|
|
|
2272
2360
|
</dd>
|
|
2273
2361
|
|
|
2274
2362
|
</dl>
|
|
2275
2363
|
|
|
2276
|
-
#### ⚙️ Parameters
|
|
2277
|
-
|
|
2278
2364
|
<dl>
|
|
2279
2365
|
|
|
2280
2366
|
<dd>
|
|
2281
2367
|
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
<dd>
|
|
2285
|
-
|
|
2286
|
-
**request: `Hume.expressionMeasurement.BatchListJobsRequest`**
|
|
2368
|
+
**version: `number`** — Version number for a config. Version numbers should be integers.
|
|
2287
2369
|
|
|
2288
2370
|
</dd>
|
|
2289
2371
|
|
|
@@ -2293,7 +2375,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2293
2375
|
|
|
2294
2376
|
<dd>
|
|
2295
2377
|
|
|
2296
|
-
**requestOptions: `
|
|
2378
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2297
2379
|
|
|
2298
2380
|
</dd>
|
|
2299
2381
|
|
|
@@ -2308,13 +2390,13 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2308
2390
|
</dl>
|
|
2309
2391
|
</details>
|
|
2310
2392
|
|
|
2311
|
-
<details><summary> <code>client.
|
|
2393
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code> </summary>
|
|
2312
2394
|
|
|
2313
2395
|
<dl>
|
|
2314
2396
|
|
|
2315
2397
|
<dd>
|
|
2316
2398
|
|
|
2317
|
-
####
|
|
2399
|
+
#### 🔌 Usage
|
|
2318
2400
|
|
|
2319
2401
|
<dl>
|
|
2320
2402
|
|
|
@@ -2324,7 +2406,9 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2324
2406
|
|
|
2325
2407
|
<dd>
|
|
2326
2408
|
|
|
2327
|
-
|
|
2409
|
+
```ts
|
|
2410
|
+
await client.empathicVoice.configs.deleteConfigVersion("id", 1);
|
|
2411
|
+
```
|
|
2328
2412
|
|
|
2329
2413
|
</dd>
|
|
2330
2414
|
|
|
@@ -2334,7 +2418,7 @@ Start a new measurement inference job.
|
|
|
2334
2418
|
|
|
2335
2419
|
</dl>
|
|
2336
2420
|
|
|
2337
|
-
####
|
|
2421
|
+
#### ⚙️ Parameters
|
|
2338
2422
|
|
|
2339
2423
|
<dl>
|
|
2340
2424
|
|
|
@@ -2344,32 +2428,17 @@ Start a new measurement inference job.
|
|
|
2344
2428
|
|
|
2345
2429
|
<dd>
|
|
2346
2430
|
|
|
2347
|
-
|
|
2348
|
-
await client.expressionMeasurement.batch.startInferenceJob({
|
|
2349
|
-
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
2350
|
-
notify: true,
|
|
2351
|
-
});
|
|
2352
|
-
```
|
|
2353
|
-
|
|
2354
|
-
</dd>
|
|
2355
|
-
|
|
2356
|
-
</dl>
|
|
2431
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2357
2432
|
|
|
2358
2433
|
</dd>
|
|
2359
2434
|
|
|
2360
2435
|
</dl>
|
|
2361
2436
|
|
|
2362
|
-
#### ⚙️ Parameters
|
|
2363
|
-
|
|
2364
|
-
<dl>
|
|
2365
|
-
|
|
2366
|
-
<dd>
|
|
2367
|
-
|
|
2368
2437
|
<dl>
|
|
2369
2438
|
|
|
2370
2439
|
<dd>
|
|
2371
2440
|
|
|
2372
|
-
**
|
|
2441
|
+
**version: `number`** — Version number for a config. Version numbers should be integers.
|
|
2373
2442
|
|
|
2374
2443
|
</dd>
|
|
2375
2444
|
|
|
@@ -2379,7 +2448,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2379
2448
|
|
|
2380
2449
|
<dd>
|
|
2381
2450
|
|
|
2382
|
-
**requestOptions: `
|
|
2451
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2383
2452
|
|
|
2384
2453
|
</dd>
|
|
2385
2454
|
|
|
@@ -2394,13 +2463,13 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2394
2463
|
</dl>
|
|
2395
2464
|
</details>
|
|
2396
2465
|
|
|
2397
|
-
<details><summary> <code>client.
|
|
2466
|
+
<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>
|
|
2398
2467
|
|
|
2399
2468
|
<dl>
|
|
2400
2469
|
|
|
2401
2470
|
<dd>
|
|
2402
2471
|
|
|
2403
|
-
####
|
|
2472
|
+
#### 🔌 Usage
|
|
2404
2473
|
|
|
2405
2474
|
<dl>
|
|
2406
2475
|
|
|
@@ -2410,7 +2479,9 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2410
2479
|
|
|
2411
2480
|
<dd>
|
|
2412
2481
|
|
|
2413
|
-
|
|
2482
|
+
```ts
|
|
2483
|
+
await client.empathicVoice.configs.updateConfigDescription("id", 1);
|
|
2484
|
+
```
|
|
2414
2485
|
|
|
2415
2486
|
</dd>
|
|
2416
2487
|
|
|
@@ -2420,7 +2491,7 @@ Get the request details and state of a given job.
|
|
|
2420
2491
|
|
|
2421
2492
|
</dl>
|
|
2422
2493
|
|
|
2423
|
-
####
|
|
2494
|
+
#### ⚙️ Parameters
|
|
2424
2495
|
|
|
2425
2496
|
<dl>
|
|
2426
2497
|
|
|
@@ -2430,29 +2501,27 @@ Get the request details and state of a given job.
|
|
|
2430
2501
|
|
|
2431
2502
|
<dd>
|
|
2432
2503
|
|
|
2433
|
-
|
|
2434
|
-
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
2435
|
-
```
|
|
2504
|
+
**id: `string`** — Identifier for a config. Formatted as a UUID.
|
|
2436
2505
|
|
|
2437
2506
|
</dd>
|
|
2438
2507
|
|
|
2439
2508
|
</dl>
|
|
2440
2509
|
|
|
2441
|
-
|
|
2510
|
+
<dl>
|
|
2442
2511
|
|
|
2443
|
-
|
|
2512
|
+
<dd>
|
|
2444
2513
|
|
|
2445
|
-
|
|
2514
|
+
**version: `number`** — Version number for a config. Version numbers should be integers.
|
|
2446
2515
|
|
|
2447
|
-
|
|
2516
|
+
</dd>
|
|
2448
2517
|
|
|
2449
|
-
|
|
2518
|
+
</dl>
|
|
2450
2519
|
|
|
2451
2520
|
<dl>
|
|
2452
2521
|
|
|
2453
2522
|
<dd>
|
|
2454
2523
|
|
|
2455
|
-
**
|
|
2524
|
+
**request: `Hume.empathicVoice.PostedConfigVersionDescription`**
|
|
2456
2525
|
|
|
2457
2526
|
</dd>
|
|
2458
2527
|
|
|
@@ -2462,7 +2531,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2462
2531
|
|
|
2463
2532
|
<dd>
|
|
2464
2533
|
|
|
2465
|
-
**requestOptions: `
|
|
2534
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2466
2535
|
|
|
2467
2536
|
</dd>
|
|
2468
2537
|
|
|
@@ -2477,32 +2546,14 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2477
2546
|
</dl>
|
|
2478
2547
|
</details>
|
|
2479
2548
|
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
<dl>
|
|
2483
|
-
|
|
2484
|
-
<dd>
|
|
2485
|
-
|
|
2486
|
-
#### 📝 Description
|
|
2487
|
-
|
|
2488
|
-
<dl>
|
|
2549
|
+
## EmpathicVoice Chats
|
|
2489
2550
|
|
|
2490
|
-
<
|
|
2551
|
+
<details><summary> <code>client.empathicVoice.chats.<a href="./src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> Hume.ReturnPagedChats</code> </summary>
|
|
2491
2552
|
|
|
2492
2553
|
<dl>
|
|
2493
2554
|
|
|
2494
2555
|
<dd>
|
|
2495
2556
|
|
|
2496
|
-
Get the request details and state of a given job.
|
|
2497
|
-
|
|
2498
|
-
</dd>
|
|
2499
|
-
|
|
2500
|
-
</dl>
|
|
2501
|
-
|
|
2502
|
-
</dd>
|
|
2503
|
-
|
|
2504
|
-
</dl>
|
|
2505
|
-
|
|
2506
2557
|
#### 🔌 Usage
|
|
2507
2558
|
|
|
2508
2559
|
<dl>
|
|
@@ -2514,7 +2565,7 @@ Get the request details and state of a given job.
|
|
|
2514
2565
|
<dd>
|
|
2515
2566
|
|
|
2516
2567
|
```ts
|
|
2517
|
-
await client.
|
|
2568
|
+
await client.empathicVoice.chats.listChats();
|
|
2518
2569
|
```
|
|
2519
2570
|
|
|
2520
2571
|
</dd>
|
|
@@ -2535,7 +2586,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2535
2586
|
|
|
2536
2587
|
<dd>
|
|
2537
2588
|
|
|
2538
|
-
**
|
|
2589
|
+
**request: `Hume.empathicVoice.ChatsListChatsRequest`**
|
|
2539
2590
|
|
|
2540
2591
|
</dd>
|
|
2541
2592
|
|
|
@@ -2545,7 +2596,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2545
2596
|
|
|
2546
2597
|
<dd>
|
|
2547
2598
|
|
|
2548
|
-
**requestOptions: `
|
|
2599
|
+
**requestOptions: `Chats.RequestOptions`**
|
|
2549
2600
|
|
|
2550
2601
|
</dd>
|
|
2551
2602
|
|
|
@@ -2560,13 +2611,13 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2560
2611
|
</dl>
|
|
2561
2612
|
</details>
|
|
2562
2613
|
|
|
2563
|
-
<details><summary> <code>client.
|
|
2614
|
+
<details><summary> <code>client.empathicVoice.chats.<a href="./src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> Hume.ReturnChatPagedEvents</code> </summary>
|
|
2564
2615
|
|
|
2565
2616
|
<dl>
|
|
2566
2617
|
|
|
2567
2618
|
<dd>
|
|
2568
2619
|
|
|
2569
|
-
####
|
|
2620
|
+
#### 🔌 Usage
|
|
2570
2621
|
|
|
2571
2622
|
<dl>
|
|
2572
2623
|
|
|
@@ -2576,7 +2627,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
2576
2627
|
|
|
2577
2628
|
<dd>
|
|
2578
2629
|
|
|
2579
|
-
|
|
2630
|
+
```ts
|
|
2631
|
+
await client.empathicVoice.chats.listChatEvents("id");
|
|
2632
|
+
```
|
|
2580
2633
|
|
|
2581
2634
|
</dd>
|
|
2582
2635
|
|
|
@@ -2586,7 +2639,7 @@ Get the JSON predictions of a completed measurement or custom models inference j
|
|
|
2586
2639
|
|
|
2587
2640
|
</dl>
|
|
2588
2641
|
|
|
2589
|
-
####
|
|
2642
|
+
#### ⚙️ Parameters
|
|
2590
2643
|
|
|
2591
2644
|
<dl>
|
|
2592
2645
|
|
|
@@ -2596,29 +2649,17 @@ Get the JSON predictions of a completed measurement or custom models inference j
|
|
|
2596
2649
|
|
|
2597
2650
|
<dd>
|
|
2598
2651
|
|
|
2599
|
-
|
|
2600
|
-
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
2601
|
-
```
|
|
2602
|
-
|
|
2603
|
-
</dd>
|
|
2604
|
-
|
|
2605
|
-
</dl>
|
|
2652
|
+
**id: `string`** — Identifier for a chat. Formatted as a UUID.
|
|
2606
2653
|
|
|
2607
2654
|
</dd>
|
|
2608
2655
|
|
|
2609
2656
|
</dl>
|
|
2610
2657
|
|
|
2611
|
-
#### ⚙️ Parameters
|
|
2612
|
-
|
|
2613
|
-
<dl>
|
|
2614
|
-
|
|
2615
|
-
<dd>
|
|
2616
|
-
|
|
2617
2658
|
<dl>
|
|
2618
2659
|
|
|
2619
2660
|
<dd>
|
|
2620
2661
|
|
|
2621
|
-
**
|
|
2662
|
+
**request: `Hume.empathicVoice.ChatsListChatEventsRequest`**
|
|
2622
2663
|
|
|
2623
2664
|
</dd>
|
|
2624
2665
|
|
|
@@ -2628,7 +2669,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
2628
2669
|
|
|
2629
2670
|
<dd>
|
|
2630
2671
|
|
|
2631
|
-
**requestOptions: `
|
|
2672
|
+
**requestOptions: `Chats.RequestOptions`**
|
|
2632
2673
|
|
|
2633
2674
|
</dd>
|
|
2634
2675
|
|
|
@@ -2643,32 +2684,14 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
2643
2684
|
</dl>
|
|
2644
2685
|
</details>
|
|
2645
2686
|
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
<dl>
|
|
2649
|
-
|
|
2650
|
-
<dd>
|
|
2651
|
-
|
|
2652
|
-
#### 📝 Description
|
|
2653
|
-
|
|
2654
|
-
<dl>
|
|
2687
|
+
## EmpathicVoice ChatGroups
|
|
2655
2688
|
|
|
2656
|
-
<
|
|
2689
|
+
<details><summary> <code>client.empathicVoice.chatGroups.<a href="./src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code> </summary>
|
|
2657
2690
|
|
|
2658
2691
|
<dl>
|
|
2659
2692
|
|
|
2660
2693
|
<dd>
|
|
2661
2694
|
|
|
2662
|
-
Get the artifacts ZIP of a completed measurement or custom models inference job.
|
|
2663
|
-
|
|
2664
|
-
</dd>
|
|
2665
|
-
|
|
2666
|
-
</dl>
|
|
2667
|
-
|
|
2668
|
-
</dd>
|
|
2669
|
-
|
|
2670
|
-
</dl>
|
|
2671
|
-
|
|
2672
2695
|
#### 🔌 Usage
|
|
2673
2696
|
|
|
2674
2697
|
<dl>
|
|
@@ -2680,7 +2703,7 @@ Get the artifacts ZIP of a completed measurement or custom models inference job.
|
|
|
2680
2703
|
<dd>
|
|
2681
2704
|
|
|
2682
2705
|
```ts
|
|
2683
|
-
await client.
|
|
2706
|
+
await client.empathicVoice.chatGroups.listChatGroups();
|
|
2684
2707
|
```
|
|
2685
2708
|
|
|
2686
2709
|
</dd>
|
|
@@ -2701,7 +2724,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
2701
2724
|
|
|
2702
2725
|
<dd>
|
|
2703
2726
|
|
|
2704
|
-
**
|
|
2727
|
+
**request: `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`**
|
|
2705
2728
|
|
|
2706
2729
|
</dd>
|
|
2707
2730
|
|
|
@@ -2711,7 +2734,7 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
2711
2734
|
|
|
2712
2735
|
<dd>
|
|
2713
2736
|
|
|
2714
|
-
**requestOptions: `
|
|
2737
|
+
**requestOptions: `ChatGroups.RequestOptions`**
|
|
2715
2738
|
|
|
2716
2739
|
</dd>
|
|
2717
2740
|
|
|
@@ -2726,32 +2749,12 @@ await client.expressionMeasurement.batch.getJobArtifacts("string");
|
|
|
2726
2749
|
</dl>
|
|
2727
2750
|
</details>
|
|
2728
2751
|
|
|
2729
|
-
<details><summary> <code>client.
|
|
2730
|
-
|
|
2731
|
-
<dl>
|
|
2732
|
-
|
|
2733
|
-
<dd>
|
|
2734
|
-
|
|
2735
|
-
#### 📝 Description
|
|
2736
|
-
|
|
2737
|
-
<dl>
|
|
2738
|
-
|
|
2739
|
-
<dd>
|
|
2752
|
+
<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>
|
|
2740
2753
|
|
|
2741
2754
|
<dl>
|
|
2742
2755
|
|
|
2743
2756
|
<dd>
|
|
2744
2757
|
|
|
2745
|
-
Start a new batch inference job.
|
|
2746
|
-
|
|
2747
|
-
</dd>
|
|
2748
|
-
|
|
2749
|
-
</dl>
|
|
2750
|
-
|
|
2751
|
-
</dd>
|
|
2752
|
-
|
|
2753
|
-
</dl>
|
|
2754
|
-
|
|
2755
2758
|
#### 🔌 Usage
|
|
2756
2759
|
|
|
2757
2760
|
<dl>
|
|
@@ -2763,10 +2766,7 @@ Start a new batch inference job.
|
|
|
2763
2766
|
<dd>
|
|
2764
2767
|
|
|
2765
2768
|
```ts
|
|
2766
|
-
await client.
|
|
2767
|
-
[fs.createReadStream("/path/to/your/file")],
|
|
2768
|
-
{}
|
|
2769
|
-
);
|
|
2769
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("id");
|
|
2770
2770
|
```
|
|
2771
2771
|
|
|
2772
2772
|
</dd>
|
|
@@ -2787,7 +2787,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2787
2787
|
|
|
2788
2788
|
<dd>
|
|
2789
2789
|
|
|
2790
|
-
**
|
|
2790
|
+
**id: `string`** — Identifier for a chat. Formatted as a UUID.
|
|
2791
2791
|
|
|
2792
2792
|
</dd>
|
|
2793
2793
|
|
|
@@ -2797,7 +2797,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2797
2797
|
|
|
2798
2798
|
<dd>
|
|
2799
2799
|
|
|
2800
|
-
**request: `Hume.
|
|
2800
|
+
**request: `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`**
|
|
2801
2801
|
|
|
2802
2802
|
</dd>
|
|
2803
2803
|
|
|
@@ -2807,7 +2807,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2807
2807
|
|
|
2808
2808
|
<dd>
|
|
2809
2809
|
|
|
2810
|
-
**requestOptions: `
|
|
2810
|
+
**requestOptions: `ChatGroups.RequestOptions`**
|
|
2811
2811
|
|
|
2812
2812
|
</dd>
|
|
2813
2813
|
|