hume 0.13.6 → 0.13.8
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 +669 -657
- package/.mock/definition/empathic-voice/chat.yml +27 -27
- package/.mock/definition/empathic-voice/chatWebhooks.yml +2 -2
- package/.mock/definition/tts/__package__.yml +93 -88
- package/api/resources/empathicVoice/types/AssistantEnd.d.ts +2 -2
- package/api/resources/empathicVoice/types/AssistantInput.d.ts +2 -2
- package/api/resources/empathicVoice/types/AssistantMessage.d.ts +8 -8
- package/api/resources/empathicVoice/types/AssistantProsody.d.ts +6 -6
- package/api/resources/empathicVoice/types/AudioConfiguration.d.ts +2 -2
- package/api/resources/empathicVoice/types/AudioInput.d.ts +6 -6
- package/api/resources/empathicVoice/types/AudioOutput.d.ts +4 -4
- package/api/resources/empathicVoice/types/BuiltinToolConfig.d.ts +1 -1
- package/api/resources/empathicVoice/types/ChatMessage.d.ts +2 -2
- package/api/resources/empathicVoice/types/ChatMetadata.d.ts +8 -8
- package/api/resources/empathicVoice/types/Context.d.ts +6 -6
- package/api/resources/empathicVoice/types/LanguageModelType.d.ts +7 -1
- package/api/resources/empathicVoice/types/LanguageModelType.js +6 -0
- package/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +2 -2
- package/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +2 -2
- package/api/resources/empathicVoice/types/ReturnConfig.d.ts +2 -2
- package/api/resources/empathicVoice/types/SessionSettings.d.ts +27 -27
- package/api/resources/empathicVoice/types/Tool.d.ts +6 -6
- package/api/resources/empathicVoice/types/ToolCallMessage.d.ts +6 -6
- package/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +16 -16
- package/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +8 -8
- package/api/resources/empathicVoice/types/UserInput.d.ts +2 -2
- package/api/resources/empathicVoice/types/UserInterruption.d.ts +4 -4
- package/api/resources/empathicVoice/types/UserMessage.d.ts +12 -12
- package/api/resources/empathicVoice/types/WebSocketError.d.ts +10 -10
- package/api/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +8 -8
- package/api/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +6 -6
- package/api/resources/empathicVoice/types/index.d.ts +16 -16
- package/api/resources/empathicVoice/types/index.js +16 -16
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/api/resources/tts/client/Client.d.ts +6 -6
- package/api/resources/tts/client/Client.js +35 -35
- package/api/resources/tts/types/OctaveVersion.d.ts +4 -0
- package/api/resources/tts/types/OctaveVersion.js +5 -0
- package/api/resources/tts/types/PostedTts.d.ts +9 -8
- package/api/resources/tts/types/PostedUtterance.d.ts +6 -6
- package/api/resources/tts/types/ReturnGeneration.d.ts +5 -5
- package/api/resources/tts/types/ReturnTts.d.ts +1 -1
- package/api/resources/tts/types/Snippet.d.ts +6 -6
- package/api/resources/tts/types/SnippetAudioChunk.d.ts +12 -11
- package/api/resources/tts/types/index.d.ts +1 -0
- package/api/resources/tts/types/index.js +1 -0
- package/dist/api/resources/empathicVoice/types/AssistantEnd.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/AssistantInput.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/AssistantMessage.d.ts +8 -8
- package/dist/api/resources/empathicVoice/types/AssistantProsody.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/AudioConfiguration.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/AudioInput.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/AudioOutput.d.ts +4 -4
- package/dist/api/resources/empathicVoice/types/BuiltinToolConfig.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ChatMessage.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ChatMetadata.d.ts +8 -8
- package/dist/api/resources/empathicVoice/types/Context.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/LanguageModelType.d.ts +7 -1
- package/dist/api/resources/empathicVoice/types/LanguageModelType.js +6 -0
- package/dist/api/resources/empathicVoice/types/PauseAssistantMessage.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/SessionSettings.d.ts +27 -27
- package/dist/api/resources/empathicVoice/types/Tool.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/ToolCallMessage.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/ToolErrorMessage.d.ts +16 -16
- package/dist/api/resources/empathicVoice/types/ToolResponseMessage.d.ts +8 -8
- package/dist/api/resources/empathicVoice/types/UserInput.d.ts +2 -2
- package/dist/api/resources/empathicVoice/types/UserInterruption.d.ts +4 -4
- package/dist/api/resources/empathicVoice/types/UserMessage.d.ts +12 -12
- package/dist/api/resources/empathicVoice/types/WebSocketError.d.ts +10 -10
- package/dist/api/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +8 -8
- package/dist/api/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +6 -6
- package/dist/api/resources/empathicVoice/types/index.d.ts +16 -16
- package/dist/api/resources/empathicVoice/types/index.js +16 -16
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/api/resources/tts/client/Client.d.ts +6 -6
- package/dist/api/resources/tts/client/Client.js +35 -35
- package/dist/api/resources/tts/types/OctaveVersion.d.ts +4 -0
- package/dist/api/resources/tts/types/OctaveVersion.js +5 -0
- package/dist/api/resources/tts/types/PostedTts.d.ts +9 -8
- package/dist/api/resources/tts/types/PostedUtterance.d.ts +6 -6
- package/dist/api/resources/tts/types/ReturnGeneration.d.ts +5 -5
- package/dist/api/resources/tts/types/ReturnTts.d.ts +1 -1
- package/dist/api/resources/tts/types/Snippet.d.ts +6 -6
- package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +12 -11
- package/dist/api/resources/tts/types/index.d.ts +1 -0
- package/dist/api/resources/tts/types/index.js +1 -0
- package/dist/serialization/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/AssistantEnd.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/AssistantInput.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/AssistantMessage.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/AssistantMessage.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/AssistantProsody.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/AssistantProsody.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/AudioConfiguration.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/AudioConfiguration.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/AudioInput.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/AudioInput.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/AudioOutput.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/AudioOutput.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/BuiltinToolConfig.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/BuiltinToolConfig.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ChatMessage.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ChatMessage.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ChatMetadata.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/ChatMetadata.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/Context.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/Context.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/LanguageModelType.js +6 -0
- package/dist/serialization/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/PauseAssistantMessage.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ResumeAssistantMessage.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnConfig.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/SessionSettings.d.ts +8 -8
- package/dist/serialization/resources/empathicVoice/types/SessionSettings.js +8 -8
- package/dist/serialization/resources/empathicVoice/types/Tool.d.ts +3 -3
- package/dist/serialization/resources/empathicVoice/types/Tool.js +3 -3
- package/dist/serialization/resources/empathicVoice/types/ToolCallMessage.d.ts +3 -3
- package/dist/serialization/resources/empathicVoice/types/ToolCallMessage.js +3 -3
- package/dist/serialization/resources/empathicVoice/types/ToolErrorMessage.d.ts +6 -6
- package/dist/serialization/resources/empathicVoice/types/ToolErrorMessage.js +6 -6
- package/dist/serialization/resources/empathicVoice/types/ToolResponseMessage.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/ToolResponseMessage.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/UserInput.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/UserInput.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/UserInterruption.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/types/UserInterruption.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/UserMessage.d.ts +3 -3
- package/dist/serialization/resources/empathicVoice/types/UserMessage.js +3 -3
- package/dist/serialization/resources/empathicVoice/types/WebSocketError.d.ts +3 -3
- package/dist/serialization/resources/empathicVoice/types/WebSocketError.js +3 -3
- package/dist/serialization/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +4 -4
- package/dist/serialization/resources/empathicVoice/types/WebhookEventChatEnded.js +4 -4
- package/dist/serialization/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +3 -3
- package/dist/serialization/resources/empathicVoice/types/WebhookEventChatStarted.js +3 -3
- package/dist/serialization/resources/empathicVoice/types/index.d.ts +16 -16
- package/dist/serialization/resources/empathicVoice/types/index.js +16 -16
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/serialization/resources/tts/types/OctaveVersion.d.ts +10 -0
- package/dist/serialization/resources/tts/types/OctaveVersion.js +41 -0
- package/dist/serialization/resources/tts/types/PostedTts.d.ts +5 -3
- package/dist/serialization/resources/tts/types/PostedTts.js +5 -3
- package/dist/serialization/resources/tts/types/PostedUtterance.d.ts +2 -2
- package/dist/serialization/resources/tts/types/PostedUtterance.js +2 -2
- package/dist/serialization/resources/tts/types/ReturnGeneration.d.ts +3 -3
- package/dist/serialization/resources/tts/types/ReturnGeneration.js +3 -3
- package/dist/serialization/resources/tts/types/ReturnTts.d.ts +1 -1
- package/dist/serialization/resources/tts/types/ReturnTts.js +1 -1
- package/dist/serialization/resources/tts/types/Snippet.d.ts +3 -3
- package/dist/serialization/resources/tts/types/Snippet.js +3 -3
- package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +7 -6
- package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +7 -6
- package/dist/serialization/resources/tts/types/index.d.ts +1 -0
- package/dist/serialization/resources/tts/types/index.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/index.d.ts +1 -1
- package/dist/wrapper/index.js +53 -3
- package/package.json +1 -1
- package/reference.md +706 -706
- package/serialization/resources/empathicVoice/types/AssistantEnd.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/AssistantEnd.js +1 -1
- package/serialization/resources/empathicVoice/types/AssistantInput.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/AssistantInput.js +1 -1
- package/serialization/resources/empathicVoice/types/AssistantMessage.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/AssistantMessage.js +2 -2
- package/serialization/resources/empathicVoice/types/AssistantProsody.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/AssistantProsody.js +2 -2
- package/serialization/resources/empathicVoice/types/AudioConfiguration.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/AudioConfiguration.js +1 -1
- package/serialization/resources/empathicVoice/types/AudioInput.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/AudioInput.js +1 -1
- package/serialization/resources/empathicVoice/types/AudioOutput.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/AudioOutput.js +2 -2
- package/serialization/resources/empathicVoice/types/BuiltinToolConfig.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/BuiltinToolConfig.js +1 -1
- package/serialization/resources/empathicVoice/types/ChatMessage.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ChatMessage.js +1 -1
- package/serialization/resources/empathicVoice/types/ChatMetadata.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/ChatMetadata.js +2 -2
- package/serialization/resources/empathicVoice/types/Context.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/Context.js +1 -1
- package/serialization/resources/empathicVoice/types/LanguageModelType.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/LanguageModelType.js +6 -0
- package/serialization/resources/empathicVoice/types/PauseAssistantMessage.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/PauseAssistantMessage.js +1 -1
- package/serialization/resources/empathicVoice/types/ResumeAssistantMessage.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ResumeAssistantMessage.js +1 -1
- package/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/ReturnConfig.js +1 -1
- package/serialization/resources/empathicVoice/types/SessionSettings.d.ts +8 -8
- package/serialization/resources/empathicVoice/types/SessionSettings.js +8 -8
- package/serialization/resources/empathicVoice/types/Tool.d.ts +3 -3
- package/serialization/resources/empathicVoice/types/Tool.js +3 -3
- package/serialization/resources/empathicVoice/types/ToolCallMessage.d.ts +3 -3
- package/serialization/resources/empathicVoice/types/ToolCallMessage.js +3 -3
- package/serialization/resources/empathicVoice/types/ToolErrorMessage.d.ts +6 -6
- package/serialization/resources/empathicVoice/types/ToolErrorMessage.js +6 -6
- package/serialization/resources/empathicVoice/types/ToolResponseMessage.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/ToolResponseMessage.js +2 -2
- package/serialization/resources/empathicVoice/types/UserInput.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/UserInput.js +1 -1
- package/serialization/resources/empathicVoice/types/UserInterruption.d.ts +1 -1
- package/serialization/resources/empathicVoice/types/UserInterruption.js +1 -1
- package/serialization/resources/empathicVoice/types/UserMessage.d.ts +3 -3
- package/serialization/resources/empathicVoice/types/UserMessage.js +3 -3
- package/serialization/resources/empathicVoice/types/WebSocketError.d.ts +3 -3
- package/serialization/resources/empathicVoice/types/WebSocketError.js +3 -3
- package/serialization/resources/empathicVoice/types/WebhookEventChatEnded.d.ts +4 -4
- package/serialization/resources/empathicVoice/types/WebhookEventChatEnded.js +4 -4
- package/serialization/resources/empathicVoice/types/WebhookEventChatStarted.d.ts +3 -3
- package/serialization/resources/empathicVoice/types/WebhookEventChatStarted.js +3 -3
- package/serialization/resources/empathicVoice/types/index.d.ts +16 -16
- package/serialization/resources/empathicVoice/types/index.js +16 -16
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/serialization/resources/tts/types/OctaveVersion.d.ts +10 -0
- package/serialization/resources/tts/types/OctaveVersion.js +41 -0
- package/serialization/resources/tts/types/PostedTts.d.ts +5 -3
- package/serialization/resources/tts/types/PostedTts.js +5 -3
- package/serialization/resources/tts/types/PostedUtterance.d.ts +2 -2
- package/serialization/resources/tts/types/PostedUtterance.js +2 -2
- package/serialization/resources/tts/types/ReturnGeneration.d.ts +3 -3
- package/serialization/resources/tts/types/ReturnGeneration.js +3 -3
- package/serialization/resources/tts/types/ReturnTts.d.ts +1 -1
- package/serialization/resources/tts/types/ReturnTts.js +1 -1
- package/serialization/resources/tts/types/Snippet.d.ts +3 -3
- package/serialization/resources/tts/types/Snippet.js +3 -3
- package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +7 -6
- package/serialization/resources/tts/types/SnippetAudioChunk.js +7 -6
- package/serialization/resources/tts/types/index.d.ts +1 -0
- package/serialization/resources/tts/types/index.js +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/index.d.ts +1 -1
- package/wrapper/index.js +53 -3
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Tts
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
The response includes the base64-encoded audio and metadata in JSON format.
|
|
20
20
|
|
|
21
21
|
</dd>
|
|
22
22
|
</dl>
|
|
@@ -32,22 +32,28 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
32
32
|
<dd>
|
|
33
33
|
|
|
34
34
|
```typescript
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
35
|
+
await client.tts.synthesizeJson({
|
|
36
|
+
context: {
|
|
37
|
+
utterances: [
|
|
38
|
+
{
|
|
39
|
+
text: "How can people see beauty so differently?",
|
|
40
|
+
description:
|
|
41
|
+
"A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question.",
|
|
42
|
+
},
|
|
43
|
+
],
|
|
44
|
+
},
|
|
45
|
+
format: {
|
|
46
|
+
type: "mp3",
|
|
47
|
+
},
|
|
48
|
+
numGenerations: 1,
|
|
49
|
+
utterances: [
|
|
50
|
+
{
|
|
51
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
52
|
+
description:
|
|
53
|
+
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
|
|
54
|
+
},
|
|
55
|
+
],
|
|
47
56
|
});
|
|
48
|
-
while (page.hasNextPage()) {
|
|
49
|
-
page = page.getNextPage();
|
|
50
|
-
}
|
|
51
57
|
```
|
|
52
58
|
|
|
53
59
|
</dd>
|
|
@@ -63,7 +69,7 @@ while (page.hasNextPage()) {
|
|
|
63
69
|
<dl>
|
|
64
70
|
<dd>
|
|
65
71
|
|
|
66
|
-
**request:** `Hume.
|
|
72
|
+
**request:** `Hume.PostedTts`
|
|
67
73
|
|
|
68
74
|
</dd>
|
|
69
75
|
</dl>
|
|
@@ -71,7 +77,7 @@ while (page.hasNextPage()) {
|
|
|
71
77
|
<dl>
|
|
72
78
|
<dd>
|
|
73
79
|
|
|
74
|
-
**requestOptions:** `
|
|
80
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
75
81
|
|
|
76
82
|
</dd>
|
|
77
83
|
</dl>
|
|
@@ -82,7 +88,7 @@ while (page.hasNextPage()) {
|
|
|
82
88
|
</dl>
|
|
83
89
|
</details>
|
|
84
90
|
|
|
85
|
-
<details><summary><code>client.
|
|
91
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> stream.Readable</code></summary>
|
|
86
92
|
<dl>
|
|
87
93
|
<dd>
|
|
88
94
|
|
|
@@ -94,9 +100,9 @@ while (page.hasNextPage()) {
|
|
|
94
100
|
<dl>
|
|
95
101
|
<dd>
|
|
96
102
|
|
|
97
|
-
|
|
103
|
+
Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
98
104
|
|
|
99
|
-
|
|
105
|
+
The response contains the generated audio file in the requested format.
|
|
100
106
|
|
|
101
107
|
</dd>
|
|
102
108
|
</dl>
|
|
@@ -112,13 +118,21 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
112
118
|
<dd>
|
|
113
119
|
|
|
114
120
|
```typescript
|
|
115
|
-
await client.
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
121
|
+
await client.tts.synthesizeFile({
|
|
122
|
+
context: {
|
|
123
|
+
generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2",
|
|
124
|
+
},
|
|
125
|
+
format: {
|
|
126
|
+
type: "mp3",
|
|
127
|
+
},
|
|
128
|
+
numGenerations: 1,
|
|
129
|
+
utterances: [
|
|
130
|
+
{
|
|
131
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
132
|
+
description:
|
|
133
|
+
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
|
|
134
|
+
},
|
|
135
|
+
],
|
|
122
136
|
});
|
|
123
137
|
```
|
|
124
138
|
|
|
@@ -135,7 +149,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
135
149
|
<dl>
|
|
136
150
|
<dd>
|
|
137
151
|
|
|
138
|
-
**request:** `Hume.
|
|
152
|
+
**request:** `Hume.PostedTts`
|
|
139
153
|
|
|
140
154
|
</dd>
|
|
141
155
|
</dl>
|
|
@@ -143,7 +157,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
143
157
|
<dl>
|
|
144
158
|
<dd>
|
|
145
159
|
|
|
146
|
-
**requestOptions:** `
|
|
160
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
147
161
|
|
|
148
162
|
</dd>
|
|
149
163
|
</dl>
|
|
@@ -154,7 +168,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
154
168
|
</dl>
|
|
155
169
|
</details>
|
|
156
170
|
|
|
157
|
-
<details><summary><code>client.
|
|
171
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> stream.Readable</code></summary>
|
|
158
172
|
<dl>
|
|
159
173
|
<dd>
|
|
160
174
|
|
|
@@ -166,9 +180,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
166
180
|
<dl>
|
|
167
181
|
<dd>
|
|
168
182
|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
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.
|
|
183
|
+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
172
184
|
|
|
173
185
|
</dd>
|
|
174
186
|
</dl>
|
|
@@ -184,16 +196,17 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
184
196
|
<dd>
|
|
185
197
|
|
|
186
198
|
```typescript
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
199
|
+
await client.tts.synthesizeFileStreaming({
|
|
200
|
+
utterances: [
|
|
201
|
+
{
|
|
202
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
203
|
+
voice: {
|
|
204
|
+
name: "Male English Actor",
|
|
205
|
+
provider: "HUME_AI",
|
|
206
|
+
},
|
|
207
|
+
},
|
|
208
|
+
],
|
|
209
|
+
});
|
|
197
210
|
```
|
|
198
211
|
|
|
199
212
|
</dd>
|
|
@@ -209,15 +222,7 @@ while (page.hasNextPage()) {
|
|
|
209
222
|
<dl>
|
|
210
223
|
<dd>
|
|
211
224
|
|
|
212
|
-
**
|
|
213
|
-
|
|
214
|
-
</dd>
|
|
215
|
-
</dl>
|
|
216
|
-
|
|
217
|
-
<dl>
|
|
218
|
-
<dd>
|
|
219
|
-
|
|
220
|
-
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
225
|
+
**request:** `Hume.PostedTts`
|
|
221
226
|
|
|
222
227
|
</dd>
|
|
223
228
|
</dl>
|
|
@@ -225,7 +230,7 @@ while (page.hasNextPage()) {
|
|
|
225
230
|
<dl>
|
|
226
231
|
<dd>
|
|
227
232
|
|
|
228
|
-
**requestOptions:** `
|
|
233
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
229
234
|
|
|
230
235
|
</dd>
|
|
231
236
|
</dl>
|
|
@@ -236,7 +241,7 @@ while (page.hasNextPage()) {
|
|
|
236
241
|
</dl>
|
|
237
242
|
</details>
|
|
238
243
|
|
|
239
|
-
<details><summary><code>client.
|
|
244
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.SnippetAudioChunk></code></summary>
|
|
240
245
|
<dl>
|
|
241
246
|
<dd>
|
|
242
247
|
|
|
@@ -248,9 +253,9 @@ while (page.hasNextPage()) {
|
|
|
248
253
|
<dl>
|
|
249
254
|
<dd>
|
|
250
255
|
|
|
251
|
-
|
|
256
|
+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
252
257
|
|
|
253
|
-
|
|
258
|
+
The response is a stream of JSON objects including audio encoded in base64.
|
|
254
259
|
|
|
255
260
|
</dd>
|
|
256
261
|
</dl>
|
|
@@ -266,13 +271,20 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
266
271
|
<dd>
|
|
267
272
|
|
|
268
273
|
```typescript
|
|
269
|
-
await client.
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
274
|
+
const response = await client.tts.synthesizeJsonStreaming({
|
|
275
|
+
utterances: [
|
|
276
|
+
{
|
|
277
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
278
|
+
voice: {
|
|
279
|
+
name: "Male English Actor",
|
|
280
|
+
provider: "HUME_AI",
|
|
281
|
+
},
|
|
282
|
+
},
|
|
283
|
+
],
|
|
275
284
|
});
|
|
285
|
+
for await (const item of response) {
|
|
286
|
+
console.log(item);
|
|
287
|
+
}
|
|
276
288
|
```
|
|
277
289
|
|
|
278
290
|
</dd>
|
|
@@ -288,15 +300,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
288
300
|
<dl>
|
|
289
301
|
<dd>
|
|
290
302
|
|
|
291
|
-
**
|
|
292
|
-
|
|
293
|
-
</dd>
|
|
294
|
-
</dl>
|
|
295
|
-
|
|
296
|
-
<dl>
|
|
297
|
-
<dd>
|
|
298
|
-
|
|
299
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
303
|
+
**request:** `Hume.PostedTts`
|
|
300
304
|
|
|
301
305
|
</dd>
|
|
302
306
|
</dl>
|
|
@@ -304,7 +308,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
304
308
|
<dl>
|
|
305
309
|
<dd>
|
|
306
310
|
|
|
307
|
-
**requestOptions:** `
|
|
311
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
308
312
|
|
|
309
313
|
</dd>
|
|
310
314
|
</dl>
|
|
@@ -315,7 +319,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
315
319
|
</dl>
|
|
316
320
|
</details>
|
|
317
321
|
|
|
318
|
-
|
|
322
|
+
## Tts Voices
|
|
323
|
+
|
|
324
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice></code></summary>
|
|
319
325
|
<dl>
|
|
320
326
|
<dd>
|
|
321
327
|
|
|
@@ -327,9 +333,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
327
333
|
<dl>
|
|
328
334
|
<dd>
|
|
329
335
|
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
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.
|
|
336
|
+
Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
|
|
333
337
|
|
|
334
338
|
</dd>
|
|
335
339
|
</dl>
|
|
@@ -345,7 +349,20 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
345
349
|
<dd>
|
|
346
350
|
|
|
347
351
|
```typescript
|
|
348
|
-
await client.
|
|
352
|
+
const response = await client.tts.voices.list({
|
|
353
|
+
provider: "CUSTOM_VOICE",
|
|
354
|
+
});
|
|
355
|
+
for await (const item of response) {
|
|
356
|
+
console.log(item);
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
// Or you can manually iterate page-by-page
|
|
360
|
+
const page = await client.tts.voices.list({
|
|
361
|
+
provider: "CUSTOM_VOICE",
|
|
362
|
+
});
|
|
363
|
+
while (page.hasNextPage()) {
|
|
364
|
+
page = page.getNextPage();
|
|
365
|
+
}
|
|
349
366
|
```
|
|
350
367
|
|
|
351
368
|
</dd>
|
|
@@ -361,7 +378,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
361
378
|
<dl>
|
|
362
379
|
<dd>
|
|
363
380
|
|
|
364
|
-
**
|
|
381
|
+
**request:** `Hume.tts.VoicesListRequest`
|
|
365
382
|
|
|
366
383
|
</dd>
|
|
367
384
|
</dl>
|
|
@@ -369,7 +386,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
369
386
|
<dl>
|
|
370
387
|
<dd>
|
|
371
388
|
|
|
372
|
-
**requestOptions:** `
|
|
389
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
373
390
|
|
|
374
391
|
</dd>
|
|
375
392
|
</dl>
|
|
@@ -380,7 +397,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
380
397
|
</dl>
|
|
381
398
|
</details>
|
|
382
399
|
|
|
383
|
-
<details><summary><code>client.
|
|
400
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
|
|
384
401
|
<dl>
|
|
385
402
|
<dd>
|
|
386
403
|
|
|
@@ -392,9 +409,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
392
409
|
<dl>
|
|
393
410
|
<dd>
|
|
394
411
|
|
|
395
|
-
|
|
412
|
+
Saves a new custom voice to your account using the specified TTS generation ID.
|
|
396
413
|
|
|
397
|
-
|
|
414
|
+
Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
|
|
398
415
|
|
|
399
416
|
</dd>
|
|
400
417
|
</dl>
|
|
@@ -410,8 +427,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
410
427
|
<dd>
|
|
411
428
|
|
|
412
429
|
```typescript
|
|
413
|
-
await client.
|
|
414
|
-
|
|
430
|
+
await client.tts.voices.create({
|
|
431
|
+
generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
|
|
432
|
+
name: "David Hume",
|
|
415
433
|
});
|
|
416
434
|
```
|
|
417
435
|
|
|
@@ -428,15 +446,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
428
446
|
<dl>
|
|
429
447
|
<dd>
|
|
430
448
|
|
|
431
|
-
**
|
|
432
|
-
|
|
433
|
-
</dd>
|
|
434
|
-
</dl>
|
|
435
|
-
|
|
436
|
-
<dl>
|
|
437
|
-
<dd>
|
|
438
|
-
|
|
439
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
449
|
+
**request:** `Hume.tts.PostedVoice`
|
|
440
450
|
|
|
441
451
|
</dd>
|
|
442
452
|
</dl>
|
|
@@ -444,7 +454,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
444
454
|
<dl>
|
|
445
455
|
<dd>
|
|
446
456
|
|
|
447
|
-
**requestOptions:** `
|
|
457
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
448
458
|
|
|
449
459
|
</dd>
|
|
450
460
|
</dl>
|
|
@@ -455,7 +465,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
455
465
|
</dl>
|
|
456
466
|
</details>
|
|
457
467
|
|
|
458
|
-
<details><summary><code>client.
|
|
468
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
|
459
469
|
<dl>
|
|
460
470
|
<dd>
|
|
461
471
|
|
|
@@ -467,9 +477,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
467
477
|
<dl>
|
|
468
478
|
<dd>
|
|
469
479
|
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
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.
|
|
480
|
+
Deletes a previously generated custom voice.
|
|
473
481
|
|
|
474
482
|
</dd>
|
|
475
483
|
</dl>
|
|
@@ -485,7 +493,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
485
493
|
<dd>
|
|
486
494
|
|
|
487
495
|
```typescript
|
|
488
|
-
await client.
|
|
496
|
+
await client.tts.voices.delete({
|
|
497
|
+
name: "David Hume",
|
|
498
|
+
});
|
|
489
499
|
```
|
|
490
500
|
|
|
491
501
|
</dd>
|
|
@@ -501,21 +511,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
501
511
|
<dl>
|
|
502
512
|
<dd>
|
|
503
513
|
|
|
504
|
-
**
|
|
505
|
-
|
|
506
|
-
</dd>
|
|
507
|
-
</dl>
|
|
508
|
-
|
|
509
|
-
<dl>
|
|
510
|
-
<dd>
|
|
511
|
-
|
|
512
|
-
**version:** `number`
|
|
513
|
-
|
|
514
|
-
Version number for a Tool.
|
|
515
|
-
|
|
516
|
-
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.
|
|
517
|
-
|
|
518
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
514
|
+
**request:** `Hume.tts.VoicesDeleteRequest`
|
|
519
515
|
|
|
520
516
|
</dd>
|
|
521
517
|
</dl>
|
|
@@ -523,7 +519,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
523
519
|
<dl>
|
|
524
520
|
<dd>
|
|
525
521
|
|
|
526
|
-
**requestOptions:** `
|
|
522
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
527
523
|
|
|
528
524
|
</dd>
|
|
529
525
|
</dl>
|
|
@@ -534,7 +530,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
534
530
|
</dl>
|
|
535
531
|
</details>
|
|
536
532
|
|
|
537
|
-
|
|
533
|
+
## EmpathicVoice Tools
|
|
534
|
+
|
|
535
|
+
<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>
|
|
538
536
|
<dl>
|
|
539
537
|
<dd>
|
|
540
538
|
|
|
@@ -546,7 +544,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
546
544
|
<dl>
|
|
547
545
|
<dd>
|
|
548
546
|
|
|
549
|
-
|
|
547
|
+
Fetches a paginated list of **Tools**.
|
|
550
548
|
|
|
551
549
|
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.
|
|
552
550
|
|
|
@@ -564,37 +562,38 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
564
562
|
<dd>
|
|
565
563
|
|
|
566
564
|
```typescript
|
|
567
|
-
await client.empathicVoice.tools.
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
#### ⚙️ Parameters
|
|
565
|
+
const response = await client.empathicVoice.tools.listTools({
|
|
566
|
+
pageNumber: 0,
|
|
567
|
+
pageSize: 2,
|
|
568
|
+
});
|
|
569
|
+
for await (const item of response) {
|
|
570
|
+
console.log(item);
|
|
571
|
+
}
|
|
576
572
|
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
573
|
+
// Or you can manually iterate page-by-page
|
|
574
|
+
const page = await client.empathicVoice.tools.listTools({
|
|
575
|
+
pageNumber: 0,
|
|
576
|
+
pageSize: 2,
|
|
577
|
+
});
|
|
578
|
+
while (page.hasNextPage()) {
|
|
579
|
+
page = page.getNextPage();
|
|
580
|
+
}
|
|
581
|
+
```
|
|
584
582
|
|
|
585
583
|
</dd>
|
|
586
584
|
</dl>
|
|
585
|
+
</dd>
|
|
586
|
+
</dl>
|
|
587
|
+
|
|
588
|
+
#### ⚙️ Parameters
|
|
587
589
|
|
|
588
590
|
<dl>
|
|
589
591
|
<dd>
|
|
590
592
|
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
Version number for a Tool.
|
|
594
|
-
|
|
595
|
-
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.
|
|
593
|
+
<dl>
|
|
594
|
+
<dd>
|
|
596
595
|
|
|
597
|
-
|
|
596
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
598
597
|
|
|
599
598
|
</dd>
|
|
600
599
|
</dl>
|
|
@@ -613,7 +612,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
613
612
|
</dl>
|
|
614
613
|
</details>
|
|
615
614
|
|
|
616
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
615
|
+
<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>
|
|
617
616
|
<dl>
|
|
618
617
|
<dd>
|
|
619
618
|
|
|
@@ -625,7 +624,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
625
624
|
<dl>
|
|
626
625
|
<dd>
|
|
627
626
|
|
|
628
|
-
|
|
627
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
629
628
|
|
|
630
629
|
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.
|
|
631
630
|
|
|
@@ -643,9 +642,13 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
643
642
|
<dd>
|
|
644
643
|
|
|
645
644
|
```typescript
|
|
646
|
-
await client.empathicVoice.tools.
|
|
647
|
-
|
|
648
|
-
|
|
645
|
+
await client.empathicVoice.tools.createTool({
|
|
646
|
+
name: "get_current_weather",
|
|
647
|
+
parameters:
|
|
648
|
+
'{ "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"] }',
|
|
649
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
650
|
+
description: "This tool is for getting the current weather.",
|
|
651
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
649
652
|
});
|
|
650
653
|
```
|
|
651
654
|
|
|
@@ -662,29 +665,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
662
665
|
<dl>
|
|
663
666
|
<dd>
|
|
664
667
|
|
|
665
|
-
**
|
|
666
|
-
|
|
667
|
-
</dd>
|
|
668
|
-
</dl>
|
|
669
|
-
|
|
670
|
-
<dl>
|
|
671
|
-
<dd>
|
|
672
|
-
|
|
673
|
-
**version:** `number`
|
|
674
|
-
|
|
675
|
-
Version number for a Tool.
|
|
676
|
-
|
|
677
|
-
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.
|
|
678
|
-
|
|
679
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
680
|
-
|
|
681
|
-
</dd>
|
|
682
|
-
</dl>
|
|
683
|
-
|
|
684
|
-
<dl>
|
|
685
|
-
<dd>
|
|
686
|
-
|
|
687
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
668
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
688
669
|
|
|
689
670
|
</dd>
|
|
690
671
|
</dl>
|
|
@@ -703,9 +684,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
703
684
|
</dl>
|
|
704
685
|
</details>
|
|
705
686
|
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
<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>
|
|
687
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnUserDefinedTool | undefined></code></summary>
|
|
709
688
|
<dl>
|
|
710
689
|
<dd>
|
|
711
690
|
|
|
@@ -717,9 +696,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
717
696
|
<dl>
|
|
718
697
|
<dd>
|
|
719
698
|
|
|
720
|
-
Fetches a
|
|
699
|
+
Fetches a list of a **Tool's** versions.
|
|
721
700
|
|
|
722
|
-
|
|
701
|
+
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.
|
|
723
702
|
|
|
724
703
|
</dd>
|
|
725
704
|
</dl>
|
|
@@ -735,19 +714,13 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
735
714
|
<dd>
|
|
736
715
|
|
|
737
716
|
```typescript
|
|
738
|
-
const response = await client.empathicVoice.
|
|
739
|
-
pageNumber: 0,
|
|
740
|
-
pageSize: 2,
|
|
741
|
-
});
|
|
717
|
+
const response = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
742
718
|
for await (const item of response) {
|
|
743
719
|
console.log(item);
|
|
744
720
|
}
|
|
745
721
|
|
|
746
722
|
// Or you can manually iterate page-by-page
|
|
747
|
-
const page = await client.empathicVoice.
|
|
748
|
-
pageNumber: 0,
|
|
749
|
-
pageSize: 2,
|
|
750
|
-
});
|
|
723
|
+
const page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
751
724
|
while (page.hasNextPage()) {
|
|
752
725
|
page = page.getNextPage();
|
|
753
726
|
}
|
|
@@ -766,7 +739,7 @@ while (page.hasNextPage()) {
|
|
|
766
739
|
<dl>
|
|
767
740
|
<dd>
|
|
768
741
|
|
|
769
|
-
**
|
|
742
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
770
743
|
|
|
771
744
|
</dd>
|
|
772
745
|
</dl>
|
|
@@ -774,7 +747,15 @@ while (page.hasNextPage()) {
|
|
|
774
747
|
<dl>
|
|
775
748
|
<dd>
|
|
776
749
|
|
|
777
|
-
**
|
|
750
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
751
|
+
|
|
752
|
+
</dd>
|
|
753
|
+
</dl>
|
|
754
|
+
|
|
755
|
+
<dl>
|
|
756
|
+
<dd>
|
|
757
|
+
|
|
758
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
778
759
|
|
|
779
760
|
</dd>
|
|
780
761
|
</dl>
|
|
@@ -785,7 +766,7 @@ while (page.hasNextPage()) {
|
|
|
785
766
|
</dl>
|
|
786
767
|
</details>
|
|
787
768
|
|
|
788
|
-
<details><summary><code>client.empathicVoice.
|
|
769
|
+
<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>
|
|
789
770
|
<dl>
|
|
790
771
|
<dd>
|
|
791
772
|
|
|
@@ -797,9 +778,9 @@ while (page.hasNextPage()) {
|
|
|
797
778
|
<dl>
|
|
798
779
|
<dd>
|
|
799
780
|
|
|
800
|
-
|
|
781
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
801
782
|
|
|
802
|
-
|
|
783
|
+
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.
|
|
803
784
|
|
|
804
785
|
</dd>
|
|
805
786
|
</dl>
|
|
@@ -815,9 +796,12 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
815
796
|
<dd>
|
|
816
797
|
|
|
817
798
|
```typescript
|
|
818
|
-
await client.empathicVoice.
|
|
819
|
-
|
|
820
|
-
|
|
799
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
800
|
+
parameters:
|
|
801
|
+
'{ "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"] }',
|
|
802
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
803
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
804
|
+
description: "This tool is for getting the current weather.",
|
|
821
805
|
});
|
|
822
806
|
```
|
|
823
807
|
|
|
@@ -834,7 +818,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
834
818
|
<dl>
|
|
835
819
|
<dd>
|
|
836
820
|
|
|
837
|
-
**
|
|
821
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
838
822
|
|
|
839
823
|
</dd>
|
|
840
824
|
</dl>
|
|
@@ -842,7 +826,15 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
842
826
|
<dl>
|
|
843
827
|
<dd>
|
|
844
828
|
|
|
845
|
-
**
|
|
829
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
830
|
+
|
|
831
|
+
</dd>
|
|
832
|
+
</dl>
|
|
833
|
+
|
|
834
|
+
<dl>
|
|
835
|
+
<dd>
|
|
836
|
+
|
|
837
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
846
838
|
|
|
847
839
|
</dd>
|
|
848
840
|
</dl>
|
|
@@ -853,7 +845,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
853
845
|
</dl>
|
|
854
846
|
</details>
|
|
855
847
|
|
|
856
|
-
<details><summary><code>client.empathicVoice.
|
|
848
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
857
849
|
<dl>
|
|
858
850
|
<dd>
|
|
859
851
|
|
|
@@ -865,9 +857,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
865
857
|
<dl>
|
|
866
858
|
<dd>
|
|
867
859
|
|
|
868
|
-
|
|
860
|
+
Deletes a **Tool** and its versions.
|
|
869
861
|
|
|
870
|
-
|
|
862
|
+
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.
|
|
871
863
|
|
|
872
864
|
</dd>
|
|
873
865
|
</dl>
|
|
@@ -883,7 +875,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
883
875
|
<dd>
|
|
884
876
|
|
|
885
877
|
```typescript
|
|
886
|
-
await client.empathicVoice.
|
|
878
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
887
879
|
```
|
|
888
880
|
|
|
889
881
|
</dd>
|
|
@@ -899,15 +891,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
899
891
|
<dl>
|
|
900
892
|
<dd>
|
|
901
893
|
|
|
902
|
-
**id:** `string` — Identifier for a
|
|
903
|
-
|
|
904
|
-
</dd>
|
|
905
|
-
</dl>
|
|
906
|
-
|
|
907
|
-
<dl>
|
|
908
|
-
<dd>
|
|
909
|
-
|
|
910
|
-
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
894
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
911
895
|
|
|
912
896
|
</dd>
|
|
913
897
|
</dl>
|
|
@@ -915,7 +899,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
915
899
|
<dl>
|
|
916
900
|
<dd>
|
|
917
901
|
|
|
918
|
-
**requestOptions:** `
|
|
902
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
919
903
|
|
|
920
904
|
</dd>
|
|
921
905
|
</dl>
|
|
@@ -926,7 +910,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
926
910
|
</dl>
|
|
927
911
|
</details>
|
|
928
912
|
|
|
929
|
-
<details><summary><code>client.empathicVoice.
|
|
913
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
930
914
|
<dl>
|
|
931
915
|
<dd>
|
|
932
916
|
|
|
@@ -938,9 +922,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
938
922
|
<dl>
|
|
939
923
|
<dd>
|
|
940
924
|
|
|
941
|
-
Updates
|
|
925
|
+
Updates the name of a **Tool**.
|
|
942
926
|
|
|
943
|
-
|
|
927
|
+
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.
|
|
944
928
|
|
|
945
929
|
</dd>
|
|
946
930
|
</dl>
|
|
@@ -956,9 +940,8 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
956
940
|
<dd>
|
|
957
941
|
|
|
958
942
|
```typescript
|
|
959
|
-
await client.empathicVoice.
|
|
960
|
-
|
|
961
|
-
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
943
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
944
|
+
name: "get_current_temperature",
|
|
962
945
|
});
|
|
963
946
|
```
|
|
964
947
|
|
|
@@ -975,7 +958,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
975
958
|
<dl>
|
|
976
959
|
<dd>
|
|
977
960
|
|
|
978
|
-
**id:** `string` — Identifier for a
|
|
961
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
979
962
|
|
|
980
963
|
</dd>
|
|
981
964
|
</dl>
|
|
@@ -983,7 +966,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
983
966
|
<dl>
|
|
984
967
|
<dd>
|
|
985
968
|
|
|
986
|
-
**request:** `Hume.empathicVoice.
|
|
969
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
987
970
|
|
|
988
971
|
</dd>
|
|
989
972
|
</dl>
|
|
@@ -991,7 +974,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
991
974
|
<dl>
|
|
992
975
|
<dd>
|
|
993
976
|
|
|
994
|
-
**requestOptions:** `
|
|
977
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
995
978
|
|
|
996
979
|
</dd>
|
|
997
980
|
</dl>
|
|
@@ -1002,7 +985,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1002
985
|
</dl>
|
|
1003
986
|
</details>
|
|
1004
987
|
|
|
1005
|
-
<details><summary><code>client.empathicVoice.
|
|
988
|
+
<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>
|
|
1006
989
|
<dl>
|
|
1007
990
|
<dd>
|
|
1008
991
|
|
|
@@ -1014,9 +997,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1014
997
|
<dl>
|
|
1015
998
|
<dd>
|
|
1016
999
|
|
|
1017
|
-
|
|
1000
|
+
Fetches a specified version of a **Tool**.
|
|
1018
1001
|
|
|
1019
|
-
|
|
1002
|
+
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
1003
|
|
|
1021
1004
|
</dd>
|
|
1022
1005
|
</dl>
|
|
@@ -1032,7 +1015,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1032
1015
|
<dd>
|
|
1033
1016
|
|
|
1034
1017
|
```typescript
|
|
1035
|
-
await client.empathicVoice.
|
|
1018
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1036
1019
|
```
|
|
1037
1020
|
|
|
1038
1021
|
</dd>
|
|
@@ -1048,7 +1031,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1048
1031
|
<dl>
|
|
1049
1032
|
<dd>
|
|
1050
1033
|
|
|
1051
|
-
**id:** `string` — Identifier for a
|
|
1034
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1052
1035
|
|
|
1053
1036
|
</dd>
|
|
1054
1037
|
</dl>
|
|
@@ -1056,7 +1039,21 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1056
1039
|
<dl>
|
|
1057
1040
|
<dd>
|
|
1058
1041
|
|
|
1059
|
-
**
|
|
1042
|
+
**version:** `number`
|
|
1043
|
+
|
|
1044
|
+
Version number for a Tool.
|
|
1045
|
+
|
|
1046
|
+
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.
|
|
1047
|
+
|
|
1048
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1049
|
+
|
|
1050
|
+
</dd>
|
|
1051
|
+
</dl>
|
|
1052
|
+
|
|
1053
|
+
<dl>
|
|
1054
|
+
<dd>
|
|
1055
|
+
|
|
1056
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1060
1057
|
|
|
1061
1058
|
</dd>
|
|
1062
1059
|
</dl>
|
|
@@ -1067,7 +1064,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1067
1064
|
</dl>
|
|
1068
1065
|
</details>
|
|
1069
1066
|
|
|
1070
|
-
<details><summary><code>client.empathicVoice.
|
|
1067
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
1071
1068
|
<dl>
|
|
1072
1069
|
<dd>
|
|
1073
1070
|
|
|
@@ -1079,9 +1076,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1079
1076
|
<dl>
|
|
1080
1077
|
<dd>
|
|
1081
1078
|
|
|
1082
|
-
|
|
1079
|
+
Deletes a specified version of a **Tool**.
|
|
1083
1080
|
|
|
1084
|
-
|
|
1081
|
+
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.
|
|
1085
1082
|
|
|
1086
1083
|
</dd>
|
|
1087
1084
|
</dl>
|
|
@@ -1097,9 +1094,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1097
1094
|
<dd>
|
|
1098
1095
|
|
|
1099
1096
|
```typescript
|
|
1100
|
-
await client.empathicVoice.
|
|
1101
|
-
name: "Updated Weather Assistant Prompt Name",
|
|
1102
|
-
});
|
|
1097
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
1103
1098
|
```
|
|
1104
1099
|
|
|
1105
1100
|
</dd>
|
|
@@ -1115,7 +1110,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1115
1110
|
<dl>
|
|
1116
1111
|
<dd>
|
|
1117
1112
|
|
|
1118
|
-
**id:** `string` — Identifier for a
|
|
1113
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1119
1114
|
|
|
1120
1115
|
</dd>
|
|
1121
1116
|
</dl>
|
|
@@ -1123,7 +1118,13 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1123
1118
|
<dl>
|
|
1124
1119
|
<dd>
|
|
1125
1120
|
|
|
1126
|
-
**
|
|
1121
|
+
**version:** `number`
|
|
1122
|
+
|
|
1123
|
+
Version number for a Tool.
|
|
1124
|
+
|
|
1125
|
+
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.
|
|
1126
|
+
|
|
1127
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1127
1128
|
|
|
1128
1129
|
</dd>
|
|
1129
1130
|
</dl>
|
|
@@ -1131,7 +1132,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1131
1132
|
<dl>
|
|
1132
1133
|
<dd>
|
|
1133
1134
|
|
|
1134
|
-
**requestOptions:** `
|
|
1135
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1135
1136
|
|
|
1136
1137
|
</dd>
|
|
1137
1138
|
</dl>
|
|
@@ -1142,7 +1143,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1142
1143
|
</dl>
|
|
1143
1144
|
</details>
|
|
1144
1145
|
|
|
1145
|
-
<details><summary><code>client.empathicVoice.
|
|
1146
|
+
<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>
|
|
1146
1147
|
<dl>
|
|
1147
1148
|
<dd>
|
|
1148
1149
|
|
|
@@ -1154,9 +1155,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1154
1155
|
<dl>
|
|
1155
1156
|
<dd>
|
|
1156
1157
|
|
|
1157
|
-
|
|
1158
|
+
Updates the description of a specified **Tool** version.
|
|
1158
1159
|
|
|
1159
|
-
|
|
1160
|
+
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.
|
|
1160
1161
|
|
|
1161
1162
|
</dd>
|
|
1162
1163
|
</dl>
|
|
@@ -1172,7 +1173,10 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1172
1173
|
<dd>
|
|
1173
1174
|
|
|
1174
1175
|
```typescript
|
|
1175
|
-
await client.empathicVoice.
|
|
1176
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
1177
|
+
versionDescription:
|
|
1178
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1179
|
+
});
|
|
1176
1180
|
```
|
|
1177
1181
|
|
|
1178
1182
|
</dd>
|
|
@@ -1188,7 +1192,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1188
1192
|
<dl>
|
|
1189
1193
|
<dd>
|
|
1190
1194
|
|
|
1191
|
-
**id:** `string` — Identifier for a
|
|
1195
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
1192
1196
|
|
|
1193
1197
|
</dd>
|
|
1194
1198
|
</dl>
|
|
@@ -1198,11 +1202,11 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1198
1202
|
|
|
1199
1203
|
**version:** `number`
|
|
1200
1204
|
|
|
1201
|
-
Version number for a
|
|
1205
|
+
Version number for a Tool.
|
|
1202
1206
|
|
|
1203
|
-
|
|
1207
|
+
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.
|
|
1204
1208
|
|
|
1205
|
-
Version numbers are integer values representing different iterations of the
|
|
1209
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1206
1210
|
|
|
1207
1211
|
</dd>
|
|
1208
1212
|
</dl>
|
|
@@ -1210,7 +1214,15 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1210
1214
|
<dl>
|
|
1211
1215
|
<dd>
|
|
1212
1216
|
|
|
1213
|
-
**
|
|
1217
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
1218
|
+
|
|
1219
|
+
</dd>
|
|
1220
|
+
</dl>
|
|
1221
|
+
|
|
1222
|
+
<dl>
|
|
1223
|
+
<dd>
|
|
1224
|
+
|
|
1225
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
1214
1226
|
|
|
1215
1227
|
</dd>
|
|
1216
1228
|
</dl>
|
|
@@ -1221,7 +1233,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1221
1233
|
</dl>
|
|
1222
1234
|
</details>
|
|
1223
1235
|
|
|
1224
|
-
|
|
1236
|
+
## EmpathicVoice Prompts
|
|
1237
|
+
|
|
1238
|
+
<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>
|
|
1225
1239
|
<dl>
|
|
1226
1240
|
<dd>
|
|
1227
1241
|
|
|
@@ -1233,7 +1247,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1233
1247
|
<dl>
|
|
1234
1248
|
<dd>
|
|
1235
1249
|
|
|
1236
|
-
|
|
1250
|
+
Fetches a paginated list of **Prompts**.
|
|
1237
1251
|
|
|
1238
1252
|
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1239
1253
|
|
|
@@ -1251,12 +1265,27 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1251
1265
|
<dd>
|
|
1252
1266
|
|
|
1253
1267
|
```typescript
|
|
1254
|
-
await client.empathicVoice.prompts.
|
|
1255
|
-
|
|
1268
|
+
const response = await client.empathicVoice.prompts.listPrompts({
|
|
1269
|
+
pageNumber: 0,
|
|
1270
|
+
pageSize: 2,
|
|
1271
|
+
});
|
|
1272
|
+
for await (const item of response) {
|
|
1273
|
+
console.log(item);
|
|
1274
|
+
}
|
|
1256
1275
|
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1276
|
+
// Or you can manually iterate page-by-page
|
|
1277
|
+
const page = await client.empathicVoice.prompts.listPrompts({
|
|
1278
|
+
pageNumber: 0,
|
|
1279
|
+
pageSize: 2,
|
|
1280
|
+
});
|
|
1281
|
+
while (page.hasNextPage()) {
|
|
1282
|
+
page = page.getNextPage();
|
|
1283
|
+
}
|
|
1284
|
+
```
|
|
1285
|
+
|
|
1286
|
+
</dd>
|
|
1287
|
+
</dl>
|
|
1288
|
+
</dd>
|
|
1260
1289
|
</dl>
|
|
1261
1290
|
|
|
1262
1291
|
#### ⚙️ Parameters
|
|
@@ -1267,21 +1296,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1267
1296
|
<dl>
|
|
1268
1297
|
<dd>
|
|
1269
1298
|
|
|
1270
|
-
**
|
|
1271
|
-
|
|
1272
|
-
</dd>
|
|
1273
|
-
</dl>
|
|
1274
|
-
|
|
1275
|
-
<dl>
|
|
1276
|
-
<dd>
|
|
1277
|
-
|
|
1278
|
-
**version:** `number`
|
|
1279
|
-
|
|
1280
|
-
Version number for a Prompt.
|
|
1281
|
-
|
|
1282
|
-
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.
|
|
1283
|
-
|
|
1284
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1299
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
1285
1300
|
|
|
1286
1301
|
</dd>
|
|
1287
1302
|
</dl>
|
|
@@ -1300,7 +1315,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1300
1315
|
</dl>
|
|
1301
1316
|
</details>
|
|
1302
1317
|
|
|
1303
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1318
|
+
<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>
|
|
1304
1319
|
<dl>
|
|
1305
1320
|
<dd>
|
|
1306
1321
|
|
|
@@ -1312,7 +1327,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1312
1327
|
<dl>
|
|
1313
1328
|
<dd>
|
|
1314
1329
|
|
|
1315
|
-
|
|
1330
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
1316
1331
|
|
|
1317
1332
|
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1318
1333
|
|
|
@@ -1330,8 +1345,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1330
1345
|
<dd>
|
|
1331
1346
|
|
|
1332
1347
|
```typescript
|
|
1333
|
-
await client.empathicVoice.prompts.
|
|
1334
|
-
|
|
1348
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1349
|
+
name: "Weather Assistant Prompt",
|
|
1350
|
+
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>",
|
|
1335
1351
|
});
|
|
1336
1352
|
```
|
|
1337
1353
|
|
|
@@ -1348,29 +1364,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1348
1364
|
<dl>
|
|
1349
1365
|
<dd>
|
|
1350
1366
|
|
|
1351
|
-
**
|
|
1352
|
-
|
|
1353
|
-
</dd>
|
|
1354
|
-
</dl>
|
|
1355
|
-
|
|
1356
|
-
<dl>
|
|
1357
|
-
<dd>
|
|
1358
|
-
|
|
1359
|
-
**version:** `number`
|
|
1360
|
-
|
|
1361
|
-
Version number for a Prompt.
|
|
1362
|
-
|
|
1363
|
-
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.
|
|
1364
|
-
|
|
1365
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1366
|
-
|
|
1367
|
-
</dd>
|
|
1368
|
-
</dl>
|
|
1369
|
-
|
|
1370
|
-
<dl>
|
|
1371
|
-
<dd>
|
|
1372
|
-
|
|
1373
|
-
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1367
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
1374
1368
|
|
|
1375
1369
|
</dd>
|
|
1376
1370
|
</dl>
|
|
@@ -1389,9 +1383,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1389
1383
|
</dl>
|
|
1390
1384
|
</details>
|
|
1391
1385
|
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
<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>
|
|
1386
|
+
<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>
|
|
1395
1387
|
<dl>
|
|
1396
1388
|
<dd>
|
|
1397
1389
|
|
|
@@ -1403,9 +1395,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1403
1395
|
<dl>
|
|
1404
1396
|
<dd>
|
|
1405
1397
|
|
|
1406
|
-
Fetches a
|
|
1398
|
+
Fetches a list of a **Prompt's** versions.
|
|
1407
1399
|
|
|
1408
|
-
|
|
1400
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1409
1401
|
|
|
1410
1402
|
</dd>
|
|
1411
1403
|
</dl>
|
|
@@ -1421,22 +1413,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1421
1413
|
<dd>
|
|
1422
1414
|
|
|
1423
1415
|
```typescript
|
|
1424
|
-
|
|
1425
|
-
pageNumber: 0,
|
|
1426
|
-
pageSize: 1,
|
|
1427
|
-
});
|
|
1428
|
-
for await (const item of response) {
|
|
1429
|
-
console.log(item);
|
|
1430
|
-
}
|
|
1431
|
-
|
|
1432
|
-
// Or you can manually iterate page-by-page
|
|
1433
|
-
const page = await client.empathicVoice.configs.listConfigs({
|
|
1434
|
-
pageNumber: 0,
|
|
1435
|
-
pageSize: 1,
|
|
1436
|
-
});
|
|
1437
|
-
while (page.hasNextPage()) {
|
|
1438
|
-
page = page.getNextPage();
|
|
1439
|
-
}
|
|
1416
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1440
1417
|
```
|
|
1441
1418
|
|
|
1442
1419
|
</dd>
|
|
@@ -1452,7 +1429,7 @@ while (page.hasNextPage()) {
|
|
|
1452
1429
|
<dl>
|
|
1453
1430
|
<dd>
|
|
1454
1431
|
|
|
1455
|
-
**
|
|
1432
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1456
1433
|
|
|
1457
1434
|
</dd>
|
|
1458
1435
|
</dl>
|
|
@@ -1460,7 +1437,15 @@ while (page.hasNextPage()) {
|
|
|
1460
1437
|
<dl>
|
|
1461
1438
|
<dd>
|
|
1462
1439
|
|
|
1463
|
-
**
|
|
1440
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1441
|
+
|
|
1442
|
+
</dd>
|
|
1443
|
+
</dl>
|
|
1444
|
+
|
|
1445
|
+
<dl>
|
|
1446
|
+
<dd>
|
|
1447
|
+
|
|
1448
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1464
1449
|
|
|
1465
1450
|
</dd>
|
|
1466
1451
|
</dl>
|
|
@@ -1471,7 +1456,7 @@ while (page.hasNextPage()) {
|
|
|
1471
1456
|
</dl>
|
|
1472
1457
|
</details>
|
|
1473
1458
|
|
|
1474
|
-
<details><summary><code>client.empathicVoice.
|
|
1459
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
1475
1460
|
<dl>
|
|
1476
1461
|
<dd>
|
|
1477
1462
|
|
|
@@ -1483,9 +1468,9 @@ while (page.hasNextPage()) {
|
|
|
1483
1468
|
<dl>
|
|
1484
1469
|
<dd>
|
|
1485
1470
|
|
|
1486
|
-
|
|
1471
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1487
1472
|
|
|
1488
|
-
|
|
1473
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1489
1474
|
|
|
1490
1475
|
</dd>
|
|
1491
1476
|
</dl>
|
|
@@ -1501,36 +1486,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1501
1486
|
<dd>
|
|
1502
1487
|
|
|
1503
1488
|
```typescript
|
|
1504
|
-
await client.empathicVoice.
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1508
|
-
version: 0,
|
|
1509
|
-
},
|
|
1510
|
-
eviVersion: "3",
|
|
1511
|
-
voice: {
|
|
1512
|
-
provider: "HUME_AI",
|
|
1513
|
-
name: "Ava Song",
|
|
1514
|
-
},
|
|
1515
|
-
languageModel: {
|
|
1516
|
-
modelProvider: "ANTHROPIC",
|
|
1517
|
-
modelResource: "claude-3-7-sonnet-latest",
|
|
1518
|
-
temperature: 1,
|
|
1519
|
-
},
|
|
1520
|
-
eventMessages: {
|
|
1521
|
-
onNewChat: {
|
|
1522
|
-
enabled: false,
|
|
1523
|
-
text: "",
|
|
1524
|
-
},
|
|
1525
|
-
onInactivityTimeout: {
|
|
1526
|
-
enabled: false,
|
|
1527
|
-
text: "",
|
|
1528
|
-
},
|
|
1529
|
-
onMaxDurationTimeout: {
|
|
1530
|
-
enabled: false,
|
|
1531
|
-
text: "",
|
|
1532
|
-
},
|
|
1533
|
-
},
|
|
1489
|
+
await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1490
|
+
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>",
|
|
1491
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1534
1492
|
});
|
|
1535
1493
|
```
|
|
1536
1494
|
|
|
@@ -1547,7 +1505,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1547
1505
|
<dl>
|
|
1548
1506
|
<dd>
|
|
1549
1507
|
|
|
1550
|
-
**
|
|
1508
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1551
1509
|
|
|
1552
1510
|
</dd>
|
|
1553
1511
|
</dl>
|
|
@@ -1555,7 +1513,15 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1555
1513
|
<dl>
|
|
1556
1514
|
<dd>
|
|
1557
1515
|
|
|
1558
|
-
**
|
|
1516
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1517
|
+
|
|
1518
|
+
</dd>
|
|
1519
|
+
</dl>
|
|
1520
|
+
|
|
1521
|
+
<dl>
|
|
1522
|
+
<dd>
|
|
1523
|
+
|
|
1524
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1559
1525
|
|
|
1560
1526
|
</dd>
|
|
1561
1527
|
</dl>
|
|
@@ -1566,7 +1532,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1566
1532
|
</dl>
|
|
1567
1533
|
</details>
|
|
1568
1534
|
|
|
1569
|
-
<details><summary><code>client.empathicVoice.
|
|
1535
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
1570
1536
|
<dl>
|
|
1571
1537
|
<dd>
|
|
1572
1538
|
|
|
@@ -1578,9 +1544,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1578
1544
|
<dl>
|
|
1579
1545
|
<dd>
|
|
1580
1546
|
|
|
1581
|
-
|
|
1547
|
+
Deletes a **Prompt** and its versions.
|
|
1582
1548
|
|
|
1583
|
-
|
|
1549
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1584
1550
|
|
|
1585
1551
|
</dd>
|
|
1586
1552
|
</dl>
|
|
@@ -1596,16 +1562,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1596
1562
|
<dd>
|
|
1597
1563
|
|
|
1598
1564
|
```typescript
|
|
1599
|
-
|
|
1600
|
-
for await (const item of response) {
|
|
1601
|
-
console.log(item);
|
|
1602
|
-
}
|
|
1603
|
-
|
|
1604
|
-
// Or you can manually iterate page-by-page
|
|
1605
|
-
const page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1606
|
-
while (page.hasNextPage()) {
|
|
1607
|
-
page = page.getNextPage();
|
|
1608
|
-
}
|
|
1565
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1609
1566
|
```
|
|
1610
1567
|
|
|
1611
1568
|
</dd>
|
|
@@ -1621,15 +1578,7 @@ while (page.hasNextPage()) {
|
|
|
1621
1578
|
<dl>
|
|
1622
1579
|
<dd>
|
|
1623
1580
|
|
|
1624
|
-
**id:** `string` — Identifier for a
|
|
1625
|
-
|
|
1626
|
-
</dd>
|
|
1627
|
-
</dl>
|
|
1628
|
-
|
|
1629
|
-
<dl>
|
|
1630
|
-
<dd>
|
|
1631
|
-
|
|
1632
|
-
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
1581
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1633
1582
|
|
|
1634
1583
|
</dd>
|
|
1635
1584
|
</dl>
|
|
@@ -1637,7 +1586,7 @@ while (page.hasNextPage()) {
|
|
|
1637
1586
|
<dl>
|
|
1638
1587
|
<dd>
|
|
1639
1588
|
|
|
1640
|
-
**requestOptions:** `
|
|
1589
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1641
1590
|
|
|
1642
1591
|
</dd>
|
|
1643
1592
|
</dl>
|
|
@@ -1648,7 +1597,7 @@ while (page.hasNextPage()) {
|
|
|
1648
1597
|
</dl>
|
|
1649
1598
|
</details>
|
|
1650
1599
|
|
|
1651
|
-
<details><summary><code>client.empathicVoice.
|
|
1600
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1652
1601
|
<dl>
|
|
1653
1602
|
<dd>
|
|
1654
1603
|
|
|
@@ -1660,9 +1609,9 @@ while (page.hasNextPage()) {
|
|
|
1660
1609
|
<dl>
|
|
1661
1610
|
<dd>
|
|
1662
1611
|
|
|
1663
|
-
Updates
|
|
1612
|
+
Updates the name of a **Prompt**.
|
|
1664
1613
|
|
|
1665
|
-
|
|
1614
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1666
1615
|
|
|
1667
1616
|
</dd>
|
|
1668
1617
|
</dl>
|
|
@@ -1678,39 +1627,8 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1678
1627
|
<dd>
|
|
1679
1628
|
|
|
1680
1629
|
```typescript
|
|
1681
|
-
await client.empathicVoice.
|
|
1682
|
-
|
|
1683
|
-
eviVersion: "3",
|
|
1684
|
-
prompt: {
|
|
1685
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1686
|
-
version: 0,
|
|
1687
|
-
},
|
|
1688
|
-
voice: {
|
|
1689
|
-
provider: "HUME_AI",
|
|
1690
|
-
name: "Ava Song",
|
|
1691
|
-
},
|
|
1692
|
-
languageModel: {
|
|
1693
|
-
modelProvider: "ANTHROPIC",
|
|
1694
|
-
modelResource: "claude-3-7-sonnet-latest",
|
|
1695
|
-
temperature: 1,
|
|
1696
|
-
},
|
|
1697
|
-
ellmModel: {
|
|
1698
|
-
allowShortResponses: true,
|
|
1699
|
-
},
|
|
1700
|
-
eventMessages: {
|
|
1701
|
-
onNewChat: {
|
|
1702
|
-
enabled: false,
|
|
1703
|
-
text: "",
|
|
1704
|
-
},
|
|
1705
|
-
onInactivityTimeout: {
|
|
1706
|
-
enabled: false,
|
|
1707
|
-
text: "",
|
|
1708
|
-
},
|
|
1709
|
-
onMaxDurationTimeout: {
|
|
1710
|
-
enabled: false,
|
|
1711
|
-
text: "",
|
|
1712
|
-
},
|
|
1713
|
-
},
|
|
1630
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1631
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
1714
1632
|
});
|
|
1715
1633
|
```
|
|
1716
1634
|
|
|
@@ -1727,7 +1645,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1727
1645
|
<dl>
|
|
1728
1646
|
<dd>
|
|
1729
1647
|
|
|
1730
|
-
**id:** `string` — Identifier for a
|
|
1648
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1731
1649
|
|
|
1732
1650
|
</dd>
|
|
1733
1651
|
</dl>
|
|
@@ -1735,7 +1653,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1735
1653
|
<dl>
|
|
1736
1654
|
<dd>
|
|
1737
1655
|
|
|
1738
|
-
**request:** `Hume.empathicVoice.
|
|
1656
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1739
1657
|
|
|
1740
1658
|
</dd>
|
|
1741
1659
|
</dl>
|
|
@@ -1743,7 +1661,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1743
1661
|
<dl>
|
|
1744
1662
|
<dd>
|
|
1745
1663
|
|
|
1746
|
-
**requestOptions:** `
|
|
1664
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1747
1665
|
|
|
1748
1666
|
</dd>
|
|
1749
1667
|
</dl>
|
|
@@ -1754,7 +1672,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1754
1672
|
</dl>
|
|
1755
1673
|
</details>
|
|
1756
1674
|
|
|
1757
|
-
<details><summary><code>client.empathicVoice.
|
|
1675
|
+
<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>
|
|
1758
1676
|
<dl>
|
|
1759
1677
|
<dd>
|
|
1760
1678
|
|
|
@@ -1766,9 +1684,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
1766
1684
|
<dl>
|
|
1767
1685
|
<dd>
|
|
1768
1686
|
|
|
1769
|
-
|
|
1687
|
+
Fetches a specified version of a **Prompt**.
|
|
1770
1688
|
|
|
1771
|
-
|
|
1689
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1772
1690
|
|
|
1773
1691
|
</dd>
|
|
1774
1692
|
</dl>
|
|
@@ -1784,7 +1702,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1784
1702
|
<dd>
|
|
1785
1703
|
|
|
1786
1704
|
```typescript
|
|
1787
|
-
await client.empathicVoice.
|
|
1705
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
1788
1706
|
```
|
|
1789
1707
|
|
|
1790
1708
|
</dd>
|
|
@@ -1800,7 +1718,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1800
1718
|
<dl>
|
|
1801
1719
|
<dd>
|
|
1802
1720
|
|
|
1803
|
-
**id:** `string` — Identifier for a
|
|
1721
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1804
1722
|
|
|
1805
1723
|
</dd>
|
|
1806
1724
|
</dl>
|
|
@@ -1808,7 +1726,21 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1808
1726
|
<dl>
|
|
1809
1727
|
<dd>
|
|
1810
1728
|
|
|
1811
|
-
**
|
|
1729
|
+
**version:** `number`
|
|
1730
|
+
|
|
1731
|
+
Version number for a Prompt.
|
|
1732
|
+
|
|
1733
|
+
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.
|
|
1734
|
+
|
|
1735
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1736
|
+
|
|
1737
|
+
</dd>
|
|
1738
|
+
</dl>
|
|
1739
|
+
|
|
1740
|
+
<dl>
|
|
1741
|
+
<dd>
|
|
1742
|
+
|
|
1743
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1812
1744
|
|
|
1813
1745
|
</dd>
|
|
1814
1746
|
</dl>
|
|
@@ -1819,7 +1751,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1819
1751
|
</dl>
|
|
1820
1752
|
</details>
|
|
1821
1753
|
|
|
1822
|
-
<details><summary><code>client.empathicVoice.
|
|
1754
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
1823
1755
|
<dl>
|
|
1824
1756
|
<dd>
|
|
1825
1757
|
|
|
@@ -1831,9 +1763,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
1831
1763
|
<dl>
|
|
1832
1764
|
<dd>
|
|
1833
1765
|
|
|
1834
|
-
|
|
1766
|
+
Deletes a specified version of a **Prompt**.
|
|
1835
1767
|
|
|
1836
|
-
|
|
1768
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1837
1769
|
|
|
1838
1770
|
</dd>
|
|
1839
1771
|
</dl>
|
|
@@ -1849,9 +1781,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1849
1781
|
<dd>
|
|
1850
1782
|
|
|
1851
1783
|
```typescript
|
|
1852
|
-
await client.empathicVoice.
|
|
1853
|
-
name: "Updated Weather Assistant Config Name",
|
|
1854
|
-
});
|
|
1784
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
1855
1785
|
```
|
|
1856
1786
|
|
|
1857
1787
|
</dd>
|
|
@@ -1867,7 +1797,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1867
1797
|
<dl>
|
|
1868
1798
|
<dd>
|
|
1869
1799
|
|
|
1870
|
-
**id:** `string` — Identifier for a
|
|
1800
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1871
1801
|
|
|
1872
1802
|
</dd>
|
|
1873
1803
|
</dl>
|
|
@@ -1875,7 +1805,13 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1875
1805
|
<dl>
|
|
1876
1806
|
<dd>
|
|
1877
1807
|
|
|
1878
|
-
**
|
|
1808
|
+
**version:** `number`
|
|
1809
|
+
|
|
1810
|
+
Version number for a Prompt.
|
|
1811
|
+
|
|
1812
|
+
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.
|
|
1813
|
+
|
|
1814
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1879
1815
|
|
|
1880
1816
|
</dd>
|
|
1881
1817
|
</dl>
|
|
@@ -1883,7 +1819,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1883
1819
|
<dl>
|
|
1884
1820
|
<dd>
|
|
1885
1821
|
|
|
1886
|
-
**requestOptions:** `
|
|
1822
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1887
1823
|
|
|
1888
1824
|
</dd>
|
|
1889
1825
|
</dl>
|
|
@@ -1894,7 +1830,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1894
1830
|
</dl>
|
|
1895
1831
|
</details>
|
|
1896
1832
|
|
|
1897
|
-
<details><summary><code>client.empathicVoice.
|
|
1833
|
+
<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>
|
|
1898
1834
|
<dl>
|
|
1899
1835
|
<dd>
|
|
1900
1836
|
|
|
@@ -1906,9 +1842,9 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1906
1842
|
<dl>
|
|
1907
1843
|
<dd>
|
|
1908
1844
|
|
|
1909
|
-
|
|
1845
|
+
Updates the description of a **Prompt**.
|
|
1910
1846
|
|
|
1911
|
-
|
|
1847
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1912
1848
|
|
|
1913
1849
|
</dd>
|
|
1914
1850
|
</dl>
|
|
@@ -1924,7 +1860,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
1924
1860
|
<dd>
|
|
1925
1861
|
|
|
1926
1862
|
```typescript
|
|
1927
|
-
await client.empathicVoice.
|
|
1863
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1864
|
+
versionDescription: "This is an updated version_description.",
|
|
1865
|
+
});
|
|
1928
1866
|
```
|
|
1929
1867
|
|
|
1930
1868
|
</dd>
|
|
@@ -1940,7 +1878,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1940
1878
|
<dl>
|
|
1941
1879
|
<dd>
|
|
1942
1880
|
|
|
1943
|
-
**id:** `string` — Identifier for a
|
|
1881
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1944
1882
|
|
|
1945
1883
|
</dd>
|
|
1946
1884
|
</dl>
|
|
@@ -1950,11 +1888,11 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
1950
1888
|
|
|
1951
1889
|
**version:** `number`
|
|
1952
1890
|
|
|
1953
|
-
Version number for a
|
|
1891
|
+
Version number for a Prompt.
|
|
1954
1892
|
|
|
1955
|
-
|
|
1893
|
+
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.
|
|
1956
1894
|
|
|
1957
|
-
Version numbers are integer values representing different iterations of the
|
|
1895
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1958
1896
|
|
|
1959
1897
|
</dd>
|
|
1960
1898
|
</dl>
|
|
@@ -1962,7 +1900,15 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1962
1900
|
<dl>
|
|
1963
1901
|
<dd>
|
|
1964
1902
|
|
|
1965
|
-
**
|
|
1903
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1904
|
+
|
|
1905
|
+
</dd>
|
|
1906
|
+
</dl>
|
|
1907
|
+
|
|
1908
|
+
<dl>
|
|
1909
|
+
<dd>
|
|
1910
|
+
|
|
1911
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1966
1912
|
|
|
1967
1913
|
</dd>
|
|
1968
1914
|
</dl>
|
|
@@ -1973,7 +1919,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1973
1919
|
</dl>
|
|
1974
1920
|
</details>
|
|
1975
1921
|
|
|
1976
|
-
|
|
1922
|
+
## EmpathicVoice Configs
|
|
1923
|
+
|
|
1924
|
+
<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>
|
|
1977
1925
|
<dl>
|
|
1978
1926
|
<dd>
|
|
1979
1927
|
|
|
@@ -1985,7 +1933,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
1985
1933
|
<dl>
|
|
1986
1934
|
<dd>
|
|
1987
1935
|
|
|
1988
|
-
|
|
1936
|
+
Fetches a paginated list of **Configs**.
|
|
1989
1937
|
|
|
1990
1938
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1991
1939
|
|
|
@@ -2003,7 +1951,22 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2003
1951
|
<dd>
|
|
2004
1952
|
|
|
2005
1953
|
```typescript
|
|
2006
|
-
await client.empathicVoice.configs.
|
|
1954
|
+
const response = await client.empathicVoice.configs.listConfigs({
|
|
1955
|
+
pageNumber: 0,
|
|
1956
|
+
pageSize: 1,
|
|
1957
|
+
});
|
|
1958
|
+
for await (const item of response) {
|
|
1959
|
+
console.log(item);
|
|
1960
|
+
}
|
|
1961
|
+
|
|
1962
|
+
// Or you can manually iterate page-by-page
|
|
1963
|
+
const page = await client.empathicVoice.configs.listConfigs({
|
|
1964
|
+
pageNumber: 0,
|
|
1965
|
+
pageSize: 1,
|
|
1966
|
+
});
|
|
1967
|
+
while (page.hasNextPage()) {
|
|
1968
|
+
page = page.getNextPage();
|
|
1969
|
+
}
|
|
2007
1970
|
```
|
|
2008
1971
|
|
|
2009
1972
|
</dd>
|
|
@@ -2019,21 +1982,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2019
1982
|
<dl>
|
|
2020
1983
|
<dd>
|
|
2021
1984
|
|
|
2022
|
-
**
|
|
2023
|
-
|
|
2024
|
-
</dd>
|
|
2025
|
-
</dl>
|
|
2026
|
-
|
|
2027
|
-
<dl>
|
|
2028
|
-
<dd>
|
|
2029
|
-
|
|
2030
|
-
**version:** `number`
|
|
2031
|
-
|
|
2032
|
-
Version number for a Config.
|
|
2033
|
-
|
|
2034
|
-
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.
|
|
2035
|
-
|
|
2036
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1985
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
2037
1986
|
|
|
2038
1987
|
</dd>
|
|
2039
1988
|
</dl>
|
|
@@ -2052,7 +2001,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2052
2001
|
</dl>
|
|
2053
2002
|
</details>
|
|
2054
2003
|
|
|
2055
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2004
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2056
2005
|
<dl>
|
|
2057
2006
|
<dd>
|
|
2058
2007
|
|
|
@@ -2064,7 +2013,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2064
2013
|
<dl>
|
|
2065
2014
|
<dd>
|
|
2066
2015
|
|
|
2067
|
-
|
|
2016
|
+
Creates a **Config** which can be applied to EVI.
|
|
2068
2017
|
|
|
2069
2018
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2070
2019
|
|
|
@@ -2082,8 +2031,36 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2082
2031
|
<dd>
|
|
2083
2032
|
|
|
2084
2033
|
```typescript
|
|
2085
|
-
await client.empathicVoice.configs.
|
|
2086
|
-
|
|
2034
|
+
await client.empathicVoice.configs.createConfig({
|
|
2035
|
+
name: "Weather Assistant Config",
|
|
2036
|
+
prompt: {
|
|
2037
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2038
|
+
version: 0,
|
|
2039
|
+
},
|
|
2040
|
+
eviVersion: "3",
|
|
2041
|
+
voice: {
|
|
2042
|
+
provider: "HUME_AI",
|
|
2043
|
+
name: "Ava Song",
|
|
2044
|
+
},
|
|
2045
|
+
languageModel: {
|
|
2046
|
+
modelProvider: "ANTHROPIC",
|
|
2047
|
+
modelResource: "claude-3-7-sonnet-latest",
|
|
2048
|
+
temperature: 1,
|
|
2049
|
+
},
|
|
2050
|
+
eventMessages: {
|
|
2051
|
+
onNewChat: {
|
|
2052
|
+
enabled: false,
|
|
2053
|
+
text: "",
|
|
2054
|
+
},
|
|
2055
|
+
onInactivityTimeout: {
|
|
2056
|
+
enabled: false,
|
|
2057
|
+
text: "",
|
|
2058
|
+
},
|
|
2059
|
+
onMaxDurationTimeout: {
|
|
2060
|
+
enabled: false,
|
|
2061
|
+
text: "",
|
|
2062
|
+
},
|
|
2063
|
+
},
|
|
2087
2064
|
});
|
|
2088
2065
|
```
|
|
2089
2066
|
|
|
@@ -2100,29 +2077,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
2100
2077
|
<dl>
|
|
2101
2078
|
<dd>
|
|
2102
2079
|
|
|
2103
|
-
**
|
|
2104
|
-
|
|
2105
|
-
</dd>
|
|
2106
|
-
</dl>
|
|
2107
|
-
|
|
2108
|
-
<dl>
|
|
2109
|
-
<dd>
|
|
2110
|
-
|
|
2111
|
-
**version:** `number`
|
|
2112
|
-
|
|
2113
|
-
Version number for a Config.
|
|
2114
|
-
|
|
2115
|
-
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.
|
|
2116
|
-
|
|
2117
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2118
|
-
|
|
2119
|
-
</dd>
|
|
2120
|
-
</dl>
|
|
2121
|
-
|
|
2122
|
-
<dl>
|
|
2123
|
-
<dd>
|
|
2124
|
-
|
|
2125
|
-
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2080
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
2126
2081
|
|
|
2127
2082
|
</dd>
|
|
2128
2083
|
</dl>
|
|
@@ -2141,9 +2096,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2141
2096
|
</dl>
|
|
2142
2097
|
</details>
|
|
2143
2098
|
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
<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>
|
|
2099
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig></code></summary>
|
|
2147
2100
|
<dl>
|
|
2148
2101
|
<dd>
|
|
2149
2102
|
|
|
@@ -2155,7 +2108,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2155
2108
|
<dl>
|
|
2156
2109
|
<dd>
|
|
2157
2110
|
|
|
2158
|
-
Fetches a
|
|
2111
|
+
Fetches a list of a **Config's** versions.
|
|
2112
|
+
|
|
2113
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2159
2114
|
|
|
2160
2115
|
</dd>
|
|
2161
2116
|
</dl>
|
|
@@ -2171,21 +2126,13 @@ Fetches a paginated list of **Chats**.
|
|
|
2171
2126
|
<dd>
|
|
2172
2127
|
|
|
2173
2128
|
```typescript
|
|
2174
|
-
const response = await client.empathicVoice.
|
|
2175
|
-
pageNumber: 0,
|
|
2176
|
-
pageSize: 1,
|
|
2177
|
-
ascendingOrder: true,
|
|
2178
|
-
});
|
|
2129
|
+
const response = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2179
2130
|
for await (const item of response) {
|
|
2180
2131
|
console.log(item);
|
|
2181
2132
|
}
|
|
2182
2133
|
|
|
2183
2134
|
// Or you can manually iterate page-by-page
|
|
2184
|
-
const page = await client.empathicVoice.
|
|
2185
|
-
pageNumber: 0,
|
|
2186
|
-
pageSize: 1,
|
|
2187
|
-
ascendingOrder: true,
|
|
2188
|
-
});
|
|
2135
|
+
const page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2189
2136
|
while (page.hasNextPage()) {
|
|
2190
2137
|
page = page.getNextPage();
|
|
2191
2138
|
}
|
|
@@ -2204,7 +2151,7 @@ while (page.hasNextPage()) {
|
|
|
2204
2151
|
<dl>
|
|
2205
2152
|
<dd>
|
|
2206
2153
|
|
|
2207
|
-
**
|
|
2154
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2208
2155
|
|
|
2209
2156
|
</dd>
|
|
2210
2157
|
</dl>
|
|
@@ -2212,7 +2159,15 @@ while (page.hasNextPage()) {
|
|
|
2212
2159
|
<dl>
|
|
2213
2160
|
<dd>
|
|
2214
2161
|
|
|
2215
|
-
**
|
|
2162
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2163
|
+
|
|
2164
|
+
</dd>
|
|
2165
|
+
</dl>
|
|
2166
|
+
|
|
2167
|
+
<dl>
|
|
2168
|
+
<dd>
|
|
2169
|
+
|
|
2170
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2216
2171
|
|
|
2217
2172
|
</dd>
|
|
2218
2173
|
</dl>
|
|
@@ -2223,7 +2178,7 @@ while (page.hasNextPage()) {
|
|
|
2223
2178
|
</dl>
|
|
2224
2179
|
</details>
|
|
2225
2180
|
|
|
2226
|
-
<details><summary><code>client.empathicVoice.
|
|
2181
|
+
<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>
|
|
2227
2182
|
<dl>
|
|
2228
2183
|
<dd>
|
|
2229
2184
|
|
|
@@ -2235,7 +2190,9 @@ while (page.hasNextPage()) {
|
|
|
2235
2190
|
<dl>
|
|
2236
2191
|
<dd>
|
|
2237
2192
|
|
|
2238
|
-
|
|
2193
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
2194
|
+
|
|
2195
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2239
2196
|
|
|
2240
2197
|
</dd>
|
|
2241
2198
|
</dl>
|
|
@@ -2251,24 +2208,40 @@ Fetches a paginated list of **Chat** events.
|
|
|
2251
2208
|
<dd>
|
|
2252
2209
|
|
|
2253
2210
|
```typescript
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2211
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2212
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2213
|
+
eviVersion: "3",
|
|
2214
|
+
prompt: {
|
|
2215
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2216
|
+
version: 0,
|
|
2217
|
+
},
|
|
2218
|
+
voice: {
|
|
2219
|
+
provider: "HUME_AI",
|
|
2220
|
+
name: "Ava Song",
|
|
2221
|
+
},
|
|
2222
|
+
languageModel: {
|
|
2223
|
+
modelProvider: "ANTHROPIC",
|
|
2224
|
+
modelResource: "claude-3-7-sonnet-latest",
|
|
2225
|
+
temperature: 1,
|
|
2226
|
+
},
|
|
2227
|
+
ellmModel: {
|
|
2228
|
+
allowShortResponses: true,
|
|
2229
|
+
},
|
|
2230
|
+
eventMessages: {
|
|
2231
|
+
onNewChat: {
|
|
2232
|
+
enabled: false,
|
|
2233
|
+
text: "",
|
|
2234
|
+
},
|
|
2235
|
+
onInactivityTimeout: {
|
|
2236
|
+
enabled: false,
|
|
2237
|
+
text: "",
|
|
2238
|
+
},
|
|
2239
|
+
onMaxDurationTimeout: {
|
|
2240
|
+
enabled: false,
|
|
2241
|
+
text: "",
|
|
2242
|
+
},
|
|
2243
|
+
},
|
|
2268
2244
|
});
|
|
2269
|
-
while (page.hasNextPage()) {
|
|
2270
|
-
page = page.getNextPage();
|
|
2271
|
-
}
|
|
2272
2245
|
```
|
|
2273
2246
|
|
|
2274
2247
|
</dd>
|
|
@@ -2284,7 +2257,7 @@ while (page.hasNextPage()) {
|
|
|
2284
2257
|
<dl>
|
|
2285
2258
|
<dd>
|
|
2286
2259
|
|
|
2287
|
-
**id:** `string` — Identifier for a
|
|
2260
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2288
2261
|
|
|
2289
2262
|
</dd>
|
|
2290
2263
|
</dl>
|
|
@@ -2292,7 +2265,7 @@ while (page.hasNextPage()) {
|
|
|
2292
2265
|
<dl>
|
|
2293
2266
|
<dd>
|
|
2294
2267
|
|
|
2295
|
-
**request:** `Hume.empathicVoice.
|
|
2268
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2296
2269
|
|
|
2297
2270
|
</dd>
|
|
2298
2271
|
</dl>
|
|
@@ -2300,7 +2273,7 @@ while (page.hasNextPage()) {
|
|
|
2300
2273
|
<dl>
|
|
2301
2274
|
<dd>
|
|
2302
2275
|
|
|
2303
|
-
**requestOptions:** `
|
|
2276
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2304
2277
|
|
|
2305
2278
|
</dd>
|
|
2306
2279
|
</dl>
|
|
@@ -2311,7 +2284,7 @@ while (page.hasNextPage()) {
|
|
|
2311
2284
|
</dl>
|
|
2312
2285
|
</details>
|
|
2313
2286
|
|
|
2314
|
-
<details><summary><code>client.empathicVoice.
|
|
2287
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
2315
2288
|
<dl>
|
|
2316
2289
|
<dd>
|
|
2317
2290
|
|
|
@@ -2323,7 +2296,9 @@ while (page.hasNextPage()) {
|
|
|
2323
2296
|
<dl>
|
|
2324
2297
|
<dd>
|
|
2325
2298
|
|
|
2326
|
-
|
|
2299
|
+
Deletes a **Config** and its versions.
|
|
2300
|
+
|
|
2301
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2327
2302
|
|
|
2328
2303
|
</dd>
|
|
2329
2304
|
</dl>
|
|
@@ -2339,7 +2314,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
|
|
|
2339
2314
|
<dd>
|
|
2340
2315
|
|
|
2341
2316
|
```typescript
|
|
2342
|
-
await client.empathicVoice.
|
|
2317
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2343
2318
|
```
|
|
2344
2319
|
|
|
2345
2320
|
</dd>
|
|
@@ -2355,7 +2330,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2355
2330
|
<dl>
|
|
2356
2331
|
<dd>
|
|
2357
2332
|
|
|
2358
|
-
**id:** `string` — Identifier for a
|
|
2333
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2359
2334
|
|
|
2360
2335
|
</dd>
|
|
2361
2336
|
</dl>
|
|
@@ -2363,7 +2338,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2363
2338
|
<dl>
|
|
2364
2339
|
<dd>
|
|
2365
2340
|
|
|
2366
|
-
**requestOptions:** `
|
|
2341
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2367
2342
|
|
|
2368
2343
|
</dd>
|
|
2369
2344
|
</dl>
|
|
@@ -2374,9 +2349,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2374
2349
|
</dl>
|
|
2375
2350
|
</details>
|
|
2376
2351
|
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup></code></summary>
|
|
2352
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
2380
2353
|
<dl>
|
|
2381
2354
|
<dd>
|
|
2382
2355
|
|
|
@@ -2388,7 +2361,9 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2388
2361
|
<dl>
|
|
2389
2362
|
<dd>
|
|
2390
2363
|
|
|
2391
|
-
|
|
2364
|
+
Updates the name of a **Config**.
|
|
2365
|
+
|
|
2366
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2392
2367
|
|
|
2393
2368
|
</dd>
|
|
2394
2369
|
</dl>
|
|
@@ -2404,26 +2379,9 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
2404
2379
|
<dd>
|
|
2405
2380
|
|
|
2406
2381
|
```typescript
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
pageSize: 1,
|
|
2410
|
-
ascendingOrder: true,
|
|
2411
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2412
|
-
});
|
|
2413
|
-
for await (const item of response) {
|
|
2414
|
-
console.log(item);
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
|
-
// Or you can manually iterate page-by-page
|
|
2418
|
-
const page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
2419
|
-
pageNumber: 0,
|
|
2420
|
-
pageSize: 1,
|
|
2421
|
-
ascendingOrder: true,
|
|
2422
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2382
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2383
|
+
name: "Updated Weather Assistant Config Name",
|
|
2423
2384
|
});
|
|
2424
|
-
while (page.hasNextPage()) {
|
|
2425
|
-
page = page.getNextPage();
|
|
2426
|
-
}
|
|
2427
2385
|
```
|
|
2428
2386
|
|
|
2429
2387
|
</dd>
|
|
@@ -2439,7 +2397,7 @@ while (page.hasNextPage()) {
|
|
|
2439
2397
|
<dl>
|
|
2440
2398
|
<dd>
|
|
2441
2399
|
|
|
2442
|
-
**
|
|
2400
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2443
2401
|
|
|
2444
2402
|
</dd>
|
|
2445
2403
|
</dl>
|
|
@@ -2447,7 +2405,15 @@ while (page.hasNextPage()) {
|
|
|
2447
2405
|
<dl>
|
|
2448
2406
|
<dd>
|
|
2449
2407
|
|
|
2450
|
-
**
|
|
2408
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2409
|
+
|
|
2410
|
+
</dd>
|
|
2411
|
+
</dl>
|
|
2412
|
+
|
|
2413
|
+
<dl>
|
|
2414
|
+
<dd>
|
|
2415
|
+
|
|
2416
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2451
2417
|
|
|
2452
2418
|
</dd>
|
|
2453
2419
|
</dl>
|
|
@@ -2458,7 +2424,7 @@ while (page.hasNextPage()) {
|
|
|
2458
2424
|
</dl>
|
|
2459
2425
|
</details>
|
|
2460
2426
|
|
|
2461
|
-
<details><summary><code>client.empathicVoice.
|
|
2427
|
+
<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>
|
|
2462
2428
|
<dl>
|
|
2463
2429
|
<dd>
|
|
2464
2430
|
|
|
@@ -2470,7 +2436,9 @@ while (page.hasNextPage()) {
|
|
|
2470
2436
|
<dl>
|
|
2471
2437
|
<dd>
|
|
2472
2438
|
|
|
2473
|
-
Fetches a
|
|
2439
|
+
Fetches a specified version of a **Config**.
|
|
2440
|
+
|
|
2441
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2474
2442
|
|
|
2475
2443
|
</dd>
|
|
2476
2444
|
</dl>
|
|
@@ -2486,11 +2454,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
2486
2454
|
<dd>
|
|
2487
2455
|
|
|
2488
2456
|
```typescript
|
|
2489
|
-
await client.empathicVoice.
|
|
2490
|
-
pageNumber: 0,
|
|
2491
|
-
pageSize: 1,
|
|
2492
|
-
ascendingOrder: true,
|
|
2493
|
-
});
|
|
2457
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2494
2458
|
```
|
|
2495
2459
|
|
|
2496
2460
|
</dd>
|
|
@@ -2506,7 +2470,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2506
2470
|
<dl>
|
|
2507
2471
|
<dd>
|
|
2508
2472
|
|
|
2509
|
-
**id:** `string` — Identifier for a
|
|
2473
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2510
2474
|
|
|
2511
2475
|
</dd>
|
|
2512
2476
|
</dl>
|
|
@@ -2514,7 +2478,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2514
2478
|
<dl>
|
|
2515
2479
|
<dd>
|
|
2516
2480
|
|
|
2517
|
-
**
|
|
2481
|
+
**version:** `number`
|
|
2482
|
+
|
|
2483
|
+
Version number for a Config.
|
|
2484
|
+
|
|
2485
|
+
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.
|
|
2486
|
+
|
|
2487
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2518
2488
|
|
|
2519
2489
|
</dd>
|
|
2520
2490
|
</dl>
|
|
@@ -2522,7 +2492,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2522
2492
|
<dl>
|
|
2523
2493
|
<dd>
|
|
2524
2494
|
|
|
2525
|
-
**requestOptions:** `
|
|
2495
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2526
2496
|
|
|
2527
2497
|
</dd>
|
|
2528
2498
|
</dl>
|
|
@@ -2533,7 +2503,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2533
2503
|
</dl>
|
|
2534
2504
|
</details>
|
|
2535
2505
|
|
|
2536
|
-
<details><summary><code>client.empathicVoice.
|
|
2506
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
2537
2507
|
<dl>
|
|
2538
2508
|
<dd>
|
|
2539
2509
|
|
|
@@ -2545,7 +2515,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2545
2515
|
<dl>
|
|
2546
2516
|
<dd>
|
|
2547
2517
|
|
|
2548
|
-
|
|
2518
|
+
Deletes a specified version of a **Config**.
|
|
2519
|
+
|
|
2520
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2549
2521
|
|
|
2550
2522
|
</dd>
|
|
2551
2523
|
</dl>
|
|
@@ -2561,24 +2533,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
2561
2533
|
<dd>
|
|
2562
2534
|
|
|
2563
2535
|
```typescript
|
|
2564
|
-
|
|
2565
|
-
pageNumber: 0,
|
|
2566
|
-
pageSize: 3,
|
|
2567
|
-
ascendingOrder: true,
|
|
2568
|
-
});
|
|
2569
|
-
for await (const item of response) {
|
|
2570
|
-
console.log(item);
|
|
2571
|
-
}
|
|
2572
|
-
|
|
2573
|
-
// Or you can manually iterate page-by-page
|
|
2574
|
-
const page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
2575
|
-
pageNumber: 0,
|
|
2576
|
-
pageSize: 3,
|
|
2577
|
-
ascendingOrder: true,
|
|
2578
|
-
});
|
|
2579
|
-
while (page.hasNextPage()) {
|
|
2580
|
-
page = page.getNextPage();
|
|
2581
|
-
}
|
|
2536
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2582
2537
|
```
|
|
2583
2538
|
|
|
2584
2539
|
</dd>
|
|
@@ -2594,7 +2549,7 @@ while (page.hasNextPage()) {
|
|
|
2594
2549
|
<dl>
|
|
2595
2550
|
<dd>
|
|
2596
2551
|
|
|
2597
|
-
**id:** `string` — Identifier for a
|
|
2552
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2598
2553
|
|
|
2599
2554
|
</dd>
|
|
2600
2555
|
</dl>
|
|
@@ -2602,7 +2557,13 @@ while (page.hasNextPage()) {
|
|
|
2602
2557
|
<dl>
|
|
2603
2558
|
<dd>
|
|
2604
2559
|
|
|
2605
|
-
**
|
|
2560
|
+
**version:** `number`
|
|
2561
|
+
|
|
2562
|
+
Version number for a Config.
|
|
2563
|
+
|
|
2564
|
+
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.
|
|
2565
|
+
|
|
2566
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2606
2567
|
|
|
2607
2568
|
</dd>
|
|
2608
2569
|
</dl>
|
|
@@ -2610,7 +2571,7 @@ while (page.hasNextPage()) {
|
|
|
2610
2571
|
<dl>
|
|
2611
2572
|
<dd>
|
|
2612
2573
|
|
|
2613
|
-
**requestOptions:** `
|
|
2574
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2614
2575
|
|
|
2615
2576
|
</dd>
|
|
2616
2577
|
</dl>
|
|
@@ -2621,7 +2582,7 @@ while (page.hasNextPage()) {
|
|
|
2621
2582
|
</dl>
|
|
2622
2583
|
</details>
|
|
2623
2584
|
|
|
2624
|
-
<details><summary><code>client.empathicVoice.
|
|
2585
|
+
<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>
|
|
2625
2586
|
<dl>
|
|
2626
2587
|
<dd>
|
|
2627
2588
|
|
|
@@ -2633,7 +2594,9 @@ while (page.hasNextPage()) {
|
|
|
2633
2594
|
<dl>
|
|
2634
2595
|
<dd>
|
|
2635
2596
|
|
|
2636
|
-
|
|
2597
|
+
Updates the description of a **Config**.
|
|
2598
|
+
|
|
2599
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
2637
2600
|
|
|
2638
2601
|
</dd>
|
|
2639
2602
|
</dl>
|
|
@@ -2649,10 +2612,8 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
|
|
|
2649
2612
|
<dd>
|
|
2650
2613
|
|
|
2651
2614
|
```typescript
|
|
2652
|
-
await client.empathicVoice.
|
|
2653
|
-
|
|
2654
|
-
pageSize: 10,
|
|
2655
|
-
ascendingOrder: true,
|
|
2615
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
2616
|
+
versionDescription: "This is an updated version_description.",
|
|
2656
2617
|
});
|
|
2657
2618
|
```
|
|
2658
2619
|
|
|
@@ -2669,7 +2630,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2669
2630
|
<dl>
|
|
2670
2631
|
<dd>
|
|
2671
2632
|
|
|
2672
|
-
**id:** `string` — Identifier for a
|
|
2633
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2673
2634
|
|
|
2674
2635
|
</dd>
|
|
2675
2636
|
</dl>
|
|
@@ -2677,7 +2638,13 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2677
2638
|
<dl>
|
|
2678
2639
|
<dd>
|
|
2679
2640
|
|
|
2680
|
-
**
|
|
2641
|
+
**version:** `number`
|
|
2642
|
+
|
|
2643
|
+
Version number for a Config.
|
|
2644
|
+
|
|
2645
|
+
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.
|
|
2646
|
+
|
|
2647
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2681
2648
|
|
|
2682
2649
|
</dd>
|
|
2683
2650
|
</dl>
|
|
@@ -2685,7 +2652,15 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2685
2652
|
<dl>
|
|
2686
2653
|
<dd>
|
|
2687
2654
|
|
|
2688
|
-
**
|
|
2655
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2656
|
+
|
|
2657
|
+
</dd>
|
|
2658
|
+
</dl>
|
|
2659
|
+
|
|
2660
|
+
<dl>
|
|
2661
|
+
<dd>
|
|
2662
|
+
|
|
2663
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2689
2664
|
|
|
2690
2665
|
</dd>
|
|
2691
2666
|
</dl>
|
|
@@ -2696,9 +2671,9 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2696
2671
|
</dl>
|
|
2697
2672
|
</details>
|
|
2698
2673
|
|
|
2699
|
-
##
|
|
2674
|
+
## EmpathicVoice Chats
|
|
2700
2675
|
|
|
2701
|
-
<details><summary><code>client.
|
|
2676
|
+
<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>
|
|
2702
2677
|
<dl>
|
|
2703
2678
|
<dd>
|
|
2704
2679
|
|
|
@@ -2710,9 +2685,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2710
2685
|
<dl>
|
|
2711
2686
|
<dd>
|
|
2712
2687
|
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
The response includes the base64-encoded audio and metadata in JSON format.
|
|
2688
|
+
Fetches a paginated list of **Chats**.
|
|
2716
2689
|
|
|
2717
2690
|
</dd>
|
|
2718
2691
|
</dl>
|
|
@@ -2728,28 +2701,24 @@ The response includes the base64-encoded audio and metadata in JSON format.
|
|
|
2728
2701
|
<dd>
|
|
2729
2702
|
|
|
2730
2703
|
```typescript
|
|
2731
|
-
await client.
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
utterances: [
|
|
2746
|
-
{
|
|
2747
|
-
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
2748
|
-
description:
|
|
2749
|
-
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
|
|
2750
|
-
},
|
|
2751
|
-
],
|
|
2704
|
+
const response = await client.empathicVoice.chats.listChats({
|
|
2705
|
+
pageNumber: 0,
|
|
2706
|
+
pageSize: 1,
|
|
2707
|
+
ascendingOrder: true,
|
|
2708
|
+
});
|
|
2709
|
+
for await (const item of response) {
|
|
2710
|
+
console.log(item);
|
|
2711
|
+
}
|
|
2712
|
+
|
|
2713
|
+
// Or you can manually iterate page-by-page
|
|
2714
|
+
const page = await client.empathicVoice.chats.listChats({
|
|
2715
|
+
pageNumber: 0,
|
|
2716
|
+
pageSize: 1,
|
|
2717
|
+
ascendingOrder: true,
|
|
2752
2718
|
});
|
|
2719
|
+
while (page.hasNextPage()) {
|
|
2720
|
+
page = page.getNextPage();
|
|
2721
|
+
}
|
|
2753
2722
|
```
|
|
2754
2723
|
|
|
2755
2724
|
</dd>
|
|
@@ -2765,7 +2734,7 @@ await client.tts.synthesizeJson({
|
|
|
2765
2734
|
<dl>
|
|
2766
2735
|
<dd>
|
|
2767
2736
|
|
|
2768
|
-
**request:** `Hume.
|
|
2737
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
2769
2738
|
|
|
2770
2739
|
</dd>
|
|
2771
2740
|
</dl>
|
|
@@ -2773,7 +2742,7 @@ await client.tts.synthesizeJson({
|
|
|
2773
2742
|
<dl>
|
|
2774
2743
|
<dd>
|
|
2775
2744
|
|
|
2776
|
-
**requestOptions:** `
|
|
2745
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2777
2746
|
|
|
2778
2747
|
</dd>
|
|
2779
2748
|
</dl>
|
|
@@ -2784,7 +2753,7 @@ await client.tts.synthesizeJson({
|
|
|
2784
2753
|
</dl>
|
|
2785
2754
|
</details>
|
|
2786
2755
|
|
|
2787
|
-
<details><summary><code>client.
|
|
2756
|
+
<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>
|
|
2788
2757
|
<dl>
|
|
2789
2758
|
<dd>
|
|
2790
2759
|
|
|
@@ -2796,9 +2765,7 @@ await client.tts.synthesizeJson({
|
|
|
2796
2765
|
<dl>
|
|
2797
2766
|
<dd>
|
|
2798
2767
|
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
The response contains the generated audio file in the requested format.
|
|
2768
|
+
Fetches a paginated list of **Chat** events.
|
|
2802
2769
|
|
|
2803
2770
|
</dd>
|
|
2804
2771
|
</dl>
|
|
@@ -2814,22 +2781,24 @@ The response contains the generated audio file in the requested format.
|
|
|
2814
2781
|
<dd>
|
|
2815
2782
|
|
|
2816
2783
|
```typescript
|
|
2817
|
-
await client.
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
format: {
|
|
2822
|
-
type: "mp3",
|
|
2823
|
-
},
|
|
2824
|
-
numGenerations: 1,
|
|
2825
|
-
utterances: [
|
|
2826
|
-
{
|
|
2827
|
-
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
2828
|
-
description:
|
|
2829
|
-
"Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality.",
|
|
2830
|
-
},
|
|
2831
|
-
],
|
|
2784
|
+
const response = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2785
|
+
pageNumber: 0,
|
|
2786
|
+
pageSize: 3,
|
|
2787
|
+
ascendingOrder: true,
|
|
2832
2788
|
});
|
|
2789
|
+
for await (const item of response) {
|
|
2790
|
+
console.log(item);
|
|
2791
|
+
}
|
|
2792
|
+
|
|
2793
|
+
// Or you can manually iterate page-by-page
|
|
2794
|
+
const page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2795
|
+
pageNumber: 0,
|
|
2796
|
+
pageSize: 3,
|
|
2797
|
+
ascendingOrder: true,
|
|
2798
|
+
});
|
|
2799
|
+
while (page.hasNextPage()) {
|
|
2800
|
+
page = page.getNextPage();
|
|
2801
|
+
}
|
|
2833
2802
|
```
|
|
2834
2803
|
|
|
2835
2804
|
</dd>
|
|
@@ -2845,7 +2814,7 @@ await client.tts.synthesizeFile({
|
|
|
2845
2814
|
<dl>
|
|
2846
2815
|
<dd>
|
|
2847
2816
|
|
|
2848
|
-
**
|
|
2817
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
2849
2818
|
|
|
2850
2819
|
</dd>
|
|
2851
2820
|
</dl>
|
|
@@ -2853,7 +2822,15 @@ await client.tts.synthesizeFile({
|
|
|
2853
2822
|
<dl>
|
|
2854
2823
|
<dd>
|
|
2855
2824
|
|
|
2856
|
-
**
|
|
2825
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
2826
|
+
|
|
2827
|
+
</dd>
|
|
2828
|
+
</dl>
|
|
2829
|
+
|
|
2830
|
+
<dl>
|
|
2831
|
+
<dd>
|
|
2832
|
+
|
|
2833
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2857
2834
|
|
|
2858
2835
|
</dd>
|
|
2859
2836
|
</dl>
|
|
@@ -2864,7 +2841,7 @@ await client.tts.synthesizeFile({
|
|
|
2864
2841
|
</dl>
|
|
2865
2842
|
</details>
|
|
2866
2843
|
|
|
2867
|
-
<details><summary><code>client.
|
|
2844
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
|
|
2868
2845
|
<dl>
|
|
2869
2846
|
<dd>
|
|
2870
2847
|
|
|
@@ -2876,9 +2853,7 @@ await client.tts.synthesizeFile({
|
|
|
2876
2853
|
<dl>
|
|
2877
2854
|
<dd>
|
|
2878
2855
|
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
The response is a stream of JSON objects including audio encoded in base64.
|
|
2856
|
+
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).
|
|
2882
2857
|
|
|
2883
2858
|
</dd>
|
|
2884
2859
|
</dl>
|
|
@@ -2894,20 +2869,7 @@ The response is a stream of JSON objects including audio encoded in base64.
|
|
|
2894
2869
|
<dd>
|
|
2895
2870
|
|
|
2896
2871
|
```typescript
|
|
2897
|
-
|
|
2898
|
-
utterances: [
|
|
2899
|
-
{
|
|
2900
|
-
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
2901
|
-
voice: {
|
|
2902
|
-
name: "Male English Actor",
|
|
2903
|
-
provider: "HUME_AI",
|
|
2904
|
-
},
|
|
2905
|
-
},
|
|
2906
|
-
],
|
|
2907
|
-
});
|
|
2908
|
-
for await (const item of response) {
|
|
2909
|
-
console.log(item);
|
|
2910
|
-
}
|
|
2872
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
2911
2873
|
```
|
|
2912
2874
|
|
|
2913
2875
|
</dd>
|
|
@@ -2923,7 +2885,7 @@ for await (const item of response) {
|
|
|
2923
2885
|
<dl>
|
|
2924
2886
|
<dd>
|
|
2925
2887
|
|
|
2926
|
-
**
|
|
2888
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
2927
2889
|
|
|
2928
2890
|
</dd>
|
|
2929
2891
|
</dl>
|
|
@@ -2931,7 +2893,7 @@ for await (const item of response) {
|
|
|
2931
2893
|
<dl>
|
|
2932
2894
|
<dd>
|
|
2933
2895
|
|
|
2934
|
-
**requestOptions:** `
|
|
2896
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2935
2897
|
|
|
2936
2898
|
</dd>
|
|
2937
2899
|
</dl>
|
|
@@ -2942,7 +2904,9 @@ for await (const item of response) {
|
|
|
2942
2904
|
</dl>
|
|
2943
2905
|
</details>
|
|
2944
2906
|
|
|
2945
|
-
|
|
2907
|
+
## EmpathicVoice ChatGroups
|
|
2908
|
+
|
|
2909
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup></code></summary>
|
|
2946
2910
|
<dl>
|
|
2947
2911
|
<dd>
|
|
2948
2912
|
|
|
@@ -2954,7 +2918,7 @@ for await (const item of response) {
|
|
|
2954
2918
|
<dl>
|
|
2955
2919
|
<dd>
|
|
2956
2920
|
|
|
2957
|
-
|
|
2921
|
+
Fetches a paginated list of **Chat Groups**.
|
|
2958
2922
|
|
|
2959
2923
|
</dd>
|
|
2960
2924
|
</dl>
|
|
@@ -2970,17 +2934,26 @@ Streams synthesized speech using the specified voice. If no voice is provided, a
|
|
|
2970
2934
|
<dd>
|
|
2971
2935
|
|
|
2972
2936
|
```typescript
|
|
2973
|
-
await client.
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2937
|
+
const response = await client.empathicVoice.chatGroups.listChatGroups({
|
|
2938
|
+
pageNumber: 0,
|
|
2939
|
+
pageSize: 1,
|
|
2940
|
+
ascendingOrder: true,
|
|
2941
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2942
|
+
});
|
|
2943
|
+
for await (const item of response) {
|
|
2944
|
+
console.log(item);
|
|
2945
|
+
}
|
|
2946
|
+
|
|
2947
|
+
// Or you can manually iterate page-by-page
|
|
2948
|
+
const page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
2949
|
+
pageNumber: 0,
|
|
2950
|
+
pageSize: 1,
|
|
2951
|
+
ascendingOrder: true,
|
|
2952
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2983
2953
|
});
|
|
2954
|
+
while (page.hasNextPage()) {
|
|
2955
|
+
page = page.getNextPage();
|
|
2956
|
+
}
|
|
2984
2957
|
```
|
|
2985
2958
|
|
|
2986
2959
|
</dd>
|
|
@@ -2996,7 +2969,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
2996
2969
|
<dl>
|
|
2997
2970
|
<dd>
|
|
2998
2971
|
|
|
2999
|
-
**request:** `Hume.
|
|
2972
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
3000
2973
|
|
|
3001
2974
|
</dd>
|
|
3002
2975
|
</dl>
|
|
@@ -3004,7 +2977,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3004
2977
|
<dl>
|
|
3005
2978
|
<dd>
|
|
3006
2979
|
|
|
3007
|
-
**requestOptions:** `
|
|
2980
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3008
2981
|
|
|
3009
2982
|
</dd>
|
|
3010
2983
|
</dl>
|
|
@@ -3015,9 +2988,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3015
2988
|
</dl>
|
|
3016
2989
|
</details>
|
|
3017
2990
|
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice></code></summary>
|
|
2991
|
+
<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>
|
|
3021
2992
|
<dl>
|
|
3022
2993
|
<dd>
|
|
3023
2994
|
|
|
@@ -3029,7 +3000,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3029
3000
|
<dl>
|
|
3030
3001
|
<dd>
|
|
3031
3002
|
|
|
3032
|
-
|
|
3003
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
3033
3004
|
|
|
3034
3005
|
</dd>
|
|
3035
3006
|
</dl>
|
|
@@ -3045,20 +3016,11 @@ Lists voices you have saved in your account, or voices from the [Voice Library](
|
|
|
3045
3016
|
<dd>
|
|
3046
3017
|
|
|
3047
3018
|
```typescript
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
console.log(item);
|
|
3053
|
-
}
|
|
3054
|
-
|
|
3055
|
-
// Or you can manually iterate page-by-page
|
|
3056
|
-
const page = await client.tts.voices.list({
|
|
3057
|
-
provider: "CUSTOM_VOICE",
|
|
3019
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3020
|
+
pageNumber: 0,
|
|
3021
|
+
pageSize: 1,
|
|
3022
|
+
ascendingOrder: true,
|
|
3058
3023
|
});
|
|
3059
|
-
while (page.hasNextPage()) {
|
|
3060
|
-
page = page.getNextPage();
|
|
3061
|
-
}
|
|
3062
3024
|
```
|
|
3063
3025
|
|
|
3064
3026
|
</dd>
|
|
@@ -3074,7 +3036,7 @@ while (page.hasNextPage()) {
|
|
|
3074
3036
|
<dl>
|
|
3075
3037
|
<dd>
|
|
3076
3038
|
|
|
3077
|
-
**
|
|
3039
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3078
3040
|
|
|
3079
3041
|
</dd>
|
|
3080
3042
|
</dl>
|
|
@@ -3082,7 +3044,15 @@ while (page.hasNextPage()) {
|
|
|
3082
3044
|
<dl>
|
|
3083
3045
|
<dd>
|
|
3084
3046
|
|
|
3085
|
-
**
|
|
3047
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3048
|
+
|
|
3049
|
+
</dd>
|
|
3050
|
+
</dl>
|
|
3051
|
+
|
|
3052
|
+
<dl>
|
|
3053
|
+
<dd>
|
|
3054
|
+
|
|
3055
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3086
3056
|
|
|
3087
3057
|
</dd>
|
|
3088
3058
|
</dl>
|
|
@@ -3093,7 +3063,7 @@ while (page.hasNextPage()) {
|
|
|
3093
3063
|
</dl>
|
|
3094
3064
|
</details>
|
|
3095
3065
|
|
|
3096
|
-
<details><summary><code>client.
|
|
3066
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent></code></summary>
|
|
3097
3067
|
<dl>
|
|
3098
3068
|
<dd>
|
|
3099
3069
|
|
|
@@ -3105,9 +3075,7 @@ while (page.hasNextPage()) {
|
|
|
3105
3075
|
<dl>
|
|
3106
3076
|
<dd>
|
|
3107
3077
|
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
|
|
3078
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
3111
3079
|
|
|
3112
3080
|
</dd>
|
|
3113
3081
|
</dl>
|
|
@@ -3123,10 +3091,24 @@ Once saved, this voice can be reused in subsequent TTS requests, ensuring consis
|
|
|
3123
3091
|
<dd>
|
|
3124
3092
|
|
|
3125
3093
|
```typescript
|
|
3126
|
-
await client.
|
|
3127
|
-
|
|
3128
|
-
|
|
3094
|
+
const response = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3095
|
+
pageNumber: 0,
|
|
3096
|
+
pageSize: 3,
|
|
3097
|
+
ascendingOrder: true,
|
|
3098
|
+
});
|
|
3099
|
+
for await (const item of response) {
|
|
3100
|
+
console.log(item);
|
|
3101
|
+
}
|
|
3102
|
+
|
|
3103
|
+
// Or you can manually iterate page-by-page
|
|
3104
|
+
const page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3105
|
+
pageNumber: 0,
|
|
3106
|
+
pageSize: 3,
|
|
3107
|
+
ascendingOrder: true,
|
|
3129
3108
|
});
|
|
3109
|
+
while (page.hasNextPage()) {
|
|
3110
|
+
page = page.getNextPage();
|
|
3111
|
+
}
|
|
3130
3112
|
```
|
|
3131
3113
|
|
|
3132
3114
|
</dd>
|
|
@@ -3142,7 +3124,7 @@ await client.tts.voices.create({
|
|
|
3142
3124
|
<dl>
|
|
3143
3125
|
<dd>
|
|
3144
3126
|
|
|
3145
|
-
**
|
|
3127
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3146
3128
|
|
|
3147
3129
|
</dd>
|
|
3148
3130
|
</dl>
|
|
@@ -3150,7 +3132,15 @@ await client.tts.voices.create({
|
|
|
3150
3132
|
<dl>
|
|
3151
3133
|
<dd>
|
|
3152
3134
|
|
|
3153
|
-
**
|
|
3135
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3136
|
+
|
|
3137
|
+
</dd>
|
|
3138
|
+
</dl>
|
|
3139
|
+
|
|
3140
|
+
<dl>
|
|
3141
|
+
<dd>
|
|
3142
|
+
|
|
3143
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3154
3144
|
|
|
3155
3145
|
</dd>
|
|
3156
3146
|
</dl>
|
|
@@ -3161,7 +3151,7 @@ await client.tts.voices.create({
|
|
|
3161
3151
|
</dl>
|
|
3162
3152
|
</details>
|
|
3163
3153
|
|
|
3164
|
-
<details><summary><code>client.
|
|
3154
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
|
|
3165
3155
|
<dl>
|
|
3166
3156
|
<dd>
|
|
3167
3157
|
|
|
@@ -3173,7 +3163,7 @@ await client.tts.voices.create({
|
|
|
3173
3163
|
<dl>
|
|
3174
3164
|
<dd>
|
|
3175
3165
|
|
|
3176
|
-
|
|
3166
|
+
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).
|
|
3177
3167
|
|
|
3178
3168
|
</dd>
|
|
3179
3169
|
</dl>
|
|
@@ -3189,8 +3179,10 @@ Deletes a previously generated custom voice.
|
|
|
3189
3179
|
<dd>
|
|
3190
3180
|
|
|
3191
3181
|
```typescript
|
|
3192
|
-
await client.
|
|
3193
|
-
|
|
3182
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
3183
|
+
pageNumber: 0,
|
|
3184
|
+
pageSize: 10,
|
|
3185
|
+
ascendingOrder: true,
|
|
3194
3186
|
});
|
|
3195
3187
|
```
|
|
3196
3188
|
|
|
@@ -3207,7 +3199,7 @@ await client.tts.voices.delete({
|
|
|
3207
3199
|
<dl>
|
|
3208
3200
|
<dd>
|
|
3209
3201
|
|
|
3210
|
-
**
|
|
3202
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3211
3203
|
|
|
3212
3204
|
</dd>
|
|
3213
3205
|
</dl>
|
|
@@ -3215,7 +3207,15 @@ await client.tts.voices.delete({
|
|
|
3215
3207
|
<dl>
|
|
3216
3208
|
<dd>
|
|
3217
3209
|
|
|
3218
|
-
**
|
|
3210
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
3211
|
+
|
|
3212
|
+
</dd>
|
|
3213
|
+
</dl>
|
|
3214
|
+
|
|
3215
|
+
<dl>
|
|
3216
|
+
<dd>
|
|
3217
|
+
|
|
3218
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3219
3219
|
|
|
3220
3220
|
</dd>
|
|
3221
3221
|
</dl>
|