hume 0.11.5-beta.2 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/empathic-voice/__package__.yml +27 -517
- package/.mock/definition/empathic-voice/chatGroups.yml +1 -1
- package/.mock/definition/empathic-voice/chats.yml +1 -1
- package/.mock/definition/empathic-voice/configs.yml +34 -151
- package/.mock/definition/empathic-voice/prompts.yml +21 -21
- package/.mock/definition/empathic-voice/tools.yml +10 -10
- package/.mock/definition/tts/__package__.yml +6 -22
- package/api/resources/empathicVoice/resources/chat/client/Socket.js +1 -4
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +1 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +1 -1
- package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +1 -1
- package/api/resources/empathicVoice/resources/chats/client/Client.js +1 -1
- package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +9 -9
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -1
- package/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +10 -10
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +10 -10
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +1 -1
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +1 -1
- package/api/resources/empathicVoice/resources/tools/client/Client.d.ts +10 -10
- package/api/resources/empathicVoice/resources/tools/client/Client.js +10 -10
- package/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedBuiltinToolName.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +1 -1
- package/api/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
- package/api/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
- package/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/chat/client/Socket.js +1 -4
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +1 -1
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +1 -1
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +9 -9
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +10 -10
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +10 -10
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.d.ts +10 -10
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +10 -10
- package/dist/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedBuiltinToolName.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ReturnPrompt.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +43 -485
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/.mock/definition/empathic-voice/customVoices.yml +0 -283
package/reference.md
CHANGED
|
@@ -202,17 +202,12 @@ await client.tts.synthesizeFileStreaming({
|
|
|
202
202
|
utterances: [
|
|
203
203
|
{
|
|
204
204
|
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
205
|
-
|
|
206
|
-
"
|
|
205
|
+
voice: {
|
|
206
|
+
name: "Male English Actor",
|
|
207
|
+
provider: "HUME_AI",
|
|
208
|
+
},
|
|
207
209
|
},
|
|
208
210
|
],
|
|
209
|
-
context: {
|
|
210
|
-
generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
|
|
211
|
-
},
|
|
212
|
-
format: {
|
|
213
|
-
type: "mp3",
|
|
214
|
-
},
|
|
215
|
-
numGenerations: 1,
|
|
216
211
|
});
|
|
217
212
|
```
|
|
218
213
|
|
|
@@ -282,22 +277,12 @@ const response = await client.tts.synthesizeJsonStreaming({
|
|
|
282
277
|
utterances: [
|
|
283
278
|
{
|
|
284
279
|
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
285
|
-
|
|
286
|
-
"
|
|
280
|
+
voice: {
|
|
281
|
+
name: "Male English Actor",
|
|
282
|
+
provider: "HUME_AI",
|
|
283
|
+
},
|
|
287
284
|
},
|
|
288
285
|
],
|
|
289
|
-
context: {
|
|
290
|
-
utterances: [
|
|
291
|
-
{
|
|
292
|
-
text: "How can people see beauty so differently?",
|
|
293
|
-
description:
|
|
294
|
-
"A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
|
|
295
|
-
},
|
|
296
|
-
],
|
|
297
|
-
},
|
|
298
|
-
format: {
|
|
299
|
-
type: "mp3",
|
|
300
|
-
},
|
|
301
286
|
});
|
|
302
287
|
for await (const item of response) {
|
|
303
288
|
console.log(item);
|
|
@@ -563,7 +548,7 @@ await client.tts.voices.delete({
|
|
|
563
548
|
|
|
564
549
|
Fetches a paginated list of **Tools**.
|
|
565
550
|
|
|
566
|
-
Refer to our [tool use](/docs/
|
|
551
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
567
552
|
|
|
568
553
|
</dd>
|
|
569
554
|
</dl>
|
|
@@ -641,9 +626,9 @@ while (page.hasNextPage()) {
|
|
|
641
626
|
<dl>
|
|
642
627
|
<dd>
|
|
643
628
|
|
|
644
|
-
Creates a **Tool** that can be added to an [EVI configuration](/reference/
|
|
629
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
645
630
|
|
|
646
|
-
Refer to our [tool use](/docs/
|
|
631
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
647
632
|
|
|
648
633
|
</dd>
|
|
649
634
|
</dl>
|
|
@@ -715,7 +700,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
715
700
|
|
|
716
701
|
Fetches a list of a **Tool's** versions.
|
|
717
702
|
|
|
718
|
-
Refer to our [tool use](/docs/
|
|
703
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
719
704
|
|
|
720
705
|
</dd>
|
|
721
706
|
</dl>
|
|
@@ -797,7 +782,7 @@ while (page.hasNextPage()) {
|
|
|
797
782
|
|
|
798
783
|
Updates a **Tool** by creating a new version of the **Tool**.
|
|
799
784
|
|
|
800
|
-
Refer to our [tool use](/docs/
|
|
785
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
801
786
|
|
|
802
787
|
</dd>
|
|
803
788
|
</dl>
|
|
@@ -876,7 +861,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
876
861
|
|
|
877
862
|
Deletes a **Tool** and its versions.
|
|
878
863
|
|
|
879
|
-
Refer to our [tool use](/docs/
|
|
864
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
880
865
|
|
|
881
866
|
</dd>
|
|
882
867
|
</dl>
|
|
@@ -941,7 +926,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
941
926
|
|
|
942
927
|
Updates the name of a **Tool**.
|
|
943
928
|
|
|
944
|
-
Refer to our [tool use](/docs/
|
|
929
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
945
930
|
|
|
946
931
|
</dd>
|
|
947
932
|
</dl>
|
|
@@ -1016,7 +1001,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1016
1001
|
|
|
1017
1002
|
Fetches a specified version of a **Tool**.
|
|
1018
1003
|
|
|
1019
|
-
Refer to our [tool use](/docs/
|
|
1004
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1020
1005
|
|
|
1021
1006
|
</dd>
|
|
1022
1007
|
</dl>
|
|
@@ -1095,7 +1080,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1095
1080
|
|
|
1096
1081
|
Deletes a specified version of a **Tool**.
|
|
1097
1082
|
|
|
1098
|
-
Refer to our [tool use](/docs/
|
|
1083
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1099
1084
|
|
|
1100
1085
|
</dd>
|
|
1101
1086
|
</dl>
|
|
@@ -1174,7 +1159,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1174
1159
|
|
|
1175
1160
|
Updates the description of a specified **Tool** version.
|
|
1176
1161
|
|
|
1177
|
-
Refer to our [tool use](/docs/
|
|
1162
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1178
1163
|
|
|
1179
1164
|
</dd>
|
|
1180
1165
|
</dl>
|
|
@@ -1266,7 +1251,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1266
1251
|
|
|
1267
1252
|
Fetches a paginated list of **Prompts**.
|
|
1268
1253
|
|
|
1269
|
-
See our [prompting guide](/docs/
|
|
1254
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1270
1255
|
|
|
1271
1256
|
</dd>
|
|
1272
1257
|
</dl>
|
|
@@ -1344,9 +1329,9 @@ while (page.hasNextPage()) {
|
|
|
1344
1329
|
<dl>
|
|
1345
1330
|
<dd>
|
|
1346
1331
|
|
|
1347
|
-
Creates a **Prompt** that can be added to an [EVI configuration](/reference/
|
|
1332
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
1348
1333
|
|
|
1349
|
-
See our [prompting guide](/docs/
|
|
1334
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1350
1335
|
|
|
1351
1336
|
</dd>
|
|
1352
1337
|
</dl>
|
|
@@ -1414,7 +1399,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1414
1399
|
|
|
1415
1400
|
Fetches a list of a **Prompt's** versions.
|
|
1416
1401
|
|
|
1417
|
-
See our [prompting guide](/docs/
|
|
1402
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1418
1403
|
|
|
1419
1404
|
</dd>
|
|
1420
1405
|
</dl>
|
|
@@ -1487,7 +1472,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1487
1472
|
|
|
1488
1473
|
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1489
1474
|
|
|
1490
|
-
See our [prompting guide](/docs/
|
|
1475
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1491
1476
|
|
|
1492
1477
|
</dd>
|
|
1493
1478
|
</dl>
|
|
@@ -1563,7 +1548,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1563
1548
|
|
|
1564
1549
|
Deletes a **Prompt** and its versions.
|
|
1565
1550
|
|
|
1566
|
-
See our [prompting guide](/docs/
|
|
1551
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1567
1552
|
|
|
1568
1553
|
</dd>
|
|
1569
1554
|
</dl>
|
|
@@ -1628,7 +1613,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1628
1613
|
|
|
1629
1614
|
Updates the name of a **Prompt**.
|
|
1630
1615
|
|
|
1631
|
-
See our [prompting guide](/docs/
|
|
1616
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1632
1617
|
|
|
1633
1618
|
</dd>
|
|
1634
1619
|
</dl>
|
|
@@ -1703,7 +1688,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1703
1688
|
|
|
1704
1689
|
Fetches a specified version of a **Prompt**.
|
|
1705
1690
|
|
|
1706
|
-
See our [prompting guide](/docs/
|
|
1691
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1707
1692
|
|
|
1708
1693
|
</dd>
|
|
1709
1694
|
</dl>
|
|
@@ -1782,7 +1767,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1782
1767
|
|
|
1783
1768
|
Deletes a specified version of a **Prompt**.
|
|
1784
1769
|
|
|
1785
|
-
See our [prompting guide](/docs/
|
|
1770
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1786
1771
|
|
|
1787
1772
|
</dd>
|
|
1788
1773
|
</dl>
|
|
@@ -1861,7 +1846,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1861
1846
|
|
|
1862
1847
|
Updates the description of a **Prompt**.
|
|
1863
1848
|
|
|
1864
|
-
See our [prompting guide](/docs/
|
|
1849
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1865
1850
|
|
|
1866
1851
|
</dd>
|
|
1867
1852
|
</dl>
|
|
@@ -1936,433 +1921,6 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1936
1921
|
</dl>
|
|
1937
1922
|
</details>
|
|
1938
1923
|
|
|
1939
|
-
## EmpathicVoice CustomVoices
|
|
1940
|
-
|
|
1941
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> core.Page<Hume.ReturnCustomVoice></code></summary>
|
|
1942
|
-
<dl>
|
|
1943
|
-
<dd>
|
|
1944
|
-
|
|
1945
|
-
#### 📝 Description
|
|
1946
|
-
|
|
1947
|
-
<dl>
|
|
1948
|
-
<dd>
|
|
1949
|
-
|
|
1950
|
-
<dl>
|
|
1951
|
-
<dd>
|
|
1952
|
-
|
|
1953
|
-
Fetches a paginated list of **Custom Voices**.
|
|
1954
|
-
|
|
1955
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1956
|
-
|
|
1957
|
-
</dd>
|
|
1958
|
-
</dl>
|
|
1959
|
-
</dd>
|
|
1960
|
-
</dl>
|
|
1961
|
-
|
|
1962
|
-
#### 🔌 Usage
|
|
1963
|
-
|
|
1964
|
-
<dl>
|
|
1965
|
-
<dd>
|
|
1966
|
-
|
|
1967
|
-
<dl>
|
|
1968
|
-
<dd>
|
|
1969
|
-
|
|
1970
|
-
```typescript
|
|
1971
|
-
const response = await client.empathicVoice.customVoices.listCustomVoices();
|
|
1972
|
-
for await (const item of response) {
|
|
1973
|
-
console.log(item);
|
|
1974
|
-
}
|
|
1975
|
-
|
|
1976
|
-
// Or you can manually iterate page-by-page
|
|
1977
|
-
const page = await client.empathicVoice.customVoices.listCustomVoices();
|
|
1978
|
-
while (page.hasNextPage()) {
|
|
1979
|
-
page = page.getNextPage();
|
|
1980
|
-
}
|
|
1981
|
-
```
|
|
1982
|
-
|
|
1983
|
-
</dd>
|
|
1984
|
-
</dl>
|
|
1985
|
-
</dd>
|
|
1986
|
-
</dl>
|
|
1987
|
-
|
|
1988
|
-
#### ⚙️ Parameters
|
|
1989
|
-
|
|
1990
|
-
<dl>
|
|
1991
|
-
<dd>
|
|
1992
|
-
|
|
1993
|
-
<dl>
|
|
1994
|
-
<dd>
|
|
1995
|
-
|
|
1996
|
-
**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
|
|
1997
|
-
|
|
1998
|
-
</dd>
|
|
1999
|
-
</dl>
|
|
2000
|
-
|
|
2001
|
-
<dl>
|
|
2002
|
-
<dd>
|
|
2003
|
-
|
|
2004
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2005
|
-
|
|
2006
|
-
</dd>
|
|
2007
|
-
</dl>
|
|
2008
|
-
</dd>
|
|
2009
|
-
</dl>
|
|
2010
|
-
|
|
2011
|
-
</dd>
|
|
2012
|
-
</dl>
|
|
2013
|
-
</details>
|
|
2014
|
-
|
|
2015
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
2016
|
-
<dl>
|
|
2017
|
-
<dd>
|
|
2018
|
-
|
|
2019
|
-
#### 📝 Description
|
|
2020
|
-
|
|
2021
|
-
<dl>
|
|
2022
|
-
<dd>
|
|
2023
|
-
|
|
2024
|
-
<dl>
|
|
2025
|
-
<dd>
|
|
2026
|
-
|
|
2027
|
-
Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
2028
|
-
|
|
2029
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2030
|
-
|
|
2031
|
-
</dd>
|
|
2032
|
-
</dl>
|
|
2033
|
-
</dd>
|
|
2034
|
-
</dl>
|
|
2035
|
-
|
|
2036
|
-
#### 🔌 Usage
|
|
2037
|
-
|
|
2038
|
-
<dl>
|
|
2039
|
-
<dd>
|
|
2040
|
-
|
|
2041
|
-
<dl>
|
|
2042
|
-
<dd>
|
|
2043
|
-
|
|
2044
|
-
```typescript
|
|
2045
|
-
await client.empathicVoice.customVoices.createCustomVoice({
|
|
2046
|
-
name: "name",
|
|
2047
|
-
baseVoice: "ITO",
|
|
2048
|
-
parameterModel: "20241004-11parameter",
|
|
2049
|
-
});
|
|
2050
|
-
```
|
|
2051
|
-
|
|
2052
|
-
</dd>
|
|
2053
|
-
</dl>
|
|
2054
|
-
</dd>
|
|
2055
|
-
</dl>
|
|
2056
|
-
|
|
2057
|
-
#### ⚙️ Parameters
|
|
2058
|
-
|
|
2059
|
-
<dl>
|
|
2060
|
-
<dd>
|
|
2061
|
-
|
|
2062
|
-
<dl>
|
|
2063
|
-
<dd>
|
|
2064
|
-
|
|
2065
|
-
**request:** `Hume.PostedCustomVoice`
|
|
2066
|
-
|
|
2067
|
-
</dd>
|
|
2068
|
-
</dl>
|
|
2069
|
-
|
|
2070
|
-
<dl>
|
|
2071
|
-
<dd>
|
|
2072
|
-
|
|
2073
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2074
|
-
|
|
2075
|
-
</dd>
|
|
2076
|
-
</dl>
|
|
2077
|
-
</dd>
|
|
2078
|
-
</dl>
|
|
2079
|
-
|
|
2080
|
-
</dd>
|
|
2081
|
-
</dl>
|
|
2082
|
-
</details>
|
|
2083
|
-
|
|
2084
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
|
|
2085
|
-
<dl>
|
|
2086
|
-
<dd>
|
|
2087
|
-
|
|
2088
|
-
#### 📝 Description
|
|
2089
|
-
|
|
2090
|
-
<dl>
|
|
2091
|
-
<dd>
|
|
2092
|
-
|
|
2093
|
-
<dl>
|
|
2094
|
-
<dd>
|
|
2095
|
-
|
|
2096
|
-
Fetches a specific **Custom Voice** by ID.
|
|
2097
|
-
|
|
2098
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2099
|
-
|
|
2100
|
-
</dd>
|
|
2101
|
-
</dl>
|
|
2102
|
-
</dd>
|
|
2103
|
-
</dl>
|
|
2104
|
-
|
|
2105
|
-
#### 🔌 Usage
|
|
2106
|
-
|
|
2107
|
-
<dl>
|
|
2108
|
-
<dd>
|
|
2109
|
-
|
|
2110
|
-
<dl>
|
|
2111
|
-
<dd>
|
|
2112
|
-
|
|
2113
|
-
```typescript
|
|
2114
|
-
await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
2115
|
-
```
|
|
2116
|
-
|
|
2117
|
-
</dd>
|
|
2118
|
-
</dl>
|
|
2119
|
-
</dd>
|
|
2120
|
-
</dl>
|
|
2121
|
-
|
|
2122
|
-
#### ⚙️ Parameters
|
|
2123
|
-
|
|
2124
|
-
<dl>
|
|
2125
|
-
<dd>
|
|
2126
|
-
|
|
2127
|
-
<dl>
|
|
2128
|
-
<dd>
|
|
2129
|
-
|
|
2130
|
-
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2131
|
-
|
|
2132
|
-
</dd>
|
|
2133
|
-
</dl>
|
|
2134
|
-
|
|
2135
|
-
<dl>
|
|
2136
|
-
<dd>
|
|
2137
|
-
|
|
2138
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2139
|
-
|
|
2140
|
-
</dd>
|
|
2141
|
-
</dl>
|
|
2142
|
-
</dd>
|
|
2143
|
-
</dl>
|
|
2144
|
-
|
|
2145
|
-
</dd>
|
|
2146
|
-
</dl>
|
|
2147
|
-
</details>
|
|
2148
|
-
|
|
2149
|
-
<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>
|
|
2150
|
-
<dl>
|
|
2151
|
-
<dd>
|
|
2152
|
-
|
|
2153
|
-
#### 📝 Description
|
|
2154
|
-
|
|
2155
|
-
<dl>
|
|
2156
|
-
<dd>
|
|
2157
|
-
|
|
2158
|
-
<dl>
|
|
2159
|
-
<dd>
|
|
2160
|
-
|
|
2161
|
-
Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
|
|
2162
|
-
|
|
2163
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2164
|
-
|
|
2165
|
-
</dd>
|
|
2166
|
-
</dl>
|
|
2167
|
-
</dd>
|
|
2168
|
-
</dl>
|
|
2169
|
-
|
|
2170
|
-
#### 🔌 Usage
|
|
2171
|
-
|
|
2172
|
-
<dl>
|
|
2173
|
-
<dd>
|
|
2174
|
-
|
|
2175
|
-
<dl>
|
|
2176
|
-
<dd>
|
|
2177
|
-
|
|
2178
|
-
```typescript
|
|
2179
|
-
await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
2180
|
-
name: "name",
|
|
2181
|
-
baseVoice: "ITO",
|
|
2182
|
-
parameterModel: "20241004-11parameter",
|
|
2183
|
-
});
|
|
2184
|
-
```
|
|
2185
|
-
|
|
2186
|
-
</dd>
|
|
2187
|
-
</dl>
|
|
2188
|
-
</dd>
|
|
2189
|
-
</dl>
|
|
2190
|
-
|
|
2191
|
-
#### ⚙️ Parameters
|
|
2192
|
-
|
|
2193
|
-
<dl>
|
|
2194
|
-
<dd>
|
|
2195
|
-
|
|
2196
|
-
<dl>
|
|
2197
|
-
<dd>
|
|
2198
|
-
|
|
2199
|
-
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2200
|
-
|
|
2201
|
-
</dd>
|
|
2202
|
-
</dl>
|
|
2203
|
-
|
|
2204
|
-
<dl>
|
|
2205
|
-
<dd>
|
|
2206
|
-
|
|
2207
|
-
**request:** `Hume.PostedCustomVoice`
|
|
2208
|
-
|
|
2209
|
-
</dd>
|
|
2210
|
-
</dl>
|
|
2211
|
-
|
|
2212
|
-
<dl>
|
|
2213
|
-
<dd>
|
|
2214
|
-
|
|
2215
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2216
|
-
|
|
2217
|
-
</dd>
|
|
2218
|
-
</dl>
|
|
2219
|
-
</dd>
|
|
2220
|
-
</dl>
|
|
2221
|
-
|
|
2222
|
-
</dd>
|
|
2223
|
-
</dl>
|
|
2224
|
-
</details>
|
|
2225
|
-
|
|
2226
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
|
|
2227
|
-
<dl>
|
|
2228
|
-
<dd>
|
|
2229
|
-
|
|
2230
|
-
#### 📝 Description
|
|
2231
|
-
|
|
2232
|
-
<dl>
|
|
2233
|
-
<dd>
|
|
2234
|
-
|
|
2235
|
-
<dl>
|
|
2236
|
-
<dd>
|
|
2237
|
-
|
|
2238
|
-
Deletes a **Custom Voice** and its versions.
|
|
2239
|
-
|
|
2240
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2241
|
-
|
|
2242
|
-
</dd>
|
|
2243
|
-
</dl>
|
|
2244
|
-
</dd>
|
|
2245
|
-
</dl>
|
|
2246
|
-
|
|
2247
|
-
#### 🔌 Usage
|
|
2248
|
-
|
|
2249
|
-
<dl>
|
|
2250
|
-
<dd>
|
|
2251
|
-
|
|
2252
|
-
<dl>
|
|
2253
|
-
<dd>
|
|
2254
|
-
|
|
2255
|
-
```typescript
|
|
2256
|
-
await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
2257
|
-
```
|
|
2258
|
-
|
|
2259
|
-
</dd>
|
|
2260
|
-
</dl>
|
|
2261
|
-
</dd>
|
|
2262
|
-
</dl>
|
|
2263
|
-
|
|
2264
|
-
#### ⚙️ Parameters
|
|
2265
|
-
|
|
2266
|
-
<dl>
|
|
2267
|
-
<dd>
|
|
2268
|
-
|
|
2269
|
-
<dl>
|
|
2270
|
-
<dd>
|
|
2271
|
-
|
|
2272
|
-
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2273
|
-
|
|
2274
|
-
</dd>
|
|
2275
|
-
</dl>
|
|
2276
|
-
|
|
2277
|
-
<dl>
|
|
2278
|
-
<dd>
|
|
2279
|
-
|
|
2280
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2281
|
-
|
|
2282
|
-
</dd>
|
|
2283
|
-
</dl>
|
|
2284
|
-
</dd>
|
|
2285
|
-
</dl>
|
|
2286
|
-
|
|
2287
|
-
</dd>
|
|
2288
|
-
</dl>
|
|
2289
|
-
</details>
|
|
2290
|
-
|
|
2291
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
|
|
2292
|
-
<dl>
|
|
2293
|
-
<dd>
|
|
2294
|
-
|
|
2295
|
-
#### 📝 Description
|
|
2296
|
-
|
|
2297
|
-
<dl>
|
|
2298
|
-
<dd>
|
|
2299
|
-
|
|
2300
|
-
<dl>
|
|
2301
|
-
<dd>
|
|
2302
|
-
|
|
2303
|
-
Updates the name of a **Custom Voice**.
|
|
2304
|
-
|
|
2305
|
-
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
2306
|
-
|
|
2307
|
-
</dd>
|
|
2308
|
-
</dl>
|
|
2309
|
-
</dd>
|
|
2310
|
-
</dl>
|
|
2311
|
-
|
|
2312
|
-
#### 🔌 Usage
|
|
2313
|
-
|
|
2314
|
-
<dl>
|
|
2315
|
-
<dd>
|
|
2316
|
-
|
|
2317
|
-
<dl>
|
|
2318
|
-
<dd>
|
|
2319
|
-
|
|
2320
|
-
```typescript
|
|
2321
|
-
await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
2322
|
-
name: "name",
|
|
2323
|
-
});
|
|
2324
|
-
```
|
|
2325
|
-
|
|
2326
|
-
</dd>
|
|
2327
|
-
</dl>
|
|
2328
|
-
</dd>
|
|
2329
|
-
</dl>
|
|
2330
|
-
|
|
2331
|
-
#### ⚙️ Parameters
|
|
2332
|
-
|
|
2333
|
-
<dl>
|
|
2334
|
-
<dd>
|
|
2335
|
-
|
|
2336
|
-
<dl>
|
|
2337
|
-
<dd>
|
|
2338
|
-
|
|
2339
|
-
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
2340
|
-
|
|
2341
|
-
</dd>
|
|
2342
|
-
</dl>
|
|
2343
|
-
|
|
2344
|
-
<dl>
|
|
2345
|
-
<dd>
|
|
2346
|
-
|
|
2347
|
-
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
2348
|
-
|
|
2349
|
-
</dd>
|
|
2350
|
-
</dl>
|
|
2351
|
-
|
|
2352
|
-
<dl>
|
|
2353
|
-
<dd>
|
|
2354
|
-
|
|
2355
|
-
**requestOptions:** `CustomVoices.RequestOptions`
|
|
2356
|
-
|
|
2357
|
-
</dd>
|
|
2358
|
-
</dl>
|
|
2359
|
-
</dd>
|
|
2360
|
-
</dl>
|
|
2361
|
-
|
|
2362
|
-
</dd>
|
|
2363
|
-
</dl>
|
|
2364
|
-
</details>
|
|
2365
|
-
|
|
2366
1924
|
## EmpathicVoice Configs
|
|
2367
1925
|
|
|
2368
1926
|
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig></code></summary>
|
|
@@ -2379,7 +1937,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2379
1937
|
|
|
2380
1938
|
Fetches a paginated list of **Configs**.
|
|
2381
1939
|
|
|
2382
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
1940
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2383
1941
|
|
|
2384
1942
|
</dd>
|
|
2385
1943
|
</dl>
|
|
@@ -2459,7 +2017,7 @@ while (page.hasNextPage()) {
|
|
|
2459
2017
|
|
|
2460
2018
|
Creates a **Config** which can be applied to EVI.
|
|
2461
2019
|
|
|
2462
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2020
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2463
2021
|
|
|
2464
2022
|
</dd>
|
|
2465
2023
|
</dl>
|
|
@@ -2481,10 +2039,10 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2481
2039
|
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2482
2040
|
version: 0,
|
|
2483
2041
|
},
|
|
2484
|
-
eviVersion: "
|
|
2042
|
+
eviVersion: "3",
|
|
2485
2043
|
voice: {
|
|
2486
2044
|
provider: "HUME_AI",
|
|
2487
|
-
name: "
|
|
2045
|
+
name: "Ava Song",
|
|
2488
2046
|
},
|
|
2489
2047
|
languageModel: {
|
|
2490
2048
|
modelProvider: "ANTHROPIC",
|
|
@@ -2554,7 +2112,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2554
2112
|
|
|
2555
2113
|
Fetches a list of a **Config's** versions.
|
|
2556
2114
|
|
|
2557
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2115
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2558
2116
|
|
|
2559
2117
|
</dd>
|
|
2560
2118
|
</dl>
|
|
@@ -2636,7 +2194,7 @@ while (page.hasNextPage()) {
|
|
|
2636
2194
|
|
|
2637
2195
|
Updates a **Config** by creating a new version of the **Config**.
|
|
2638
2196
|
|
|
2639
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2197
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2640
2198
|
|
|
2641
2199
|
</dd>
|
|
2642
2200
|
</dl>
|
|
@@ -2654,14 +2212,14 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2654
2212
|
```typescript
|
|
2655
2213
|
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2656
2214
|
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2657
|
-
eviVersion: "
|
|
2215
|
+
eviVersion: "3",
|
|
2658
2216
|
prompt: {
|
|
2659
2217
|
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2660
2218
|
version: 0,
|
|
2661
2219
|
},
|
|
2662
2220
|
voice: {
|
|
2663
2221
|
provider: "HUME_AI",
|
|
2664
|
-
name: "
|
|
2222
|
+
name: "Ava Song",
|
|
2665
2223
|
},
|
|
2666
2224
|
languageModel: {
|
|
2667
2225
|
modelProvider: "ANTHROPIC",
|
|
@@ -2742,7 +2300,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2742
2300
|
|
|
2743
2301
|
Deletes a **Config** and its versions.
|
|
2744
2302
|
|
|
2745
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2303
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2746
2304
|
|
|
2747
2305
|
</dd>
|
|
2748
2306
|
</dl>
|
|
@@ -2807,7 +2365,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2807
2365
|
|
|
2808
2366
|
Updates the name of a **Config**.
|
|
2809
2367
|
|
|
2810
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2368
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2811
2369
|
|
|
2812
2370
|
</dd>
|
|
2813
2371
|
</dl>
|
|
@@ -2882,7 +2440,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2882
2440
|
|
|
2883
2441
|
Fetches a specified version of a **Config**.
|
|
2884
2442
|
|
|
2885
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2443
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2886
2444
|
|
|
2887
2445
|
</dd>
|
|
2888
2446
|
</dl>
|
|
@@ -2961,7 +2519,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2961
2519
|
|
|
2962
2520
|
Deletes a specified version of a **Config**.
|
|
2963
2521
|
|
|
2964
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2522
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2965
2523
|
|
|
2966
2524
|
</dd>
|
|
2967
2525
|
</dl>
|
|
@@ -3040,7 +2598,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
3040
2598
|
|
|
3041
2599
|
Updates the description of a **Config**.
|
|
3042
2600
|
|
|
3043
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/
|
|
2601
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
3044
2602
|
|
|
3045
2603
|
</dd>
|
|
3046
2604
|
</dl>
|
|
@@ -3297,7 +2855,7 @@ while (page.hasNextPage()) {
|
|
|
3297
2855
|
<dl>
|
|
3298
2856
|
<dd>
|
|
3299
2857
|
|
|
3300
|
-
Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/
|
|
2858
|
+
Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
3301
2859
|
|
|
3302
2860
|
</dd>
|
|
3303
2861
|
</dl>
|
|
@@ -3607,7 +3165,7 @@ while (page.hasNextPage()) {
|
|
|
3607
3165
|
<dl>
|
|
3608
3166
|
<dd>
|
|
3609
3167
|
|
|
3610
|
-
Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/
|
|
3168
|
+
Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
3611
3169
|
|
|
3612
3170
|
</dd>
|
|
3613
3171
|
</dl>
|