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