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