hume 0.9.3 → 0.9.4
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 +287 -14
- package/.mock/definition/empathic-voice/chatGroups.yml +25 -23
- package/.mock/definition/empathic-voice/chats.yml +14 -24
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +8 -2
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +12 -6
- package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +5 -1
- package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +4 -2
- package/api/resources/empathicVoice/resources/chats/client/Client.js +7 -5
- package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
- package/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
- package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
- package/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
- package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedVoice.d.ts +2 -2
- package/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
- package/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
- package/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
- package/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +5 -0
- package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
- package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +5 -0
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
- package/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
- package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
- package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
- package/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
- package/api/resources/empathicVoice/types/ReturnVoice.d.ts +2 -2
- package/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
- package/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
- package/api/resources/empathicVoice/types/index.d.ts +8 -0
- package/api/resources/empathicVoice/types/index.js +8 -0
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +8 -2
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +12 -6
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +5 -1
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +4 -2
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +7 -5
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
- package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +5 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +5 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
- package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
- package/dist/api/resources/empathicVoice/types/index.d.ts +8 -0
- package/dist/api/resources/empathicVoice/types/index.js +8 -0
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
- package/dist/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/PostedVoiceProvider.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnVoiceProvider.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/index.d.ts +8 -0
- package/dist/serialization/resources/empathicVoice/types/index.js +8 -0
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +569 -535
- package/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
- package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
- package/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
- package/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/PostedVoiceProvider.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
- package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
- package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
- package/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.js +31 -0
- package/serialization/resources/empathicVoice/types/index.d.ts +8 -0
- package/serialization/resources/empathicVoice/types/index.js +8 -0
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## ExpressionMeasurement Batch
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,9 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
17
|
+
Sort and filter jobs.
|
|
20
18
|
|
|
21
19
|
</dd>
|
|
22
20
|
</dl>
|
|
@@ -32,10 +30,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
32
30
|
<dd>
|
|
33
31
|
|
|
34
32
|
```typescript
|
|
35
|
-
await client.
|
|
36
|
-
pageNumber: 0,
|
|
37
|
-
pageSize: 2,
|
|
38
|
-
});
|
|
33
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
39
34
|
```
|
|
40
35
|
|
|
41
36
|
</dd>
|
|
@@ -51,7 +46,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
51
46
|
<dl>
|
|
52
47
|
<dd>
|
|
53
48
|
|
|
54
|
-
**request:** `Hume.
|
|
49
|
+
**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
|
|
55
50
|
|
|
56
51
|
</dd>
|
|
57
52
|
</dl>
|
|
@@ -59,7 +54,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
59
54
|
<dl>
|
|
60
55
|
<dd>
|
|
61
56
|
|
|
62
|
-
**requestOptions:** `
|
|
57
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
63
58
|
|
|
64
59
|
</dd>
|
|
65
60
|
</dl>
|
|
@@ -70,7 +65,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
70
65
|
</dl>
|
|
71
66
|
</details>
|
|
72
67
|
|
|
73
|
-
<details><summary><code>client.
|
|
68
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
|
|
74
69
|
<dl>
|
|
75
70
|
<dd>
|
|
76
71
|
|
|
@@ -82,9 +77,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
82
77
|
<dl>
|
|
83
78
|
<dd>
|
|
84
79
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
80
|
+
Start a new measurement inference job.
|
|
88
81
|
|
|
89
82
|
</dd>
|
|
90
83
|
</dl>
|
|
@@ -100,13 +93,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
100
93
|
<dd>
|
|
101
94
|
|
|
102
95
|
```typescript
|
|
103
|
-
await client.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
'{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
|
|
107
|
-
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
108
|
-
description: "This tool is for getting the current weather.",
|
|
109
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
96
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
97
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
98
|
+
notify: true,
|
|
110
99
|
});
|
|
111
100
|
```
|
|
112
101
|
|
|
@@ -123,7 +112,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
123
112
|
<dl>
|
|
124
113
|
<dd>
|
|
125
114
|
|
|
126
|
-
**request:** `Hume.
|
|
115
|
+
**request:** `Hume.InferenceBaseRequest`
|
|
127
116
|
|
|
128
117
|
</dd>
|
|
129
118
|
</dl>
|
|
@@ -131,7 +120,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
131
120
|
<dl>
|
|
132
121
|
<dd>
|
|
133
122
|
|
|
134
|
-
**requestOptions:** `
|
|
123
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
135
124
|
|
|
136
125
|
</dd>
|
|
137
126
|
</dl>
|
|
@@ -142,7 +131,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
142
131
|
</dl>
|
|
143
132
|
</details>
|
|
144
133
|
|
|
145
|
-
<details><summary><code>client.
|
|
134
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
|
|
146
135
|
<dl>
|
|
147
136
|
<dd>
|
|
148
137
|
|
|
@@ -154,9 +143,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
154
143
|
<dl>
|
|
155
144
|
<dd>
|
|
156
145
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
146
|
+
Get the request details and state of a given job.
|
|
160
147
|
|
|
161
148
|
</dd>
|
|
162
149
|
</dl>
|
|
@@ -172,7 +159,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
172
159
|
<dd>
|
|
173
160
|
|
|
174
161
|
```typescript
|
|
175
|
-
await client.
|
|
162
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
176
163
|
```
|
|
177
164
|
|
|
178
165
|
</dd>
|
|
@@ -188,15 +175,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
188
175
|
<dl>
|
|
189
176
|
<dd>
|
|
190
177
|
|
|
191
|
-
**id:** `string` —
|
|
192
|
-
|
|
193
|
-
</dd>
|
|
194
|
-
</dl>
|
|
195
|
-
|
|
196
|
-
<dl>
|
|
197
|
-
<dd>
|
|
198
|
-
|
|
199
|
-
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
178
|
+
**id:** `string` — The unique identifier for the job.
|
|
200
179
|
|
|
201
180
|
</dd>
|
|
202
181
|
</dl>
|
|
@@ -204,7 +183,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
204
183
|
<dl>
|
|
205
184
|
<dd>
|
|
206
185
|
|
|
207
|
-
**requestOptions:** `
|
|
186
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
208
187
|
|
|
209
188
|
</dd>
|
|
210
189
|
</dl>
|
|
@@ -215,7 +194,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
215
194
|
</dl>
|
|
216
195
|
</details>
|
|
217
196
|
|
|
218
|
-
<details><summary><code>client.
|
|
197
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
|
|
219
198
|
<dl>
|
|
220
199
|
<dd>
|
|
221
200
|
|
|
@@ -227,9 +206,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
227
206
|
<dl>
|
|
228
207
|
<dd>
|
|
229
208
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
209
|
+
Get the JSON predictions of a completed inference job.
|
|
233
210
|
|
|
234
211
|
</dd>
|
|
235
212
|
</dl>
|
|
@@ -245,13 +222,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
245
222
|
<dd>
|
|
246
223
|
|
|
247
224
|
```typescript
|
|
248
|
-
await client.
|
|
249
|
-
parameters:
|
|
250
|
-
'{ "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "format": { "type": "string", "enum": ["celsius", "fahrenheit", "kelvin"], "description": "The temperature unit to use. Infer this from the users location." } }, "required": ["location", "format"] }',
|
|
251
|
-
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
252
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
253
|
-
description: "This tool is for getting the current weather.",
|
|
254
|
-
});
|
|
225
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
255
226
|
```
|
|
256
227
|
|
|
257
228
|
</dd>
|
|
@@ -267,15 +238,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
267
238
|
<dl>
|
|
268
239
|
<dd>
|
|
269
240
|
|
|
270
|
-
**id:** `string` —
|
|
271
|
-
|
|
272
|
-
</dd>
|
|
273
|
-
</dl>
|
|
274
|
-
|
|
275
|
-
<dl>
|
|
276
|
-
<dd>
|
|
277
|
-
|
|
278
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
241
|
+
**id:** `string` — The unique identifier for the job.
|
|
279
242
|
|
|
280
243
|
</dd>
|
|
281
244
|
</dl>
|
|
@@ -283,7 +246,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
283
246
|
<dl>
|
|
284
247
|
<dd>
|
|
285
248
|
|
|
286
|
-
**requestOptions:** `
|
|
249
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
287
250
|
|
|
288
251
|
</dd>
|
|
289
252
|
</dl>
|
|
@@ -294,7 +257,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
294
257
|
</dl>
|
|
295
258
|
</details>
|
|
296
259
|
|
|
297
|
-
<details><summary><code>client.
|
|
260
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
|
|
298
261
|
<dl>
|
|
299
262
|
<dd>
|
|
300
263
|
|
|
@@ -306,9 +269,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
306
269
|
<dl>
|
|
307
270
|
<dd>
|
|
308
271
|
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
272
|
+
Start a new batch inference job.
|
|
312
273
|
|
|
313
274
|
</dd>
|
|
314
275
|
</dl>
|
|
@@ -324,7 +285,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
324
285
|
<dd>
|
|
325
286
|
|
|
326
287
|
```typescript
|
|
327
|
-
await client.
|
|
288
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
289
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
290
|
+
{}
|
|
291
|
+
);
|
|
328
292
|
```
|
|
329
293
|
|
|
330
294
|
</dd>
|
|
@@ -340,7 +304,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
340
304
|
<dl>
|
|
341
305
|
<dd>
|
|
342
306
|
|
|
343
|
-
**
|
|
307
|
+
**file:** `File[] | fs.ReadStream[] | Blob[]`
|
|
344
308
|
|
|
345
309
|
</dd>
|
|
346
310
|
</dl>
|
|
@@ -348,7 +312,15 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
348
312
|
<dl>
|
|
349
313
|
<dd>
|
|
350
314
|
|
|
351
|
-
**
|
|
315
|
+
**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
|
|
316
|
+
|
|
317
|
+
</dd>
|
|
318
|
+
</dl>
|
|
319
|
+
|
|
320
|
+
<dl>
|
|
321
|
+
<dd>
|
|
322
|
+
|
|
323
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
352
324
|
|
|
353
325
|
</dd>
|
|
354
326
|
</dl>
|
|
@@ -359,7 +331,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
359
331
|
</dl>
|
|
360
332
|
</details>
|
|
361
333
|
|
|
362
|
-
|
|
334
|
+
## EmpathicVoice Tools
|
|
335
|
+
|
|
336
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
|
|
363
337
|
<dl>
|
|
364
338
|
<dd>
|
|
365
339
|
|
|
@@ -371,7 +345,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
371
345
|
<dl>
|
|
372
346
|
<dd>
|
|
373
347
|
|
|
374
|
-
|
|
348
|
+
Fetches a paginated list of **Tools**.
|
|
375
349
|
|
|
376
350
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
377
351
|
|
|
@@ -389,8 +363,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
389
363
|
<dd>
|
|
390
364
|
|
|
391
365
|
```typescript
|
|
392
|
-
await client.empathicVoice.tools.
|
|
393
|
-
|
|
366
|
+
await client.empathicVoice.tools.listTools({
|
|
367
|
+
pageNumber: 0,
|
|
368
|
+
pageSize: 2,
|
|
394
369
|
});
|
|
395
370
|
```
|
|
396
371
|
|
|
@@ -407,15 +382,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
407
382
|
<dl>
|
|
408
383
|
<dd>
|
|
409
384
|
|
|
410
|
-
**
|
|
411
|
-
|
|
412
|
-
</dd>
|
|
413
|
-
</dl>
|
|
414
|
-
|
|
415
|
-
<dl>
|
|
416
|
-
<dd>
|
|
417
|
-
|
|
418
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
385
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
419
386
|
|
|
420
387
|
</dd>
|
|
421
388
|
</dl>
|
|
@@ -434,7 +401,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
434
401
|
</dl>
|
|
435
402
|
</details>
|
|
436
403
|
|
|
437
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
404
|
+
<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>
|
|
438
405
|
<dl>
|
|
439
406
|
<dd>
|
|
440
407
|
|
|
@@ -446,7 +413,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
446
413
|
<dl>
|
|
447
414
|
<dd>
|
|
448
415
|
|
|
449
|
-
|
|
416
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
450
417
|
|
|
451
418
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
452
419
|
|
|
@@ -464,7 +431,14 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
464
431
|
<dd>
|
|
465
432
|
|
|
466
433
|
```typescript
|
|
467
|
-
await client.empathicVoice.tools.
|
|
434
|
+
await client.empathicVoice.tools.createTool({
|
|
435
|
+
name: "get_current_weather",
|
|
436
|
+
parameters:
|
|
437
|
+
'{ "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"] }',
|
|
438
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
439
|
+
description: "This tool is for getting the current weather.",
|
|
440
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
441
|
+
});
|
|
468
442
|
```
|
|
469
443
|
|
|
470
444
|
</dd>
|
|
@@ -480,21 +454,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
480
454
|
<dl>
|
|
481
455
|
<dd>
|
|
482
456
|
|
|
483
|
-
**
|
|
484
|
-
|
|
485
|
-
</dd>
|
|
486
|
-
</dl>
|
|
487
|
-
|
|
488
|
-
<dl>
|
|
489
|
-
<dd>
|
|
490
|
-
|
|
491
|
-
**version:** `number`
|
|
492
|
-
|
|
493
|
-
Version number for a Tool.
|
|
494
|
-
|
|
495
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
496
|
-
|
|
497
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
457
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
498
458
|
|
|
499
459
|
</dd>
|
|
500
460
|
</dl>
|
|
@@ -513,7 +473,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
513
473
|
</dl>
|
|
514
474
|
</details>
|
|
515
475
|
|
|
516
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
476
|
+
<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>
|
|
517
477
|
<dl>
|
|
518
478
|
<dd>
|
|
519
479
|
|
|
@@ -525,7 +485,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
525
485
|
<dl>
|
|
526
486
|
<dd>
|
|
527
487
|
|
|
528
|
-
|
|
488
|
+
Fetches a list of a **Tool's** versions.
|
|
529
489
|
|
|
530
490
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
531
491
|
|
|
@@ -543,7 +503,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
543
503
|
<dd>
|
|
544
504
|
|
|
545
505
|
```typescript
|
|
546
|
-
await client.empathicVoice.tools.
|
|
506
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
547
507
|
```
|
|
548
508
|
|
|
549
509
|
</dd>
|
|
@@ -567,13 +527,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
567
527
|
<dl>
|
|
568
528
|
<dd>
|
|
569
529
|
|
|
570
|
-
**
|
|
571
|
-
|
|
572
|
-
Version number for a Tool.
|
|
573
|
-
|
|
574
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
575
|
-
|
|
576
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
530
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
577
531
|
|
|
578
532
|
</dd>
|
|
579
533
|
</dl>
|
|
@@ -592,7 +546,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
592
546
|
</dl>
|
|
593
547
|
</details>
|
|
594
548
|
|
|
595
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
549
|
+
<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>
|
|
596
550
|
<dl>
|
|
597
551
|
<dd>
|
|
598
552
|
|
|
@@ -604,7 +558,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
604
558
|
<dl>
|
|
605
559
|
<dd>
|
|
606
560
|
|
|
607
|
-
Updates
|
|
561
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
608
562
|
|
|
609
563
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
610
564
|
|
|
@@ -622,9 +576,12 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-cal
|
|
|
622
576
|
<dd>
|
|
623
577
|
|
|
624
578
|
```typescript
|
|
625
|
-
await client.empathicVoice.tools.
|
|
626
|
-
|
|
627
|
-
"
|
|
579
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
580
|
+
parameters:
|
|
581
|
+
'{ "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"] }',
|
|
582
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
583
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
584
|
+
description: "This tool is for getting the current weather.",
|
|
628
585
|
});
|
|
629
586
|
```
|
|
630
587
|
|
|
@@ -649,21 +606,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
649
606
|
<dl>
|
|
650
607
|
<dd>
|
|
651
608
|
|
|
652
|
-
**
|
|
653
|
-
|
|
654
|
-
Version number for a Tool.
|
|
655
|
-
|
|
656
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
657
|
-
|
|
658
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
659
|
-
|
|
660
|
-
</dd>
|
|
661
|
-
</dl>
|
|
662
|
-
|
|
663
|
-
<dl>
|
|
664
|
-
<dd>
|
|
665
|
-
|
|
666
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
609
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
667
610
|
|
|
668
611
|
</dd>
|
|
669
612
|
</dl>
|
|
@@ -682,9 +625,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
682
625
|
</dl>
|
|
683
626
|
</details>
|
|
684
627
|
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
628
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
688
629
|
<dl>
|
|
689
630
|
<dd>
|
|
690
631
|
|
|
@@ -696,9 +637,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
696
637
|
<dl>
|
|
697
638
|
<dd>
|
|
698
639
|
|
|
699
|
-
|
|
640
|
+
Deletes a **Tool** and its versions.
|
|
700
641
|
|
|
701
|
-
|
|
642
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
702
643
|
|
|
703
644
|
</dd>
|
|
704
645
|
</dl>
|
|
@@ -714,10 +655,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
714
655
|
<dd>
|
|
715
656
|
|
|
716
657
|
```typescript
|
|
717
|
-
await client.empathicVoice.
|
|
718
|
-
pageNumber: 0,
|
|
719
|
-
pageSize: 2,
|
|
720
|
-
});
|
|
658
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
721
659
|
```
|
|
722
660
|
|
|
723
661
|
</dd>
|
|
@@ -733,7 +671,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
733
671
|
<dl>
|
|
734
672
|
<dd>
|
|
735
673
|
|
|
736
|
-
**
|
|
674
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
737
675
|
|
|
738
676
|
</dd>
|
|
739
677
|
</dl>
|
|
@@ -741,7 +679,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
741
679
|
<dl>
|
|
742
680
|
<dd>
|
|
743
681
|
|
|
744
|
-
**requestOptions:** `
|
|
682
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
745
683
|
|
|
746
684
|
</dd>
|
|
747
685
|
</dl>
|
|
@@ -752,7 +690,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
752
690
|
</dl>
|
|
753
691
|
</details>
|
|
754
692
|
|
|
755
|
-
<details><summary><code>client.empathicVoice.
|
|
693
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
756
694
|
<dl>
|
|
757
695
|
<dd>
|
|
758
696
|
|
|
@@ -764,9 +702,9 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
764
702
|
<dl>
|
|
765
703
|
<dd>
|
|
766
704
|
|
|
767
|
-
|
|
705
|
+
Updates the name of a **Tool**.
|
|
768
706
|
|
|
769
|
-
|
|
707
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
770
708
|
|
|
771
709
|
</dd>
|
|
772
710
|
</dl>
|
|
@@ -782,9 +720,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
782
720
|
<dd>
|
|
783
721
|
|
|
784
722
|
```typescript
|
|
785
|
-
await client.empathicVoice.
|
|
786
|
-
name: "
|
|
787
|
-
text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
723
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
724
|
+
name: "get_current_temperature",
|
|
788
725
|
});
|
|
789
726
|
```
|
|
790
727
|
|
|
@@ -801,7 +738,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
801
738
|
<dl>
|
|
802
739
|
<dd>
|
|
803
740
|
|
|
804
|
-
**
|
|
741
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
805
742
|
|
|
806
743
|
</dd>
|
|
807
744
|
</dl>
|
|
@@ -809,7 +746,15 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
809
746
|
<dl>
|
|
810
747
|
<dd>
|
|
811
748
|
|
|
812
|
-
**
|
|
749
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
750
|
+
|
|
751
|
+
</dd>
|
|
752
|
+
</dl>
|
|
753
|
+
|
|
754
|
+
<dl>
|
|
755
|
+
<dd>
|
|
756
|
+
|
|
757
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
813
758
|
|
|
814
759
|
</dd>
|
|
815
760
|
</dl>
|
|
@@ -820,7 +765,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
820
765
|
</dl>
|
|
821
766
|
</details>
|
|
822
767
|
|
|
823
|
-
<details><summary><code>client.empathicVoice.
|
|
768
|
+
<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>
|
|
824
769
|
<dl>
|
|
825
770
|
<dd>
|
|
826
771
|
|
|
@@ -832,9 +777,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
832
777
|
<dl>
|
|
833
778
|
<dd>
|
|
834
779
|
|
|
835
|
-
Fetches a
|
|
780
|
+
Fetches a specified version of a **Tool**.
|
|
836
781
|
|
|
837
|
-
|
|
782
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
838
783
|
|
|
839
784
|
</dd>
|
|
840
785
|
</dl>
|
|
@@ -850,7 +795,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
850
795
|
<dd>
|
|
851
796
|
|
|
852
797
|
```typescript
|
|
853
|
-
await client.empathicVoice.
|
|
798
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
854
799
|
```
|
|
855
800
|
|
|
856
801
|
</dd>
|
|
@@ -866,7 +811,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
866
811
|
<dl>
|
|
867
812
|
<dd>
|
|
868
813
|
|
|
869
|
-
**id:** `string` — Identifier for a
|
|
814
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
870
815
|
|
|
871
816
|
</dd>
|
|
872
817
|
</dl>
|
|
@@ -874,15 +819,21 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
874
819
|
<dl>
|
|
875
820
|
<dd>
|
|
876
821
|
|
|
877
|
-
**
|
|
822
|
+
**version:** `number`
|
|
878
823
|
|
|
879
|
-
|
|
880
|
-
</dl>
|
|
824
|
+
Version number for a Tool.
|
|
881
825
|
|
|
882
|
-
|
|
883
|
-
<dd>
|
|
826
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
884
827
|
|
|
885
|
-
|
|
828
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
829
|
+
|
|
830
|
+
</dd>
|
|
831
|
+
</dl>
|
|
832
|
+
|
|
833
|
+
<dl>
|
|
834
|
+
<dd>
|
|
835
|
+
|
|
836
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
886
837
|
|
|
887
838
|
</dd>
|
|
888
839
|
</dl>
|
|
@@ -893,7 +844,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
893
844
|
</dl>
|
|
894
845
|
</details>
|
|
895
846
|
|
|
896
|
-
<details><summary><code>client.empathicVoice.
|
|
847
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
897
848
|
<dl>
|
|
898
849
|
<dd>
|
|
899
850
|
|
|
@@ -905,9 +856,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
905
856
|
<dl>
|
|
906
857
|
<dd>
|
|
907
858
|
|
|
908
|
-
|
|
859
|
+
Deletes a specified version of a **Tool**.
|
|
909
860
|
|
|
910
|
-
|
|
861
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
911
862
|
|
|
912
863
|
</dd>
|
|
913
864
|
</dl>
|
|
@@ -923,10 +874,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
923
874
|
<dd>
|
|
924
875
|
|
|
925
876
|
```typescript
|
|
926
|
-
await client.empathicVoice.
|
|
927
|
-
text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
928
|
-
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
929
|
-
});
|
|
877
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
930
878
|
```
|
|
931
879
|
|
|
932
880
|
</dd>
|
|
@@ -942,7 +890,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
942
890
|
<dl>
|
|
943
891
|
<dd>
|
|
944
892
|
|
|
945
|
-
**id:** `string` — Identifier for a
|
|
893
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
946
894
|
|
|
947
895
|
</dd>
|
|
948
896
|
</dl>
|
|
@@ -950,7 +898,13 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
950
898
|
<dl>
|
|
951
899
|
<dd>
|
|
952
900
|
|
|
953
|
-
**
|
|
901
|
+
**version:** `number`
|
|
902
|
+
|
|
903
|
+
Version number for a Tool.
|
|
904
|
+
|
|
905
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
906
|
+
|
|
907
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
954
908
|
|
|
955
909
|
</dd>
|
|
956
910
|
</dl>
|
|
@@ -958,7 +912,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
958
912
|
<dl>
|
|
959
913
|
<dd>
|
|
960
914
|
|
|
961
|
-
**requestOptions:** `
|
|
915
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
962
916
|
|
|
963
917
|
</dd>
|
|
964
918
|
</dl>
|
|
@@ -969,7 +923,7 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
969
923
|
</dl>
|
|
970
924
|
</details>
|
|
971
925
|
|
|
972
|
-
<details><summary><code>client.empathicVoice.
|
|
926
|
+
<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>
|
|
973
927
|
<dl>
|
|
974
928
|
<dd>
|
|
975
929
|
|
|
@@ -981,9 +935,9 @@ await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-
|
|
|
981
935
|
<dl>
|
|
982
936
|
<dd>
|
|
983
937
|
|
|
984
|
-
|
|
938
|
+
Updates the description of a specified **Tool** version.
|
|
985
939
|
|
|
986
|
-
|
|
940
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
987
941
|
|
|
988
942
|
</dd>
|
|
989
943
|
</dl>
|
|
@@ -999,7 +953,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
999
953
|
<dd>
|
|
1000
954
|
|
|
1001
955
|
```typescript
|
|
1002
|
-
await client.empathicVoice.
|
|
956
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
957
|
+
versionDescription:
|
|
958
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
959
|
+
});
|
|
1003
960
|
```
|
|
1004
961
|
|
|
1005
962
|
</dd>
|
|
@@ -1015,7 +972,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1015
972
|
<dl>
|
|
1016
973
|
<dd>
|
|
1017
974
|
|
|
1018
|
-
**id:** `string` — Identifier for a
|
|
975
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1019
976
|
|
|
1020
977
|
</dd>
|
|
1021
978
|
</dl>
|
|
@@ -1023,7 +980,29 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1023
980
|
<dl>
|
|
1024
981
|
<dd>
|
|
1025
982
|
|
|
1026
|
-
**
|
|
983
|
+
**version:** `number`
|
|
984
|
+
|
|
985
|
+
Version number for a Tool.
|
|
986
|
+
|
|
987
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
988
|
+
|
|
989
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
990
|
+
|
|
991
|
+
</dd>
|
|
992
|
+
</dl>
|
|
993
|
+
|
|
994
|
+
<dl>
|
|
995
|
+
<dd>
|
|
996
|
+
|
|
997
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
998
|
+
|
|
999
|
+
</dd>
|
|
1000
|
+
</dl>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1027
1006
|
|
|
1028
1007
|
</dd>
|
|
1029
1008
|
</dl>
|
|
@@ -1034,7 +1013,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1034
1013
|
</dl>
|
|
1035
1014
|
</details>
|
|
1036
1015
|
|
|
1037
|
-
|
|
1016
|
+
## EmpathicVoice Prompts
|
|
1017
|
+
|
|
1018
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<Hume.ReturnPrompt | undefined></code></summary>
|
|
1038
1019
|
<dl>
|
|
1039
1020
|
<dd>
|
|
1040
1021
|
|
|
@@ -1046,7 +1027,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1046
1027
|
<dl>
|
|
1047
1028
|
<dd>
|
|
1048
1029
|
|
|
1049
|
-
|
|
1030
|
+
Fetches a paginated list of **Prompts**.
|
|
1050
1031
|
|
|
1051
1032
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1052
1033
|
|
|
@@ -1064,8 +1045,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1064
1045
|
<dd>
|
|
1065
1046
|
|
|
1066
1047
|
```typescript
|
|
1067
|
-
await client.empathicVoice.prompts.
|
|
1068
|
-
|
|
1048
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
1049
|
+
pageNumber: 0,
|
|
1050
|
+
pageSize: 2,
|
|
1069
1051
|
});
|
|
1070
1052
|
```
|
|
1071
1053
|
|
|
@@ -1082,15 +1064,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1082
1064
|
<dl>
|
|
1083
1065
|
<dd>
|
|
1084
1066
|
|
|
1085
|
-
**
|
|
1086
|
-
|
|
1087
|
-
</dd>
|
|
1088
|
-
</dl>
|
|
1089
|
-
|
|
1090
|
-
<dl>
|
|
1091
|
-
<dd>
|
|
1092
|
-
|
|
1093
|
-
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1067
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
1094
1068
|
|
|
1095
1069
|
</dd>
|
|
1096
1070
|
</dl>
|
|
@@ -1109,7 +1083,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1109
1083
|
</dl>
|
|
1110
1084
|
</details>
|
|
1111
1085
|
|
|
1112
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1086
|
+
<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>
|
|
1113
1087
|
<dl>
|
|
1114
1088
|
<dd>
|
|
1115
1089
|
|
|
@@ -1121,7 +1095,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1121
1095
|
<dl>
|
|
1122
1096
|
<dd>
|
|
1123
1097
|
|
|
1124
|
-
|
|
1098
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1125
1099
|
|
|
1126
1100
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1127
1101
|
|
|
@@ -1139,7 +1113,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1139
1113
|
<dd>
|
|
1140
1114
|
|
|
1141
1115
|
```typescript
|
|
1142
|
-
await client.empathicVoice.prompts.
|
|
1116
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1117
|
+
name: "Weather Assistant Prompt",
|
|
1118
|
+
text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
1119
|
+
});
|
|
1143
1120
|
```
|
|
1144
1121
|
|
|
1145
1122
|
</dd>
|
|
@@ -1155,21 +1132,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1155
1132
|
<dl>
|
|
1156
1133
|
<dd>
|
|
1157
1134
|
|
|
1158
|
-
**
|
|
1159
|
-
|
|
1160
|
-
</dd>
|
|
1161
|
-
</dl>
|
|
1162
|
-
|
|
1163
|
-
<dl>
|
|
1164
|
-
<dd>
|
|
1165
|
-
|
|
1166
|
-
**version:** `number`
|
|
1167
|
-
|
|
1168
|
-
Version number for a Prompt.
|
|
1169
|
-
|
|
1170
|
-
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1171
|
-
|
|
1172
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1135
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
1173
1136
|
|
|
1174
1137
|
</dd>
|
|
1175
1138
|
</dl>
|
|
@@ -1188,7 +1151,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1188
1151
|
</dl>
|
|
1189
1152
|
</details>
|
|
1190
1153
|
|
|
1191
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1154
|
+
<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>
|
|
1192
1155
|
<dl>
|
|
1193
1156
|
<dd>
|
|
1194
1157
|
|
|
@@ -1200,7 +1163,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1200
1163
|
<dl>
|
|
1201
1164
|
<dd>
|
|
1202
1165
|
|
|
1203
|
-
|
|
1166
|
+
Fetches a list of a **Prompt's** versions.
|
|
1204
1167
|
|
|
1205
1168
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1206
1169
|
|
|
@@ -1218,7 +1181,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1218
1181
|
<dd>
|
|
1219
1182
|
|
|
1220
1183
|
```typescript
|
|
1221
|
-
await client.empathicVoice.prompts.
|
|
1184
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1222
1185
|
```
|
|
1223
1186
|
|
|
1224
1187
|
</dd>
|
|
@@ -1242,13 +1205,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1242
1205
|
<dl>
|
|
1243
1206
|
<dd>
|
|
1244
1207
|
|
|
1245
|
-
**
|
|
1246
|
-
|
|
1247
|
-
Version number for a Prompt.
|
|
1248
|
-
|
|
1249
|
-
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1250
|
-
|
|
1251
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1208
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1252
1209
|
|
|
1253
1210
|
</dd>
|
|
1254
1211
|
</dl>
|
|
@@ -1267,7 +1224,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1267
1224
|
</dl>
|
|
1268
1225
|
</details>
|
|
1269
1226
|
|
|
1270
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1227
|
+
<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>
|
|
1271
1228
|
<dl>
|
|
1272
1229
|
<dd>
|
|
1273
1230
|
|
|
@@ -1279,7 +1236,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1279
1236
|
<dl>
|
|
1280
1237
|
<dd>
|
|
1281
1238
|
|
|
1282
|
-
Updates
|
|
1239
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1283
1240
|
|
|
1284
1241
|
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1285
1242
|
|
|
@@ -1297,8 +1254,9 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for
|
|
|
1297
1254
|
<dd>
|
|
1298
1255
|
|
|
1299
1256
|
```typescript
|
|
1300
|
-
await client.empathicVoice.prompts.
|
|
1301
|
-
|
|
1257
|
+
await client.empathicVoice.prompts.createPromptVerison("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1258
|
+
text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
1259
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1302
1260
|
});
|
|
1303
1261
|
```
|
|
1304
1262
|
|
|
@@ -1323,21 +1281,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1323
1281
|
<dl>
|
|
1324
1282
|
<dd>
|
|
1325
1283
|
|
|
1326
|
-
**
|
|
1327
|
-
|
|
1328
|
-
Version number for a Prompt.
|
|
1329
|
-
|
|
1330
|
-
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1331
|
-
|
|
1332
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1333
|
-
|
|
1334
|
-
</dd>
|
|
1335
|
-
</dl>
|
|
1336
|
-
|
|
1337
|
-
<dl>
|
|
1338
|
-
<dd>
|
|
1339
|
-
|
|
1340
|
-
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1284
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1341
1285
|
|
|
1342
1286
|
</dd>
|
|
1343
1287
|
</dl>
|
|
@@ -1356,9 +1300,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1356
1300
|
</dl>
|
|
1357
1301
|
</details>
|
|
1358
1302
|
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1303
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
1362
1304
|
<dl>
|
|
1363
1305
|
<dd>
|
|
1364
1306
|
|
|
@@ -1370,9 +1312,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1370
1312
|
<dl>
|
|
1371
1313
|
<dd>
|
|
1372
1314
|
|
|
1373
|
-
|
|
1315
|
+
Deletes a **Prompt** and its versions.
|
|
1374
1316
|
|
|
1375
|
-
|
|
1317
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1376
1318
|
|
|
1377
1319
|
</dd>
|
|
1378
1320
|
</dl>
|
|
@@ -1388,7 +1330,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1388
1330
|
<dd>
|
|
1389
1331
|
|
|
1390
1332
|
```typescript
|
|
1391
|
-
await client.empathicVoice.
|
|
1333
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1392
1334
|
```
|
|
1393
1335
|
|
|
1394
1336
|
</dd>
|
|
@@ -1404,7 +1346,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1404
1346
|
<dl>
|
|
1405
1347
|
<dd>
|
|
1406
1348
|
|
|
1407
|
-
**
|
|
1349
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1408
1350
|
|
|
1409
1351
|
</dd>
|
|
1410
1352
|
</dl>
|
|
@@ -1412,7 +1354,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1412
1354
|
<dl>
|
|
1413
1355
|
<dd>
|
|
1414
1356
|
|
|
1415
|
-
**requestOptions:** `
|
|
1357
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1416
1358
|
|
|
1417
1359
|
</dd>
|
|
1418
1360
|
</dl>
|
|
@@ -1423,7 +1365,7 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1423
1365
|
</dl>
|
|
1424
1366
|
</details>
|
|
1425
1367
|
|
|
1426
|
-
<details><summary><code>client.empathicVoice.
|
|
1368
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1427
1369
|
<dl>
|
|
1428
1370
|
<dd>
|
|
1429
1371
|
|
|
@@ -1435,9 +1377,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1435
1377
|
<dl>
|
|
1436
1378
|
<dd>
|
|
1437
1379
|
|
|
1438
|
-
|
|
1380
|
+
Updates the name of a **Prompt**.
|
|
1439
1381
|
|
|
1440
|
-
|
|
1382
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1441
1383
|
|
|
1442
1384
|
</dd>
|
|
1443
1385
|
</dl>
|
|
@@ -1453,10 +1395,8 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1453
1395
|
<dd>
|
|
1454
1396
|
|
|
1455
1397
|
```typescript
|
|
1456
|
-
await client.empathicVoice.
|
|
1457
|
-
name: "
|
|
1458
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1459
|
-
parameterModel: "20241004-11parameter",
|
|
1398
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1399
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
1460
1400
|
});
|
|
1461
1401
|
```
|
|
1462
1402
|
|
|
@@ -1473,7 +1413,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1473
1413
|
<dl>
|
|
1474
1414
|
<dd>
|
|
1475
1415
|
|
|
1476
|
-
**
|
|
1416
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1477
1417
|
|
|
1478
1418
|
</dd>
|
|
1479
1419
|
</dl>
|
|
@@ -1481,7 +1421,15 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1481
1421
|
<dl>
|
|
1482
1422
|
<dd>
|
|
1483
1423
|
|
|
1484
|
-
**
|
|
1424
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1425
|
+
|
|
1426
|
+
</dd>
|
|
1427
|
+
</dl>
|
|
1428
|
+
|
|
1429
|
+
<dl>
|
|
1430
|
+
<dd>
|
|
1431
|
+
|
|
1432
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1485
1433
|
|
|
1486
1434
|
</dd>
|
|
1487
1435
|
</dl>
|
|
@@ -1492,7 +1440,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1492
1440
|
</dl>
|
|
1493
1441
|
</details>
|
|
1494
1442
|
|
|
1495
|
-
<details><summary><code>client.empathicVoice.
|
|
1443
|
+
<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>
|
|
1496
1444
|
<dl>
|
|
1497
1445
|
<dd>
|
|
1498
1446
|
|
|
@@ -1504,9 +1452,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
1504
1452
|
<dl>
|
|
1505
1453
|
<dd>
|
|
1506
1454
|
|
|
1507
|
-
Fetches a
|
|
1455
|
+
Fetches a specified version of a **Prompt**.
|
|
1508
1456
|
|
|
1509
|
-
|
|
1457
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1510
1458
|
|
|
1511
1459
|
</dd>
|
|
1512
1460
|
</dl>
|
|
@@ -1522,7 +1470,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1522
1470
|
<dd>
|
|
1523
1471
|
|
|
1524
1472
|
```typescript
|
|
1525
|
-
await client.empathicVoice.
|
|
1473
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
1526
1474
|
```
|
|
1527
1475
|
|
|
1528
1476
|
</dd>
|
|
@@ -1538,7 +1486,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1538
1486
|
<dl>
|
|
1539
1487
|
<dd>
|
|
1540
1488
|
|
|
1541
|
-
**id:** `string` — Identifier for a
|
|
1489
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1542
1490
|
|
|
1543
1491
|
</dd>
|
|
1544
1492
|
</dl>
|
|
@@ -1546,7 +1494,21 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1546
1494
|
<dl>
|
|
1547
1495
|
<dd>
|
|
1548
1496
|
|
|
1549
|
-
**
|
|
1497
|
+
**version:** `number`
|
|
1498
|
+
|
|
1499
|
+
Version number for a Prompt.
|
|
1500
|
+
|
|
1501
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1502
|
+
|
|
1503
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1504
|
+
|
|
1505
|
+
</dd>
|
|
1506
|
+
</dl>
|
|
1507
|
+
|
|
1508
|
+
<dl>
|
|
1509
|
+
<dd>
|
|
1510
|
+
|
|
1511
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1550
1512
|
|
|
1551
1513
|
</dd>
|
|
1552
1514
|
</dl>
|
|
@@ -1557,7 +1519,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1557
1519
|
</dl>
|
|
1558
1520
|
</details>
|
|
1559
1521
|
|
|
1560
|
-
<details><summary><code>client.empathicVoice.
|
|
1522
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
1561
1523
|
<dl>
|
|
1562
1524
|
<dd>
|
|
1563
1525
|
|
|
@@ -1569,9 +1531,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
1569
1531
|
<dl>
|
|
1570
1532
|
<dd>
|
|
1571
1533
|
|
|
1572
|
-
|
|
1534
|
+
Deletes a specified version of a **Prompt**.
|
|
1573
1535
|
|
|
1574
|
-
|
|
1536
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1575
1537
|
|
|
1576
1538
|
</dd>
|
|
1577
1539
|
</dl>
|
|
@@ -1587,11 +1549,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1587
1549
|
<dd>
|
|
1588
1550
|
|
|
1589
1551
|
```typescript
|
|
1590
|
-
await client.empathicVoice.
|
|
1591
|
-
name: "name",
|
|
1592
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1593
|
-
parameterModel: "20241004-11parameter",
|
|
1594
|
-
});
|
|
1552
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
1595
1553
|
```
|
|
1596
1554
|
|
|
1597
1555
|
</dd>
|
|
@@ -1607,7 +1565,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1607
1565
|
<dl>
|
|
1608
1566
|
<dd>
|
|
1609
1567
|
|
|
1610
|
-
**id:** `string` — Identifier for a
|
|
1568
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1611
1569
|
|
|
1612
1570
|
</dd>
|
|
1613
1571
|
</dl>
|
|
@@ -1615,7 +1573,13 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1615
1573
|
<dl>
|
|
1616
1574
|
<dd>
|
|
1617
1575
|
|
|
1618
|
-
**
|
|
1576
|
+
**version:** `number`
|
|
1577
|
+
|
|
1578
|
+
Version number for a Prompt.
|
|
1579
|
+
|
|
1580
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1581
|
+
|
|
1582
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1619
1583
|
|
|
1620
1584
|
</dd>
|
|
1621
1585
|
</dl>
|
|
@@ -1623,7 +1587,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1623
1587
|
<dl>
|
|
1624
1588
|
<dd>
|
|
1625
1589
|
|
|
1626
|
-
**requestOptions:** `
|
|
1590
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1627
1591
|
|
|
1628
1592
|
</dd>
|
|
1629
1593
|
</dl>
|
|
@@ -1634,7 +1598,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1634
1598
|
</dl>
|
|
1635
1599
|
</details>
|
|
1636
1600
|
|
|
1637
|
-
<details><summary><code>client.empathicVoice.
|
|
1601
|
+
<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>
|
|
1638
1602
|
<dl>
|
|
1639
1603
|
<dd>
|
|
1640
1604
|
|
|
@@ -1646,9 +1610,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
1646
1610
|
<dl>
|
|
1647
1611
|
<dd>
|
|
1648
1612
|
|
|
1649
|
-
|
|
1613
|
+
Updates the description of a **Prompt**.
|
|
1650
1614
|
|
|
1651
|
-
|
|
1615
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/phone-calling) for tips on crafting your system prompt.
|
|
1652
1616
|
|
|
1653
1617
|
</dd>
|
|
1654
1618
|
</dl>
|
|
@@ -1664,7 +1628,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for detai
|
|
|
1664
1628
|
<dd>
|
|
1665
1629
|
|
|
1666
1630
|
```typescript
|
|
1667
|
-
await client.empathicVoice.
|
|
1631
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1632
|
+
versionDescription: "This is an updated version_description.",
|
|
1633
|
+
});
|
|
1668
1634
|
```
|
|
1669
1635
|
|
|
1670
1636
|
</dd>
|
|
@@ -1680,7 +1646,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1680
1646
|
<dl>
|
|
1681
1647
|
<dd>
|
|
1682
1648
|
|
|
1683
|
-
**id:** `string` — Identifier for a
|
|
1649
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1684
1650
|
|
|
1685
1651
|
</dd>
|
|
1686
1652
|
</dl>
|
|
@@ -1688,7 +1654,29 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1688
1654
|
<dl>
|
|
1689
1655
|
<dd>
|
|
1690
1656
|
|
|
1691
|
-
**
|
|
1657
|
+
**version:** `number`
|
|
1658
|
+
|
|
1659
|
+
Version number for a Prompt.
|
|
1660
|
+
|
|
1661
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1662
|
+
|
|
1663
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1664
|
+
|
|
1665
|
+
</dd>
|
|
1666
|
+
</dl>
|
|
1667
|
+
|
|
1668
|
+
<dl>
|
|
1669
|
+
<dd>
|
|
1670
|
+
|
|
1671
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1672
|
+
|
|
1673
|
+
</dd>
|
|
1674
|
+
</dl>
|
|
1675
|
+
|
|
1676
|
+
<dl>
|
|
1677
|
+
<dd>
|
|
1678
|
+
|
|
1679
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1692
1680
|
|
|
1693
1681
|
</dd>
|
|
1694
1682
|
</dl>
|
|
@@ -1699,9 +1687,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1699
1687
|
</dl>
|
|
1700
1688
|
</details>
|
|
1701
1689
|
|
|
1702
|
-
## EmpathicVoice
|
|
1690
|
+
## EmpathicVoice CustomVoices
|
|
1703
1691
|
|
|
1704
|
-
<details><summary><code>client.empathicVoice.
|
|
1692
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1705
1693
|
<dl>
|
|
1706
1694
|
<dd>
|
|
1707
1695
|
|
|
@@ -1713,9 +1701,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
1713
1701
|
<dl>
|
|
1714
1702
|
<dd>
|
|
1715
1703
|
|
|
1716
|
-
Fetches a paginated list of **
|
|
1704
|
+
Fetches a paginated list of **Custom Voices**.
|
|
1717
1705
|
|
|
1718
|
-
|
|
1706
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1719
1707
|
|
|
1720
1708
|
</dd>
|
|
1721
1709
|
</dl>
|
|
@@ -1731,10 +1719,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1731
1719
|
<dd>
|
|
1732
1720
|
|
|
1733
1721
|
```typescript
|
|
1734
|
-
await client.empathicVoice.
|
|
1735
|
-
pageNumber: 0,
|
|
1736
|
-
pageSize: 1,
|
|
1737
|
-
});
|
|
1722
|
+
await client.empathicVoice.customVoices.listCustomVoices();
|
|
1738
1723
|
```
|
|
1739
1724
|
|
|
1740
1725
|
</dd>
|
|
@@ -1750,7 +1735,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1750
1735
|
<dl>
|
|
1751
1736
|
<dd>
|
|
1752
1737
|
|
|
1753
|
-
**request:** `Hume.empathicVoice.
|
|
1738
|
+
**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
|
|
1754
1739
|
|
|
1755
1740
|
</dd>
|
|
1756
1741
|
</dl>
|
|
@@ -1758,7 +1743,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1758
1743
|
<dl>
|
|
1759
1744
|
<dd>
|
|
1760
1745
|
|
|
1761
|
-
**requestOptions:** `
|
|
1746
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1762
1747
|
|
|
1763
1748
|
</dd>
|
|
1764
1749
|
</dl>
|
|
@@ -1769,7 +1754,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1769
1754
|
</dl>
|
|
1770
1755
|
</details>
|
|
1771
1756
|
|
|
1772
|
-
<details><summary><code>client.empathicVoice.
|
|
1757
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
1773
1758
|
<dl>
|
|
1774
1759
|
<dd>
|
|
1775
1760
|
|
|
@@ -1781,9 +1766,9 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
1781
1766
|
<dl>
|
|
1782
1767
|
<dd>
|
|
1783
1768
|
|
|
1784
|
-
Creates a **
|
|
1769
|
+
Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1785
1770
|
|
|
1786
|
-
|
|
1771
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1787
1772
|
|
|
1788
1773
|
</dd>
|
|
1789
1774
|
</dl>
|
|
@@ -1799,36 +1784,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1799
1784
|
<dd>
|
|
1800
1785
|
|
|
1801
1786
|
```typescript
|
|
1802
|
-
await client.empathicVoice.
|
|
1803
|
-
name: "
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
version: 0,
|
|
1807
|
-
},
|
|
1808
|
-
eviVersion: "2",
|
|
1809
|
-
voice: {
|
|
1810
|
-
provider: "HUME_AI",
|
|
1811
|
-
name: "SAMPLE VOICE",
|
|
1812
|
-
},
|
|
1813
|
-
languageModel: {
|
|
1814
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1815
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
1816
|
-
temperature: 1,
|
|
1817
|
-
},
|
|
1818
|
-
eventMessages: {
|
|
1819
|
-
onNewChat: {
|
|
1820
|
-
enabled: false,
|
|
1821
|
-
text: "",
|
|
1822
|
-
},
|
|
1823
|
-
onInactivityTimeout: {
|
|
1824
|
-
enabled: false,
|
|
1825
|
-
text: "",
|
|
1826
|
-
},
|
|
1827
|
-
onMaxDurationTimeout: {
|
|
1828
|
-
enabled: false,
|
|
1829
|
-
text: "",
|
|
1830
|
-
},
|
|
1831
|
-
},
|
|
1787
|
+
await client.empathicVoice.customVoices.createCustomVoice({
|
|
1788
|
+
name: "name",
|
|
1789
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1790
|
+
parameterModel: "20241004-11parameter",
|
|
1832
1791
|
});
|
|
1833
1792
|
```
|
|
1834
1793
|
|
|
@@ -1845,7 +1804,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1845
1804
|
<dl>
|
|
1846
1805
|
<dd>
|
|
1847
1806
|
|
|
1848
|
-
**request:** `Hume.
|
|
1807
|
+
**request:** `Hume.PostedCustomVoice`
|
|
1849
1808
|
|
|
1850
1809
|
</dd>
|
|
1851
1810
|
</dl>
|
|
@@ -1853,7 +1812,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1853
1812
|
<dl>
|
|
1854
1813
|
<dd>
|
|
1855
1814
|
|
|
1856
|
-
**requestOptions:** `
|
|
1815
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1857
1816
|
|
|
1858
1817
|
</dd>
|
|
1859
1818
|
</dl>
|
|
@@ -1864,7 +1823,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1864
1823
|
</dl>
|
|
1865
1824
|
</details>
|
|
1866
1825
|
|
|
1867
|
-
<details><summary><code>client.empathicVoice.
|
|
1826
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
|
|
1868
1827
|
<dl>
|
|
1869
1828
|
<dd>
|
|
1870
1829
|
|
|
@@ -1876,9 +1835,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1876
1835
|
<dl>
|
|
1877
1836
|
<dd>
|
|
1878
1837
|
|
|
1879
|
-
Fetches a
|
|
1838
|
+
Fetches a specific **Custom Voice** by ID.
|
|
1880
1839
|
|
|
1881
|
-
|
|
1840
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1882
1841
|
|
|
1883
1842
|
</dd>
|
|
1884
1843
|
</dl>
|
|
@@ -1894,7 +1853,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1894
1853
|
<dd>
|
|
1895
1854
|
|
|
1896
1855
|
```typescript
|
|
1897
|
-
await client.empathicVoice.
|
|
1856
|
+
await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
1898
1857
|
```
|
|
1899
1858
|
|
|
1900
1859
|
</dd>
|
|
@@ -1910,15 +1869,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1910
1869
|
<dl>
|
|
1911
1870
|
<dd>
|
|
1912
1871
|
|
|
1913
|
-
**id:** `string` — Identifier for a
|
|
1914
|
-
|
|
1915
|
-
</dd>
|
|
1916
|
-
</dl>
|
|
1917
|
-
|
|
1918
|
-
<dl>
|
|
1919
|
-
<dd>
|
|
1920
|
-
|
|
1921
|
-
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
1872
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1922
1873
|
|
|
1923
1874
|
</dd>
|
|
1924
1875
|
</dl>
|
|
@@ -1926,7 +1877,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1926
1877
|
<dl>
|
|
1927
1878
|
<dd>
|
|
1928
1879
|
|
|
1929
|
-
**requestOptions:** `
|
|
1880
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1930
1881
|
|
|
1931
1882
|
</dd>
|
|
1932
1883
|
</dl>
|
|
@@ -1937,7 +1888,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1937
1888
|
</dl>
|
|
1938
1889
|
</details>
|
|
1939
1890
|
|
|
1940
|
-
<details><summary><code>client.empathicVoice.
|
|
1891
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoiceVersion</a>(id, { ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
1941
1892
|
<dl>
|
|
1942
1893
|
<dd>
|
|
1943
1894
|
|
|
@@ -1949,9 +1900,9 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
1949
1900
|
<dl>
|
|
1950
1901
|
<dd>
|
|
1951
1902
|
|
|
1952
|
-
Updates a **
|
|
1903
|
+
Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
|
|
1953
1904
|
|
|
1954
|
-
|
|
1905
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
1955
1906
|
|
|
1956
1907
|
</dd>
|
|
1957
1908
|
</dl>
|
|
@@ -1967,39 +1918,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1967
1918
|
<dd>
|
|
1968
1919
|
|
|
1969
1920
|
```typescript
|
|
1970
|
-
await client.empathicVoice.
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1975
|
-
version: 0,
|
|
1976
|
-
},
|
|
1977
|
-
voice: {
|
|
1978
|
-
provider: "HUME_AI",
|
|
1979
|
-
name: "ITO",
|
|
1980
|
-
},
|
|
1981
|
-
languageModel: {
|
|
1982
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
1983
|
-
modelResource: "claude-3-5-sonnet-20240620",
|
|
1984
|
-
temperature: 1,
|
|
1985
|
-
},
|
|
1986
|
-
ellmModel: {
|
|
1987
|
-
allowShortResponses: true,
|
|
1988
|
-
},
|
|
1989
|
-
eventMessages: {
|
|
1990
|
-
onNewChat: {
|
|
1991
|
-
enabled: false,
|
|
1992
|
-
text: "",
|
|
1993
|
-
},
|
|
1994
|
-
onInactivityTimeout: {
|
|
1995
|
-
enabled: false,
|
|
1996
|
-
text: "",
|
|
1997
|
-
},
|
|
1998
|
-
onMaxDurationTimeout: {
|
|
1999
|
-
enabled: false,
|
|
2000
|
-
text: "",
|
|
2001
|
-
},
|
|
2002
|
-
},
|
|
1921
|
+
await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
1922
|
+
name: "name",
|
|
1923
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1924
|
+
parameterModel: "20241004-11parameter",
|
|
2003
1925
|
});
|
|
2004
1926
|
```
|
|
2005
1927
|
|
|
@@ -2016,7 +1938,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2016
1938
|
<dl>
|
|
2017
1939
|
<dd>
|
|
2018
1940
|
|
|
2019
|
-
**id:** `string` — Identifier for a
|
|
1941
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2020
1942
|
|
|
2021
1943
|
</dd>
|
|
2022
1944
|
</dl>
|
|
@@ -2024,7 +1946,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2024
1946
|
<dl>
|
|
2025
1947
|
<dd>
|
|
2026
1948
|
|
|
2027
|
-
**request:** `Hume.
|
|
1949
|
+
**request:** `Hume.PostedCustomVoice`
|
|
2028
1950
|
|
|
2029
1951
|
</dd>
|
|
2030
1952
|
</dl>
|
|
@@ -2032,7 +1954,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2032
1954
|
<dl>
|
|
2033
1955
|
<dd>
|
|
2034
1956
|
|
|
2035
|
-
**requestOptions:** `
|
|
1957
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2036
1958
|
|
|
2037
1959
|
</dd>
|
|
2038
1960
|
</dl>
|
|
@@ -2043,7 +1965,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2043
1965
|
</dl>
|
|
2044
1966
|
</details>
|
|
2045
1967
|
|
|
2046
|
-
<details><summary><code>client.empathicVoice.
|
|
1968
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
|
|
2047
1969
|
<dl>
|
|
2048
1970
|
<dd>
|
|
2049
1971
|
|
|
@@ -2055,9 +1977,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2055
1977
|
<dl>
|
|
2056
1978
|
<dd>
|
|
2057
1979
|
|
|
2058
|
-
Deletes a **
|
|
1980
|
+
Deletes a **Custom Voice** and its versions.
|
|
2059
1981
|
|
|
2060
|
-
|
|
1982
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/voices) for details on creating a custom voice.
|
|
2061
1983
|
|
|
2062
1984
|
</dd>
|
|
2063
1985
|
</dl>
|
|
@@ -2073,7 +1995,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2073
1995
|
<dd>
|
|
2074
1996
|
|
|
2075
1997
|
```typescript
|
|
2076
|
-
await client.empathicVoice.
|
|
1998
|
+
await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
2077
1999
|
```
|
|
2078
2000
|
|
|
2079
2001
|
</dd>
|
|
@@ -2089,7 +2011,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2089
2011
|
<dl>
|
|
2090
2012
|
<dd>
|
|
2091
2013
|
|
|
2092
|
-
**id:** `string` — Identifier for a
|
|
2014
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2093
2015
|
|
|
2094
2016
|
</dd>
|
|
2095
2017
|
</dl>
|
|
@@ -2097,7 +2019,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2097
2019
|
<dl>
|
|
2098
2020
|
<dd>
|
|
2099
2021
|
|
|
2100
|
-
**requestOptions:** `
|
|
2022
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2101
2023
|
|
|
2102
2024
|
</dd>
|
|
2103
2025
|
</dl>
|
|
@@ -2108,7 +2030,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2108
2030
|
</dl>
|
|
2109
2031
|
</details>
|
|
2110
2032
|
|
|
2111
|
-
|
|
2033
|
+
## EmpathicVoice Configs
|
|
2034
|
+
|
|
2035
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2112
2036
|
<dl>
|
|
2113
2037
|
<dd>
|
|
2114
2038
|
|
|
@@ -2120,7 +2044,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2120
2044
|
<dl>
|
|
2121
2045
|
<dd>
|
|
2122
2046
|
|
|
2123
|
-
|
|
2047
|
+
Fetches a paginated list of **Configs**.
|
|
2124
2048
|
|
|
2125
2049
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2126
2050
|
|
|
@@ -2138,8 +2062,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2138
2062
|
<dd>
|
|
2139
2063
|
|
|
2140
2064
|
```typescript
|
|
2141
|
-
await client.empathicVoice.configs.
|
|
2142
|
-
|
|
2065
|
+
await client.empathicVoice.configs.listConfigs({
|
|
2066
|
+
pageNumber: 0,
|
|
2067
|
+
pageSize: 1,
|
|
2143
2068
|
});
|
|
2144
2069
|
```
|
|
2145
2070
|
|
|
@@ -2156,15 +2081,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2156
2081
|
<dl>
|
|
2157
2082
|
<dd>
|
|
2158
2083
|
|
|
2159
|
-
**
|
|
2160
|
-
|
|
2161
|
-
</dd>
|
|
2162
|
-
</dl>
|
|
2163
|
-
|
|
2164
|
-
<dl>
|
|
2165
|
-
<dd>
|
|
2166
|
-
|
|
2167
|
-
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2084
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
2168
2085
|
|
|
2169
2086
|
</dd>
|
|
2170
2087
|
</dl>
|
|
@@ -2183,7 +2100,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2183
2100
|
</dl>
|
|
2184
2101
|
</details>
|
|
2185
2102
|
|
|
2186
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2103
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2187
2104
|
<dl>
|
|
2188
2105
|
<dd>
|
|
2189
2106
|
|
|
@@ -2195,7 +2112,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2195
2112
|
<dl>
|
|
2196
2113
|
<dd>
|
|
2197
2114
|
|
|
2198
|
-
|
|
2115
|
+
Creates a **Config** which can be applied to EVI.
|
|
2199
2116
|
|
|
2200
2117
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2201
2118
|
|
|
@@ -2213,7 +2130,37 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2213
2130
|
<dd>
|
|
2214
2131
|
|
|
2215
2132
|
```typescript
|
|
2216
|
-
await client.empathicVoice.configs.
|
|
2133
|
+
await client.empathicVoice.configs.createConfig({
|
|
2134
|
+
name: "Weather Assistant Config",
|
|
2135
|
+
prompt: {
|
|
2136
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2137
|
+
version: 0,
|
|
2138
|
+
},
|
|
2139
|
+
eviVersion: "2",
|
|
2140
|
+
voice: {
|
|
2141
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2142
|
+
name: "SAMPLE VOICE",
|
|
2143
|
+
},
|
|
2144
|
+
languageModel: {
|
|
2145
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2146
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2147
|
+
temperature: 1,
|
|
2148
|
+
},
|
|
2149
|
+
eventMessages: {
|
|
2150
|
+
onNewChat: {
|
|
2151
|
+
enabled: false,
|
|
2152
|
+
text: "",
|
|
2153
|
+
},
|
|
2154
|
+
onInactivityTimeout: {
|
|
2155
|
+
enabled: false,
|
|
2156
|
+
text: "",
|
|
2157
|
+
},
|
|
2158
|
+
onMaxDurationTimeout: {
|
|
2159
|
+
enabled: false,
|
|
2160
|
+
text: "",
|
|
2161
|
+
},
|
|
2162
|
+
},
|
|
2163
|
+
});
|
|
2217
2164
|
```
|
|
2218
2165
|
|
|
2219
2166
|
</dd>
|
|
@@ -2229,21 +2176,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2229
2176
|
<dl>
|
|
2230
2177
|
<dd>
|
|
2231
2178
|
|
|
2232
|
-
**
|
|
2233
|
-
|
|
2234
|
-
</dd>
|
|
2235
|
-
</dl>
|
|
2236
|
-
|
|
2237
|
-
<dl>
|
|
2238
|
-
<dd>
|
|
2239
|
-
|
|
2240
|
-
**version:** `number`
|
|
2241
|
-
|
|
2242
|
-
Version number for a Config.
|
|
2243
|
-
|
|
2244
|
-
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2245
|
-
|
|
2246
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2179
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
2247
2180
|
|
|
2248
2181
|
</dd>
|
|
2249
2182
|
</dl>
|
|
@@ -2262,7 +2195,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2262
2195
|
</dl>
|
|
2263
2196
|
</details>
|
|
2264
2197
|
|
|
2265
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2198
|
+
<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>
|
|
2266
2199
|
<dl>
|
|
2267
2200
|
<dd>
|
|
2268
2201
|
|
|
@@ -2274,7 +2207,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2274
2207
|
<dl>
|
|
2275
2208
|
<dd>
|
|
2276
2209
|
|
|
2277
|
-
|
|
2210
|
+
Fetches a list of a **Config's** versions.
|
|
2278
2211
|
|
|
2279
2212
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2280
2213
|
|
|
@@ -2292,7 +2225,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2292
2225
|
<dd>
|
|
2293
2226
|
|
|
2294
2227
|
```typescript
|
|
2295
|
-
await client.empathicVoice.configs.
|
|
2228
|
+
await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2296
2229
|
```
|
|
2297
2230
|
|
|
2298
2231
|
</dd>
|
|
@@ -2316,13 +2249,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2316
2249
|
<dl>
|
|
2317
2250
|
<dd>
|
|
2318
2251
|
|
|
2319
|
-
**
|
|
2320
|
-
|
|
2321
|
-
Version number for a Config.
|
|
2322
|
-
|
|
2323
|
-
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2324
|
-
|
|
2325
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2252
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2326
2253
|
|
|
2327
2254
|
</dd>
|
|
2328
2255
|
</dl>
|
|
@@ -2341,7 +2268,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2341
2268
|
</dl>
|
|
2342
2269
|
</details>
|
|
2343
2270
|
|
|
2344
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2271
|
+
<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>
|
|
2345
2272
|
<dl>
|
|
2346
2273
|
<dd>
|
|
2347
2274
|
|
|
@@ -2353,7 +2280,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2353
2280
|
<dl>
|
|
2354
2281
|
<dd>
|
|
2355
2282
|
|
|
2356
|
-
Updates
|
|
2283
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
2357
2284
|
|
|
2358
2285
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2359
2286
|
|
|
@@ -2371,8 +2298,39 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2371
2298
|
<dd>
|
|
2372
2299
|
|
|
2373
2300
|
```typescript
|
|
2374
|
-
await client.empathicVoice.configs.
|
|
2375
|
-
versionDescription: "This is an updated
|
|
2301
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2302
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2303
|
+
eviVersion: "2",
|
|
2304
|
+
prompt: {
|
|
2305
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2306
|
+
version: 0,
|
|
2307
|
+
},
|
|
2308
|
+
voice: {
|
|
2309
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2310
|
+
name: "ITO",
|
|
2311
|
+
},
|
|
2312
|
+
languageModel: {
|
|
2313
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2314
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2315
|
+
temperature: 1,
|
|
2316
|
+
},
|
|
2317
|
+
ellmModel: {
|
|
2318
|
+
allowShortResponses: true,
|
|
2319
|
+
},
|
|
2320
|
+
eventMessages: {
|
|
2321
|
+
onNewChat: {
|
|
2322
|
+
enabled: false,
|
|
2323
|
+
text: "",
|
|
2324
|
+
},
|
|
2325
|
+
onInactivityTimeout: {
|
|
2326
|
+
enabled: false,
|
|
2327
|
+
text: "",
|
|
2328
|
+
},
|
|
2329
|
+
onMaxDurationTimeout: {
|
|
2330
|
+
enabled: false,
|
|
2331
|
+
text: "",
|
|
2332
|
+
},
|
|
2333
|
+
},
|
|
2376
2334
|
});
|
|
2377
2335
|
```
|
|
2378
2336
|
|
|
@@ -2397,21 +2355,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
2397
2355
|
<dl>
|
|
2398
2356
|
<dd>
|
|
2399
2357
|
|
|
2400
|
-
**
|
|
2401
|
-
|
|
2402
|
-
Version number for a Config.
|
|
2403
|
-
|
|
2404
|
-
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2405
|
-
|
|
2406
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2407
|
-
|
|
2408
|
-
</dd>
|
|
2409
|
-
</dl>
|
|
2410
|
-
|
|
2411
|
-
<dl>
|
|
2412
|
-
<dd>
|
|
2413
|
-
|
|
2414
|
-
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2358
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2415
2359
|
|
|
2416
2360
|
</dd>
|
|
2417
2361
|
</dl>
|
|
@@ -2430,9 +2374,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2430
2374
|
</dl>
|
|
2431
2375
|
</details>
|
|
2432
2376
|
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2377
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
2436
2378
|
<dl>
|
|
2437
2379
|
<dd>
|
|
2438
2380
|
|
|
@@ -2444,7 +2386,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2444
2386
|
<dl>
|
|
2445
2387
|
<dd>
|
|
2446
2388
|
|
|
2447
|
-
|
|
2389
|
+
Deletes a **Config** and its versions.
|
|
2390
|
+
|
|
2391
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2448
2392
|
|
|
2449
2393
|
</dd>
|
|
2450
2394
|
</dl>
|
|
@@ -2460,11 +2404,7 @@ Fetches a paginated list of **Chats**.
|
|
|
2460
2404
|
<dd>
|
|
2461
2405
|
|
|
2462
2406
|
```typescript
|
|
2463
|
-
await client.empathicVoice.
|
|
2464
|
-
pageNumber: 0,
|
|
2465
|
-
pageSize: 1,
|
|
2466
|
-
ascendingOrder: true,
|
|
2467
|
-
});
|
|
2407
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2468
2408
|
```
|
|
2469
2409
|
|
|
2470
2410
|
</dd>
|
|
@@ -2480,7 +2420,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2480
2420
|
<dl>
|
|
2481
2421
|
<dd>
|
|
2482
2422
|
|
|
2483
|
-
**
|
|
2423
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2484
2424
|
|
|
2485
2425
|
</dd>
|
|
2486
2426
|
</dl>
|
|
@@ -2488,7 +2428,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2488
2428
|
<dl>
|
|
2489
2429
|
<dd>
|
|
2490
2430
|
|
|
2491
|
-
**requestOptions:** `
|
|
2431
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2492
2432
|
|
|
2493
2433
|
</dd>
|
|
2494
2434
|
</dl>
|
|
@@ -2499,7 +2439,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
2499
2439
|
</dl>
|
|
2500
2440
|
</details>
|
|
2501
2441
|
|
|
2502
|
-
<details><summary><code>client.empathicVoice.
|
|
2442
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
2503
2443
|
<dl>
|
|
2504
2444
|
<dd>
|
|
2505
2445
|
|
|
@@ -2511,7 +2451,9 @@ await client.empathicVoice.chats.listChats({
|
|
|
2511
2451
|
<dl>
|
|
2512
2452
|
<dd>
|
|
2513
2453
|
|
|
2514
|
-
|
|
2454
|
+
Updates the name of a **Config**.
|
|
2455
|
+
|
|
2456
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2515
2457
|
|
|
2516
2458
|
</dd>
|
|
2517
2459
|
</dl>
|
|
@@ -2527,10 +2469,8 @@ Fetches a paginated list of **Chat** events.
|
|
|
2527
2469
|
<dd>
|
|
2528
2470
|
|
|
2529
2471
|
```typescript
|
|
2530
|
-
await client.empathicVoice.
|
|
2531
|
-
|
|
2532
|
-
pageSize: 3,
|
|
2533
|
-
ascendingOrder: true,
|
|
2472
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2473
|
+
name: "Updated Weather Assistant Config Name",
|
|
2534
2474
|
});
|
|
2535
2475
|
```
|
|
2536
2476
|
|
|
@@ -2547,7 +2487,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2547
2487
|
<dl>
|
|
2548
2488
|
<dd>
|
|
2549
2489
|
|
|
2550
|
-
**id:** `string` — Identifier for a
|
|
2490
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2551
2491
|
|
|
2552
2492
|
</dd>
|
|
2553
2493
|
</dl>
|
|
@@ -2555,7 +2495,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2555
2495
|
<dl>
|
|
2556
2496
|
<dd>
|
|
2557
2497
|
|
|
2558
|
-
**request:** `Hume.empathicVoice.
|
|
2498
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2559
2499
|
|
|
2560
2500
|
</dd>
|
|
2561
2501
|
</dl>
|
|
@@ -2563,7 +2503,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2563
2503
|
<dl>
|
|
2564
2504
|
<dd>
|
|
2565
2505
|
|
|
2566
|
-
**requestOptions:** `
|
|
2506
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2567
2507
|
|
|
2568
2508
|
</dd>
|
|
2569
2509
|
</dl>
|
|
@@ -2574,10 +2514,27 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2574
2514
|
</dl>
|
|
2575
2515
|
</details>
|
|
2576
2516
|
|
|
2577
|
-
<details><summary><code>client.empathicVoice.
|
|
2517
|
+
<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>
|
|
2518
|
+
<dl>
|
|
2519
|
+
<dd>
|
|
2520
|
+
|
|
2521
|
+
#### 📝 Description
|
|
2522
|
+
|
|
2523
|
+
<dl>
|
|
2524
|
+
<dd>
|
|
2525
|
+
|
|
2578
2526
|
<dl>
|
|
2579
2527
|
<dd>
|
|
2580
2528
|
|
|
2529
|
+
Fetches a specified version of a **Config**.
|
|
2530
|
+
|
|
2531
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2532
|
+
|
|
2533
|
+
</dd>
|
|
2534
|
+
</dl>
|
|
2535
|
+
</dd>
|
|
2536
|
+
</dl>
|
|
2537
|
+
|
|
2581
2538
|
#### 🔌 Usage
|
|
2582
2539
|
|
|
2583
2540
|
<dl>
|
|
@@ -2587,7 +2544,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
2587
2544
|
<dd>
|
|
2588
2545
|
|
|
2589
2546
|
```typescript
|
|
2590
|
-
await client.empathicVoice.
|
|
2547
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2591
2548
|
```
|
|
2592
2549
|
|
|
2593
2550
|
</dd>
|
|
@@ -2603,7 +2560,7 @@ await client.empathicVoice.chats.getAudio("id");
|
|
|
2603
2560
|
<dl>
|
|
2604
2561
|
<dd>
|
|
2605
2562
|
|
|
2606
|
-
**id:** `string` — Identifier for a
|
|
2563
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2607
2564
|
|
|
2608
2565
|
</dd>
|
|
2609
2566
|
</dl>
|
|
@@ -2611,7 +2568,21 @@ await client.empathicVoice.chats.getAudio("id");
|
|
|
2611
2568
|
<dl>
|
|
2612
2569
|
<dd>
|
|
2613
2570
|
|
|
2614
|
-
**
|
|
2571
|
+
**version:** `number`
|
|
2572
|
+
|
|
2573
|
+
Version number for a Config.
|
|
2574
|
+
|
|
2575
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2576
|
+
|
|
2577
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2578
|
+
|
|
2579
|
+
</dd>
|
|
2580
|
+
</dl>
|
|
2581
|
+
|
|
2582
|
+
<dl>
|
|
2583
|
+
<dd>
|
|
2584
|
+
|
|
2585
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2615
2586
|
|
|
2616
2587
|
</dd>
|
|
2617
2588
|
</dl>
|
|
@@ -2622,9 +2593,7 @@ await client.empathicVoice.chats.getAudio("id");
|
|
|
2622
2593
|
</dl>
|
|
2623
2594
|
</details>
|
|
2624
2595
|
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
2596
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
2628
2597
|
<dl>
|
|
2629
2598
|
<dd>
|
|
2630
2599
|
|
|
@@ -2636,7 +2605,9 @@ await client.empathicVoice.chats.getAudio("id");
|
|
|
2636
2605
|
<dl>
|
|
2637
2606
|
<dd>
|
|
2638
2607
|
|
|
2639
|
-
|
|
2608
|
+
Deletes a specified version of a **Config**.
|
|
2609
|
+
|
|
2610
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2640
2611
|
|
|
2641
2612
|
</dd>
|
|
2642
2613
|
</dl>
|
|
@@ -2652,12 +2623,7 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
2652
2623
|
<dd>
|
|
2653
2624
|
|
|
2654
2625
|
```typescript
|
|
2655
|
-
await client.empathicVoice.
|
|
2656
|
-
pageNumber: 0,
|
|
2657
|
-
pageSize: 1,
|
|
2658
|
-
ascendingOrder: true,
|
|
2659
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2660
|
-
});
|
|
2626
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2661
2627
|
```
|
|
2662
2628
|
|
|
2663
2629
|
</dd>
|
|
@@ -2673,7 +2639,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2673
2639
|
<dl>
|
|
2674
2640
|
<dd>
|
|
2675
2641
|
|
|
2676
|
-
**
|
|
2642
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2677
2643
|
|
|
2678
2644
|
</dd>
|
|
2679
2645
|
</dl>
|
|
@@ -2681,7 +2647,21 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2681
2647
|
<dl>
|
|
2682
2648
|
<dd>
|
|
2683
2649
|
|
|
2684
|
-
**
|
|
2650
|
+
**version:** `number`
|
|
2651
|
+
|
|
2652
|
+
Version number for a Config.
|
|
2653
|
+
|
|
2654
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2655
|
+
|
|
2656
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2657
|
+
|
|
2658
|
+
</dd>
|
|
2659
|
+
</dl>
|
|
2660
|
+
|
|
2661
|
+
<dl>
|
|
2662
|
+
<dd>
|
|
2663
|
+
|
|
2664
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2685
2665
|
|
|
2686
2666
|
</dd>
|
|
2687
2667
|
</dl>
|
|
@@ -2692,7 +2672,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2692
2672
|
</dl>
|
|
2693
2673
|
</details>
|
|
2694
2674
|
|
|
2695
|
-
<details><summary><code>client.empathicVoice.
|
|
2675
|
+
<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>
|
|
2696
2676
|
<dl>
|
|
2697
2677
|
<dd>
|
|
2698
2678
|
|
|
@@ -2704,7 +2684,9 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
2704
2684
|
<dl>
|
|
2705
2685
|
<dd>
|
|
2706
2686
|
|
|
2707
|
-
|
|
2687
|
+
Updates the description of a **Config**.
|
|
2688
|
+
|
|
2689
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2708
2690
|
|
|
2709
2691
|
</dd>
|
|
2710
2692
|
</dl>
|
|
@@ -2720,10 +2702,8 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
2720
2702
|
<dd>
|
|
2721
2703
|
|
|
2722
2704
|
```typescript
|
|
2723
|
-
await client.empathicVoice.
|
|
2724
|
-
|
|
2725
|
-
pageSize: 1,
|
|
2726
|
-
ascendingOrder: true,
|
|
2705
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
2706
|
+
versionDescription: "This is an updated version_description.",
|
|
2727
2707
|
});
|
|
2728
2708
|
```
|
|
2729
2709
|
|
|
@@ -2740,7 +2720,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2740
2720
|
<dl>
|
|
2741
2721
|
<dd>
|
|
2742
2722
|
|
|
2743
|
-
**id:** `string` — Identifier for a
|
|
2723
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2744
2724
|
|
|
2745
2725
|
</dd>
|
|
2746
2726
|
</dl>
|
|
@@ -2748,7 +2728,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2748
2728
|
<dl>
|
|
2749
2729
|
<dd>
|
|
2750
2730
|
|
|
2751
|
-
**
|
|
2731
|
+
**version:** `number`
|
|
2732
|
+
|
|
2733
|
+
Version number for a Config.
|
|
2734
|
+
|
|
2735
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2736
|
+
|
|
2737
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2752
2738
|
|
|
2753
2739
|
</dd>
|
|
2754
2740
|
</dl>
|
|
@@ -2756,7 +2742,15 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2756
2742
|
<dl>
|
|
2757
2743
|
<dd>
|
|
2758
2744
|
|
|
2759
|
-
**
|
|
2745
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2746
|
+
|
|
2747
|
+
</dd>
|
|
2748
|
+
</dl>
|
|
2749
|
+
|
|
2750
|
+
<dl>
|
|
2751
|
+
<dd>
|
|
2752
|
+
|
|
2753
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2760
2754
|
|
|
2761
2755
|
</dd>
|
|
2762
2756
|
</dl>
|
|
@@ -2767,7 +2761,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2767
2761
|
</dl>
|
|
2768
2762
|
</details>
|
|
2769
2763
|
|
|
2770
|
-
|
|
2764
|
+
## EmpathicVoice Chats
|
|
2765
|
+
|
|
2766
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2771
2767
|
<dl>
|
|
2772
2768
|
<dd>
|
|
2773
2769
|
|
|
@@ -2779,7 +2775,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2779
2775
|
<dl>
|
|
2780
2776
|
<dd>
|
|
2781
2777
|
|
|
2782
|
-
Fetches a paginated list of **
|
|
2778
|
+
Fetches a paginated list of **Chats**.
|
|
2783
2779
|
|
|
2784
2780
|
</dd>
|
|
2785
2781
|
</dl>
|
|
@@ -2795,9 +2791,9 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
2795
2791
|
<dd>
|
|
2796
2792
|
|
|
2797
2793
|
```typescript
|
|
2798
|
-
await client.empathicVoice.
|
|
2794
|
+
await client.empathicVoice.chats.listChats({
|
|
2799
2795
|
pageNumber: 0,
|
|
2800
|
-
pageSize:
|
|
2796
|
+
pageSize: 1,
|
|
2801
2797
|
ascendingOrder: true,
|
|
2802
2798
|
});
|
|
2803
2799
|
```
|
|
@@ -2815,15 +2811,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2815
2811
|
<dl>
|
|
2816
2812
|
<dd>
|
|
2817
2813
|
|
|
2818
|
-
**
|
|
2819
|
-
|
|
2820
|
-
</dd>
|
|
2821
|
-
</dl>
|
|
2822
|
-
|
|
2823
|
-
<dl>
|
|
2824
|
-
<dd>
|
|
2825
|
-
|
|
2826
|
-
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
2814
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
2827
2815
|
|
|
2828
2816
|
</dd>
|
|
2829
2817
|
</dl>
|
|
@@ -2831,7 +2819,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2831
2819
|
<dl>
|
|
2832
2820
|
<dd>
|
|
2833
2821
|
|
|
2834
|
-
**requestOptions:** `
|
|
2822
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2835
2823
|
|
|
2836
2824
|
</dd>
|
|
2837
2825
|
</dl>
|
|
@@ -2842,10 +2830,25 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2842
2830
|
</dl>
|
|
2843
2831
|
</details>
|
|
2844
2832
|
|
|
2845
|
-
<details><summary><code>client.empathicVoice.
|
|
2833
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
|
|
2834
|
+
<dl>
|
|
2835
|
+
<dd>
|
|
2836
|
+
|
|
2837
|
+
#### 📝 Description
|
|
2838
|
+
|
|
2839
|
+
<dl>
|
|
2840
|
+
<dd>
|
|
2841
|
+
|
|
2846
2842
|
<dl>
|
|
2847
2843
|
<dd>
|
|
2848
2844
|
|
|
2845
|
+
Fetches a paginated list of **Chat** events.
|
|
2846
|
+
|
|
2847
|
+
</dd>
|
|
2848
|
+
</dl>
|
|
2849
|
+
</dd>
|
|
2850
|
+
</dl>
|
|
2851
|
+
|
|
2849
2852
|
#### 🔌 Usage
|
|
2850
2853
|
|
|
2851
2854
|
<dl>
|
|
@@ -2855,7 +2858,11 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
2855
2858
|
<dd>
|
|
2856
2859
|
|
|
2857
2860
|
```typescript
|
|
2858
|
-
await client.empathicVoice.
|
|
2861
|
+
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2862
|
+
pageNumber: 0,
|
|
2863
|
+
pageSize: 3,
|
|
2864
|
+
ascendingOrder: true,
|
|
2865
|
+
});
|
|
2859
2866
|
```
|
|
2860
2867
|
|
|
2861
2868
|
</dd>
|
|
@@ -2871,7 +2878,7 @@ await client.empathicVoice.chatGroups.getAudio("id");
|
|
|
2871
2878
|
<dl>
|
|
2872
2879
|
<dd>
|
|
2873
2880
|
|
|
2874
|
-
**id:** `string` — Identifier for a
|
|
2881
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
2875
2882
|
|
|
2876
2883
|
</dd>
|
|
2877
2884
|
</dl>
|
|
@@ -2879,7 +2886,7 @@ await client.empathicVoice.chatGroups.getAudio("id");
|
|
|
2879
2886
|
<dl>
|
|
2880
2887
|
<dd>
|
|
2881
2888
|
|
|
2882
|
-
**request:** `Hume.empathicVoice.
|
|
2889
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
2883
2890
|
|
|
2884
2891
|
</dd>
|
|
2885
2892
|
</dl>
|
|
@@ -2887,7 +2894,7 @@ await client.empathicVoice.chatGroups.getAudio("id");
|
|
|
2887
2894
|
<dl>
|
|
2888
2895
|
<dd>
|
|
2889
2896
|
|
|
2890
|
-
**requestOptions:** `
|
|
2897
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2891
2898
|
|
|
2892
2899
|
</dd>
|
|
2893
2900
|
</dl>
|
|
@@ -2898,9 +2905,7 @@ await client.empathicVoice.chatGroups.getAudio("id");
|
|
|
2898
2905
|
</dl>
|
|
2899
2906
|
</details>
|
|
2900
2907
|
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
2908
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
|
|
2904
2909
|
<dl>
|
|
2905
2910
|
<dd>
|
|
2906
2911
|
|
|
@@ -2912,7 +2917,7 @@ await client.empathicVoice.chatGroups.getAudio("id");
|
|
|
2912
2917
|
<dl>
|
|
2913
2918
|
<dd>
|
|
2914
2919
|
|
|
2915
|
-
|
|
2920
|
+
Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
2916
2921
|
|
|
2917
2922
|
</dd>
|
|
2918
2923
|
</dl>
|
|
@@ -2928,7 +2933,7 @@ Sort and filter jobs.
|
|
|
2928
2933
|
<dd>
|
|
2929
2934
|
|
|
2930
2935
|
```typescript
|
|
2931
|
-
await client.
|
|
2936
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
2932
2937
|
```
|
|
2933
2938
|
|
|
2934
2939
|
</dd>
|
|
@@ -2944,7 +2949,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2944
2949
|
<dl>
|
|
2945
2950
|
<dd>
|
|
2946
2951
|
|
|
2947
|
-
**
|
|
2952
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
2948
2953
|
|
|
2949
2954
|
</dd>
|
|
2950
2955
|
</dl>
|
|
@@ -2952,7 +2957,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2952
2957
|
<dl>
|
|
2953
2958
|
<dd>
|
|
2954
2959
|
|
|
2955
|
-
**requestOptions:** `
|
|
2960
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2956
2961
|
|
|
2957
2962
|
</dd>
|
|
2958
2963
|
</dl>
|
|
@@ -2963,7 +2968,9 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2963
2968
|
</dl>
|
|
2964
2969
|
</details>
|
|
2965
2970
|
|
|
2966
|
-
|
|
2971
|
+
## EmpathicVoice ChatGroups
|
|
2972
|
+
|
|
2973
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
2967
2974
|
<dl>
|
|
2968
2975
|
<dd>
|
|
2969
2976
|
|
|
@@ -2975,7 +2982,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2975
2982
|
<dl>
|
|
2976
2983
|
<dd>
|
|
2977
2984
|
|
|
2978
|
-
|
|
2985
|
+
Fetches a paginated list of **Chat Groups**.
|
|
2979
2986
|
|
|
2980
2987
|
</dd>
|
|
2981
2988
|
</dl>
|
|
@@ -2991,9 +2998,11 @@ Start a new measurement inference job.
|
|
|
2991
2998
|
<dd>
|
|
2992
2999
|
|
|
2993
3000
|
```typescript
|
|
2994
|
-
await client.
|
|
2995
|
-
|
|
2996
|
-
|
|
3001
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
3002
|
+
pageNumber: 0,
|
|
3003
|
+
pageSize: 1,
|
|
3004
|
+
ascendingOrder: true,
|
|
3005
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2997
3006
|
});
|
|
2998
3007
|
```
|
|
2999
3008
|
|
|
@@ -3010,7 +3019,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3010
3019
|
<dl>
|
|
3011
3020
|
<dd>
|
|
3012
3021
|
|
|
3013
|
-
**request:** `Hume.
|
|
3022
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
3014
3023
|
|
|
3015
3024
|
</dd>
|
|
3016
3025
|
</dl>
|
|
@@ -3018,7 +3027,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3018
3027
|
<dl>
|
|
3019
3028
|
<dd>
|
|
3020
3029
|
|
|
3021
|
-
**requestOptions:** `
|
|
3030
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3022
3031
|
|
|
3023
3032
|
</dd>
|
|
3024
3033
|
</dl>
|
|
@@ -3029,7 +3038,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3029
3038
|
</dl>
|
|
3030
3039
|
</details>
|
|
3031
3040
|
|
|
3032
|
-
<details><summary><code>client.
|
|
3041
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
|
|
3033
3042
|
<dl>
|
|
3034
3043
|
<dd>
|
|
3035
3044
|
|
|
@@ -3041,7 +3050,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
3041
3050
|
<dl>
|
|
3042
3051
|
<dd>
|
|
3043
3052
|
|
|
3044
|
-
|
|
3053
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
3045
3054
|
|
|
3046
3055
|
</dd>
|
|
3047
3056
|
</dl>
|
|
@@ -3057,7 +3066,11 @@ Get the request details and state of a given job.
|
|
|
3057
3066
|
<dd>
|
|
3058
3067
|
|
|
3059
3068
|
```typescript
|
|
3060
|
-
await client.
|
|
3069
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3070
|
+
pageNumber: 0,
|
|
3071
|
+
pageSize: 1,
|
|
3072
|
+
ascendingOrder: true,
|
|
3073
|
+
});
|
|
3061
3074
|
```
|
|
3062
3075
|
|
|
3063
3076
|
</dd>
|
|
@@ -3073,7 +3086,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3073
3086
|
<dl>
|
|
3074
3087
|
<dd>
|
|
3075
3088
|
|
|
3076
|
-
**id:** `string` —
|
|
3089
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3077
3090
|
|
|
3078
3091
|
</dd>
|
|
3079
3092
|
</dl>
|
|
@@ -3081,7 +3094,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3081
3094
|
<dl>
|
|
3082
3095
|
<dd>
|
|
3083
3096
|
|
|
3084
|
-
**
|
|
3097
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3098
|
+
|
|
3099
|
+
</dd>
|
|
3100
|
+
</dl>
|
|
3101
|
+
|
|
3102
|
+
<dl>
|
|
3103
|
+
<dd>
|
|
3104
|
+
|
|
3105
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3085
3106
|
|
|
3086
3107
|
</dd>
|
|
3087
3108
|
</dl>
|
|
@@ -3092,7 +3113,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3092
3113
|
</dl>
|
|
3093
3114
|
</details>
|
|
3094
3115
|
|
|
3095
|
-
<details><summary><code>client.
|
|
3116
|
+
<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>
|
|
3096
3117
|
<dl>
|
|
3097
3118
|
<dd>
|
|
3098
3119
|
|
|
@@ -3104,7 +3125,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
3104
3125
|
<dl>
|
|
3105
3126
|
<dd>
|
|
3106
3127
|
|
|
3107
|
-
|
|
3128
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
3108
3129
|
|
|
3109
3130
|
</dd>
|
|
3110
3131
|
</dl>
|
|
@@ -3120,7 +3141,11 @@ Get the JSON predictions of a completed inference job.
|
|
|
3120
3141
|
<dd>
|
|
3121
3142
|
|
|
3122
3143
|
```typescript
|
|
3123
|
-
await client.
|
|
3144
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3145
|
+
pageNumber: 0,
|
|
3146
|
+
pageSize: 3,
|
|
3147
|
+
ascendingOrder: true,
|
|
3148
|
+
});
|
|
3124
3149
|
```
|
|
3125
3150
|
|
|
3126
3151
|
</dd>
|
|
@@ -3136,7 +3161,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3136
3161
|
<dl>
|
|
3137
3162
|
<dd>
|
|
3138
3163
|
|
|
3139
|
-
**id:** `string` —
|
|
3164
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3140
3165
|
|
|
3141
3166
|
</dd>
|
|
3142
3167
|
</dl>
|
|
@@ -3144,7 +3169,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3144
3169
|
<dl>
|
|
3145
3170
|
<dd>
|
|
3146
3171
|
|
|
3147
|
-
**
|
|
3172
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3173
|
+
|
|
3174
|
+
</dd>
|
|
3175
|
+
</dl>
|
|
3176
|
+
|
|
3177
|
+
<dl>
|
|
3178
|
+
<dd>
|
|
3179
|
+
|
|
3180
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3148
3181
|
|
|
3149
3182
|
</dd>
|
|
3150
3183
|
</dl>
|
|
@@ -3155,7 +3188,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3155
3188
|
</dl>
|
|
3156
3189
|
</details>
|
|
3157
3190
|
|
|
3158
|
-
<details><summary><code>client.
|
|
3191
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
|
|
3159
3192
|
<dl>
|
|
3160
3193
|
<dd>
|
|
3161
3194
|
|
|
@@ -3167,7 +3200,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
3167
3200
|
<dl>
|
|
3168
3201
|
<dd>
|
|
3169
3202
|
|
|
3170
|
-
|
|
3203
|
+
Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
3171
3204
|
|
|
3172
3205
|
</dd>
|
|
3173
3206
|
</dl>
|
|
@@ -3183,10 +3216,11 @@ Start a new batch inference job.
|
|
|
3183
3216
|
<dd>
|
|
3184
3217
|
|
|
3185
3218
|
```typescript
|
|
3186
|
-
await client.
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3219
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
3220
|
+
pageNumber: 0,
|
|
3221
|
+
pageSize: 10,
|
|
3222
|
+
ascendingOrder: true,
|
|
3223
|
+
});
|
|
3190
3224
|
```
|
|
3191
3225
|
|
|
3192
3226
|
</dd>
|
|
@@ -3202,7 +3236,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3202
3236
|
<dl>
|
|
3203
3237
|
<dd>
|
|
3204
3238
|
|
|
3205
|
-
**
|
|
3239
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
3206
3240
|
|
|
3207
3241
|
</dd>
|
|
3208
3242
|
</dl>
|
|
@@ -3210,7 +3244,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3210
3244
|
<dl>
|
|
3211
3245
|
<dd>
|
|
3212
3246
|
|
|
3213
|
-
**request:** `Hume.
|
|
3247
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
3214
3248
|
|
|
3215
3249
|
</dd>
|
|
3216
3250
|
</dl>
|
|
@@ -3218,7 +3252,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
3218
3252
|
<dl>
|
|
3219
3253
|
<dd>
|
|
3220
3254
|
|
|
3221
|
-
**requestOptions:** `
|
|
3255
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3222
3256
|
|
|
3223
3257
|
</dd>
|
|
3224
3258
|
</dl>
|