hume 0.13.5 → 0.13.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/api.yml +12 -0
- package/.mock/definition/empathic-voice/__package__.yml +2988 -0
- package/.mock/definition/empathic-voice/chat.yml +175 -0
- package/.mock/definition/empathic-voice/chatGroups.yml +627 -0
- package/.mock/definition/empathic-voice/chatWebhooks.yml +30 -0
- package/.mock/definition/empathic-voice/chats.yml +506 -0
- package/.mock/definition/empathic-voice/configs.yml +842 -0
- package/.mock/definition/empathic-voice/prompts.yml +558 -0
- package/.mock/definition/empathic-voice/tools.yml +626 -0
- package/.mock/definition/expression-measurement/__package__.yml +1 -0
- package/.mock/definition/expression-measurement/batch/__package__.yml +1803 -0
- package/.mock/definition/expression-measurement/stream/__package__.yml +113 -0
- package/.mock/definition/expression-measurement/stream/stream.yml +438 -0
- package/.mock/definition/tts/__package__.yml +718 -0
- package/.mock/definition/tts/streamInput.yml +84 -0
- package/.mock/definition/tts/voices.yml +143 -0
- package/.mock/fern.config.json +4 -0
- package/Client.js +10 -3
- 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/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/Client.js +10 -3
- 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/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/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/package.json +1 -1
- package/reference.md +701 -701
- 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/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
|
@@ -0,0 +1,842 @@
|
|
|
1
|
+
imports:
|
|
2
|
+
root: __package__.yml
|
|
3
|
+
service:
|
|
4
|
+
auth: false
|
|
5
|
+
base-path: ''
|
|
6
|
+
endpoints:
|
|
7
|
+
list-configs:
|
|
8
|
+
path: /v0/evi/configs
|
|
9
|
+
method: GET
|
|
10
|
+
auth: true
|
|
11
|
+
docs: >-
|
|
12
|
+
Fetches a paginated list of **Configs**.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
For more details on configuration options and how to configure EVI, see
|
|
16
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
17
|
+
pagination:
|
|
18
|
+
offset: $request.page_number
|
|
19
|
+
results: $response.configs_page
|
|
20
|
+
source:
|
|
21
|
+
openapi: evi-openapi.json
|
|
22
|
+
display-name: List configs
|
|
23
|
+
request:
|
|
24
|
+
name: ConfigsListConfigsRequest
|
|
25
|
+
query-parameters:
|
|
26
|
+
page_number:
|
|
27
|
+
type: optional<integer>
|
|
28
|
+
default: 0
|
|
29
|
+
docs: >-
|
|
30
|
+
Specifies the page number to retrieve, enabling pagination.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
This parameter uses zero-based indexing. For example, setting
|
|
34
|
+
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
35
|
+
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
36
|
+
second page (items 10-19), and so on. Defaults to 0, which
|
|
37
|
+
retrieves the first page.
|
|
38
|
+
page_size:
|
|
39
|
+
type: optional<integer>
|
|
40
|
+
docs: >-
|
|
41
|
+
Specifies the maximum number of results to include per page,
|
|
42
|
+
enabling pagination. The value must be between 1 and 100,
|
|
43
|
+
inclusive.
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
For example, if `page_size` is set to 10, each page will include
|
|
47
|
+
up to 10 items. Defaults to 10.
|
|
48
|
+
restrict_to_most_recent:
|
|
49
|
+
type: optional<boolean>
|
|
50
|
+
docs: >-
|
|
51
|
+
By default, `restrict_to_most_recent` is set to true, returning
|
|
52
|
+
only the latest version of each tool. To include all versions of
|
|
53
|
+
each tool in the list, set `restrict_to_most_recent` to false.
|
|
54
|
+
name:
|
|
55
|
+
type: optional<string>
|
|
56
|
+
docs: Filter to only include configs with this name.
|
|
57
|
+
response:
|
|
58
|
+
docs: Success
|
|
59
|
+
type: root.ReturnPagedConfigs
|
|
60
|
+
status-code: 200
|
|
61
|
+
errors:
|
|
62
|
+
- root.BadRequestError
|
|
63
|
+
examples:
|
|
64
|
+
- query-parameters:
|
|
65
|
+
page_number: 0
|
|
66
|
+
page_size: 1
|
|
67
|
+
response:
|
|
68
|
+
body:
|
|
69
|
+
page_number: 0
|
|
70
|
+
page_size: 1
|
|
71
|
+
total_pages: 1
|
|
72
|
+
configs_page:
|
|
73
|
+
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
74
|
+
version: 0
|
|
75
|
+
version_description: ''
|
|
76
|
+
name: Weather Assistant Config
|
|
77
|
+
created_on: 1715267200693
|
|
78
|
+
modified_on: 1715267200693
|
|
79
|
+
evi_version: '3'
|
|
80
|
+
prompt:
|
|
81
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
82
|
+
version: 0
|
|
83
|
+
version_type: FIXED
|
|
84
|
+
version_description: ''
|
|
85
|
+
name: Weather Assistant Prompt
|
|
86
|
+
created_on: 1715267200693
|
|
87
|
+
modified_on: 1715267200693
|
|
88
|
+
text: >-
|
|
89
|
+
<role>You are an AI weather assistant providing users with
|
|
90
|
+
accurate and up-to-date weather information. Respond to
|
|
91
|
+
user queries concisely and clearly. Use simple language
|
|
92
|
+
and avoid technical jargon. Provide temperature,
|
|
93
|
+
precipitation, wind conditions, and any weather alerts.
|
|
94
|
+
Include helpful tips if severe weather is expected.</role>
|
|
95
|
+
voice:
|
|
96
|
+
provider: HUME_AI
|
|
97
|
+
name: Ava Song
|
|
98
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
99
|
+
language_model:
|
|
100
|
+
model_provider: ANTHROPIC
|
|
101
|
+
model_resource: claude-3-7-sonnet-latest
|
|
102
|
+
temperature: 1
|
|
103
|
+
ellm_model:
|
|
104
|
+
allow_short_responses: false
|
|
105
|
+
tools: []
|
|
106
|
+
builtin_tools: []
|
|
107
|
+
event_messages:
|
|
108
|
+
on_new_chat:
|
|
109
|
+
enabled: false
|
|
110
|
+
text: ''
|
|
111
|
+
on_inactivity_timeout:
|
|
112
|
+
enabled: false
|
|
113
|
+
text: ''
|
|
114
|
+
on_max_duration_timeout:
|
|
115
|
+
enabled: false
|
|
116
|
+
text: ''
|
|
117
|
+
timeouts:
|
|
118
|
+
inactivity:
|
|
119
|
+
enabled: true
|
|
120
|
+
duration_secs: 600
|
|
121
|
+
max_duration:
|
|
122
|
+
enabled: true
|
|
123
|
+
duration_secs: 1800
|
|
124
|
+
create-config:
|
|
125
|
+
path: /v0/evi/configs
|
|
126
|
+
method: POST
|
|
127
|
+
auth: true
|
|
128
|
+
docs: >-
|
|
129
|
+
Creates a **Config** which can be applied to EVI.
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
For more details on configuration options and how to configure EVI, see
|
|
133
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
134
|
+
source:
|
|
135
|
+
openapi: evi-openapi.json
|
|
136
|
+
display-name: Create config
|
|
137
|
+
request:
|
|
138
|
+
name: PostedConfig
|
|
139
|
+
body:
|
|
140
|
+
properties:
|
|
141
|
+
evi_version:
|
|
142
|
+
type: string
|
|
143
|
+
docs: EVI version to use. Only version `3` is supported.
|
|
144
|
+
name:
|
|
145
|
+
type: string
|
|
146
|
+
docs: Name applied to all versions of a particular Config.
|
|
147
|
+
version_description:
|
|
148
|
+
type: optional<string>
|
|
149
|
+
docs: An optional description of the Config version.
|
|
150
|
+
prompt: optional<root.PostedConfigPromptSpec>
|
|
151
|
+
voice:
|
|
152
|
+
type: optional<root.VoiceRef>
|
|
153
|
+
docs: A voice specification associated with this Config.
|
|
154
|
+
language_model:
|
|
155
|
+
type: optional<root.PostedLanguageModel>
|
|
156
|
+
docs: >-
|
|
157
|
+
The supplemental language model associated with this Config.
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
This model is used to generate longer, more detailed responses
|
|
161
|
+
from EVI. Choosing an appropriate supplemental language model
|
|
162
|
+
for your use case is crucial for generating fast, high-quality
|
|
163
|
+
responses from EVI.
|
|
164
|
+
ellm_model:
|
|
165
|
+
type: optional<root.PostedEllmModel>
|
|
166
|
+
docs: >-
|
|
167
|
+
The eLLM setup associated with this Config.
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
Hume's eLLM (empathic Large Language Model) is a multimodal
|
|
171
|
+
language model that takes into account both expression measures
|
|
172
|
+
and language. The eLLM generates short, empathic language
|
|
173
|
+
responses and guides text-to-speech (TTS) prosody.
|
|
174
|
+
tools:
|
|
175
|
+
type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
|
|
176
|
+
docs: List of user-defined tools associated with this Config.
|
|
177
|
+
builtin_tools:
|
|
178
|
+
type: optional<list<optional<root.PostedBuiltinTool>>>
|
|
179
|
+
docs: List of built-in tools associated with this Config.
|
|
180
|
+
event_messages: optional<root.PostedEventMessageSpecs>
|
|
181
|
+
nudges:
|
|
182
|
+
type: optional<root.PostedNudgeSpec>
|
|
183
|
+
docs: >-
|
|
184
|
+
Configures nudges, brief audio prompts that can guide
|
|
185
|
+
conversations when users pause or need encouragement to continue
|
|
186
|
+
speaking. Nudges help create more natural, flowing interactions
|
|
187
|
+
by providing gentle conversational cues.
|
|
188
|
+
timeouts: optional<root.PostedTimeoutSpecs>
|
|
189
|
+
webhooks:
|
|
190
|
+
type: optional<list<optional<root.PostedWebhookSpec>>>
|
|
191
|
+
docs: Webhook config specifications for each subscriber.
|
|
192
|
+
content-type: application/json
|
|
193
|
+
response:
|
|
194
|
+
docs: Created
|
|
195
|
+
type: root.ReturnConfig
|
|
196
|
+
status-code: 201
|
|
197
|
+
errors:
|
|
198
|
+
- root.BadRequestError
|
|
199
|
+
examples:
|
|
200
|
+
- request:
|
|
201
|
+
name: Weather Assistant Config
|
|
202
|
+
prompt:
|
|
203
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
204
|
+
version: 0
|
|
205
|
+
evi_version: '3'
|
|
206
|
+
voice:
|
|
207
|
+
provider: HUME_AI
|
|
208
|
+
name: Ava Song
|
|
209
|
+
language_model:
|
|
210
|
+
model_provider: ANTHROPIC
|
|
211
|
+
model_resource: claude-3-7-sonnet-latest
|
|
212
|
+
temperature: 1
|
|
213
|
+
event_messages:
|
|
214
|
+
on_new_chat:
|
|
215
|
+
enabled: false
|
|
216
|
+
text: ''
|
|
217
|
+
on_inactivity_timeout:
|
|
218
|
+
enabled: false
|
|
219
|
+
text: ''
|
|
220
|
+
on_max_duration_timeout:
|
|
221
|
+
enabled: false
|
|
222
|
+
text: ''
|
|
223
|
+
response:
|
|
224
|
+
body:
|
|
225
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
226
|
+
version: 0
|
|
227
|
+
version_description: ''
|
|
228
|
+
name: Weather Assistant Config
|
|
229
|
+
created_on: 1715275452390
|
|
230
|
+
modified_on: 1715275452390
|
|
231
|
+
evi_version: '3'
|
|
232
|
+
prompt:
|
|
233
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
234
|
+
version: 0
|
|
235
|
+
version_type: FIXED
|
|
236
|
+
version_description: ''
|
|
237
|
+
name: Weather Assistant Prompt
|
|
238
|
+
created_on: 1715267200693
|
|
239
|
+
modified_on: 1715267200693
|
|
240
|
+
text: >-
|
|
241
|
+
<role>You are an AI weather assistant providing users with
|
|
242
|
+
accurate and up-to-date weather information. Respond to user
|
|
243
|
+
queries concisely and clearly. Use simple language and avoid
|
|
244
|
+
technical jargon. Provide temperature, precipitation, wind
|
|
245
|
+
conditions, and any weather alerts. Include helpful tips if
|
|
246
|
+
severe weather is expected.</role>
|
|
247
|
+
voice:
|
|
248
|
+
provider: HUME_AI
|
|
249
|
+
name: Ava Song
|
|
250
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
251
|
+
language_model:
|
|
252
|
+
model_provider: ANTHROPIC
|
|
253
|
+
model_resource: claude-3-7-sonnet-latest
|
|
254
|
+
temperature: 1
|
|
255
|
+
ellm_model:
|
|
256
|
+
allow_short_responses: false
|
|
257
|
+
tools: []
|
|
258
|
+
builtin_tools: []
|
|
259
|
+
event_messages:
|
|
260
|
+
on_new_chat:
|
|
261
|
+
enabled: false
|
|
262
|
+
text: ''
|
|
263
|
+
on_inactivity_timeout:
|
|
264
|
+
enabled: false
|
|
265
|
+
text: ''
|
|
266
|
+
on_max_duration_timeout:
|
|
267
|
+
enabled: false
|
|
268
|
+
text: ''
|
|
269
|
+
timeouts:
|
|
270
|
+
inactivity:
|
|
271
|
+
enabled: true
|
|
272
|
+
duration_secs: 600
|
|
273
|
+
max_duration:
|
|
274
|
+
enabled: true
|
|
275
|
+
duration_secs: 1800
|
|
276
|
+
list-config-versions:
|
|
277
|
+
path: /v0/evi/configs/{id}
|
|
278
|
+
method: GET
|
|
279
|
+
auth: true
|
|
280
|
+
docs: >-
|
|
281
|
+
Fetches a list of a **Config's** versions.
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
For more details on configuration options and how to configure EVI, see
|
|
285
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
286
|
+
pagination:
|
|
287
|
+
offset: $request.page_number
|
|
288
|
+
results: $response.configs_page
|
|
289
|
+
source:
|
|
290
|
+
openapi: evi-openapi.json
|
|
291
|
+
path-parameters:
|
|
292
|
+
id:
|
|
293
|
+
type: string
|
|
294
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
295
|
+
display-name: List config versions
|
|
296
|
+
request:
|
|
297
|
+
name: ConfigsListConfigVersionsRequest
|
|
298
|
+
query-parameters:
|
|
299
|
+
page_number:
|
|
300
|
+
type: optional<integer>
|
|
301
|
+
default: 0
|
|
302
|
+
docs: >-
|
|
303
|
+
Specifies the page number to retrieve, enabling pagination.
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
This parameter uses zero-based indexing. For example, setting
|
|
307
|
+
`page_number` to 0 retrieves the first page of results (items 0-9
|
|
308
|
+
if `page_size` is 10), setting `page_number` to 1 retrieves the
|
|
309
|
+
second page (items 10-19), and so on. Defaults to 0, which
|
|
310
|
+
retrieves the first page.
|
|
311
|
+
page_size:
|
|
312
|
+
type: optional<integer>
|
|
313
|
+
docs: >-
|
|
314
|
+
Specifies the maximum number of results to include per page,
|
|
315
|
+
enabling pagination. The value must be between 1 and 100,
|
|
316
|
+
inclusive.
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
For example, if `page_size` is set to 10, each page will include
|
|
320
|
+
up to 10 items. Defaults to 10.
|
|
321
|
+
restrict_to_most_recent:
|
|
322
|
+
type: optional<boolean>
|
|
323
|
+
docs: >-
|
|
324
|
+
By default, `restrict_to_most_recent` is set to true, returning
|
|
325
|
+
only the latest version of each config. To include all versions of
|
|
326
|
+
each config in the list, set `restrict_to_most_recent` to false.
|
|
327
|
+
response:
|
|
328
|
+
docs: Success
|
|
329
|
+
type: root.ReturnPagedConfigs
|
|
330
|
+
status-code: 200
|
|
331
|
+
errors:
|
|
332
|
+
- root.BadRequestError
|
|
333
|
+
examples:
|
|
334
|
+
- path-parameters:
|
|
335
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
336
|
+
response:
|
|
337
|
+
body:
|
|
338
|
+
page_number: 0
|
|
339
|
+
page_size: 10
|
|
340
|
+
total_pages: 1
|
|
341
|
+
configs_page:
|
|
342
|
+
- id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
343
|
+
version: 0
|
|
344
|
+
version_description: ''
|
|
345
|
+
name: Weather Assistant Config
|
|
346
|
+
created_on: 1715275452390
|
|
347
|
+
modified_on: 1715275452390
|
|
348
|
+
evi_version: '3'
|
|
349
|
+
prompt:
|
|
350
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
351
|
+
version: 0
|
|
352
|
+
version_type: FIXED
|
|
353
|
+
version_description: ''
|
|
354
|
+
name: Weather Assistant Prompt
|
|
355
|
+
created_on: 1715267200693
|
|
356
|
+
modified_on: 1715267200693
|
|
357
|
+
text: >-
|
|
358
|
+
<role>You are an AI weather assistant providing users with
|
|
359
|
+
accurate and up-to-date weather information. Respond to
|
|
360
|
+
user queries concisely and clearly. Use simple language
|
|
361
|
+
and avoid technical jargon. Provide temperature,
|
|
362
|
+
precipitation, wind conditions, and any weather alerts.
|
|
363
|
+
Include helpful tips if severe weather is expected.</role>
|
|
364
|
+
voice:
|
|
365
|
+
provider: HUME_AI
|
|
366
|
+
name: Ava Song
|
|
367
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
368
|
+
language_model:
|
|
369
|
+
model_provider: ANTHROPIC
|
|
370
|
+
model_resource: claude-3-7-sonnet-latest
|
|
371
|
+
temperature: 1
|
|
372
|
+
ellm_model:
|
|
373
|
+
allow_short_responses: false
|
|
374
|
+
tools: []
|
|
375
|
+
builtin_tools: []
|
|
376
|
+
event_messages:
|
|
377
|
+
on_new_chat:
|
|
378
|
+
enabled: false
|
|
379
|
+
text: ''
|
|
380
|
+
on_inactivity_timeout:
|
|
381
|
+
enabled: false
|
|
382
|
+
text: ''
|
|
383
|
+
on_max_duration_timeout:
|
|
384
|
+
enabled: false
|
|
385
|
+
text: ''
|
|
386
|
+
timeouts:
|
|
387
|
+
inactivity:
|
|
388
|
+
enabled: true
|
|
389
|
+
duration_secs: 600
|
|
390
|
+
max_duration:
|
|
391
|
+
enabled: true
|
|
392
|
+
duration_secs: 1800
|
|
393
|
+
create-config-version:
|
|
394
|
+
path: /v0/evi/configs/{id}
|
|
395
|
+
method: POST
|
|
396
|
+
auth: true
|
|
397
|
+
docs: >-
|
|
398
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
For more details on configuration options and how to configure EVI, see
|
|
402
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
403
|
+
source:
|
|
404
|
+
openapi: evi-openapi.json
|
|
405
|
+
path-parameters:
|
|
406
|
+
id:
|
|
407
|
+
type: string
|
|
408
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
409
|
+
display-name: Create config version
|
|
410
|
+
request:
|
|
411
|
+
name: PostedConfigVersion
|
|
412
|
+
body:
|
|
413
|
+
properties:
|
|
414
|
+
evi_version:
|
|
415
|
+
type: string
|
|
416
|
+
docs: The version of the EVI used with this config.
|
|
417
|
+
version_description:
|
|
418
|
+
type: optional<string>
|
|
419
|
+
docs: An optional description of the Config version.
|
|
420
|
+
prompt: optional<root.PostedConfigPromptSpec>
|
|
421
|
+
voice:
|
|
422
|
+
type: optional<root.VoiceRef>
|
|
423
|
+
docs: A voice specification associated with this Config version.
|
|
424
|
+
language_model:
|
|
425
|
+
type: optional<root.PostedLanguageModel>
|
|
426
|
+
docs: >-
|
|
427
|
+
The supplemental language model associated with this Config
|
|
428
|
+
version.
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
This model is used to generate longer, more detailed responses
|
|
432
|
+
from EVI. Choosing an appropriate supplemental language model
|
|
433
|
+
for your use case is crucial for generating fast, high-quality
|
|
434
|
+
responses from EVI.
|
|
435
|
+
ellm_model:
|
|
436
|
+
type: optional<root.PostedEllmModel>
|
|
437
|
+
docs: >-
|
|
438
|
+
The eLLM setup associated with this Config version.
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
Hume's eLLM (empathic Large Language Model) is a multimodal
|
|
442
|
+
language model that takes into account both expression measures
|
|
443
|
+
and language. The eLLM generates short, empathic language
|
|
444
|
+
responses and guides text-to-speech (TTS) prosody.
|
|
445
|
+
tools:
|
|
446
|
+
type: optional<list<optional<root.PostedUserDefinedToolSpec>>>
|
|
447
|
+
docs: List of user-defined tools associated with this Config version.
|
|
448
|
+
builtin_tools:
|
|
449
|
+
type: optional<list<optional<root.PostedBuiltinTool>>>
|
|
450
|
+
docs: List of built-in tools associated with this Config version.
|
|
451
|
+
event_messages: optional<root.PostedEventMessageSpecs>
|
|
452
|
+
timeouts: optional<root.PostedTimeoutSpecs>
|
|
453
|
+
nudges: optional<root.PostedNudgeSpec>
|
|
454
|
+
webhooks:
|
|
455
|
+
type: optional<list<optional<root.PostedWebhookSpec>>>
|
|
456
|
+
docs: Webhook config specifications for each subscriber.
|
|
457
|
+
content-type: application/json
|
|
458
|
+
response:
|
|
459
|
+
docs: Created
|
|
460
|
+
type: root.ReturnConfig
|
|
461
|
+
status-code: 201
|
|
462
|
+
errors:
|
|
463
|
+
- root.BadRequestError
|
|
464
|
+
examples:
|
|
465
|
+
- path-parameters:
|
|
466
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
467
|
+
request:
|
|
468
|
+
version_description: This is an updated version of the Weather Assistant Config.
|
|
469
|
+
evi_version: '3'
|
|
470
|
+
prompt:
|
|
471
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
472
|
+
version: 0
|
|
473
|
+
voice:
|
|
474
|
+
provider: HUME_AI
|
|
475
|
+
name: Ava Song
|
|
476
|
+
language_model:
|
|
477
|
+
model_provider: ANTHROPIC
|
|
478
|
+
model_resource: claude-3-7-sonnet-latest
|
|
479
|
+
temperature: 1
|
|
480
|
+
ellm_model:
|
|
481
|
+
allow_short_responses: true
|
|
482
|
+
event_messages:
|
|
483
|
+
on_new_chat:
|
|
484
|
+
enabled: false
|
|
485
|
+
text: ''
|
|
486
|
+
on_inactivity_timeout:
|
|
487
|
+
enabled: false
|
|
488
|
+
text: ''
|
|
489
|
+
on_max_duration_timeout:
|
|
490
|
+
enabled: false
|
|
491
|
+
text: ''
|
|
492
|
+
response:
|
|
493
|
+
body:
|
|
494
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
495
|
+
version: 1
|
|
496
|
+
version_description: This is an updated version of the Weather Assistant Config.
|
|
497
|
+
name: Weather Assistant Config
|
|
498
|
+
created_on: 1715275452390
|
|
499
|
+
modified_on: 1722642242998
|
|
500
|
+
evi_version: '3'
|
|
501
|
+
prompt:
|
|
502
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
503
|
+
version: 0
|
|
504
|
+
version_type: FIXED
|
|
505
|
+
version_description: ''
|
|
506
|
+
name: Weather Assistant Prompt
|
|
507
|
+
created_on: 1715267200693
|
|
508
|
+
modified_on: 1715267200693
|
|
509
|
+
text: >-
|
|
510
|
+
<role>You are an AI weather assistant providing users with
|
|
511
|
+
accurate and up-to-date weather information. Respond to user
|
|
512
|
+
queries concisely and clearly. Use simple language and avoid
|
|
513
|
+
technical jargon. Provide temperature, precipitation, wind
|
|
514
|
+
conditions, and any weather alerts. Include helpful tips if
|
|
515
|
+
severe weather is expected.</role>
|
|
516
|
+
voice:
|
|
517
|
+
provider: HUME_AI
|
|
518
|
+
name: Ava Song
|
|
519
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
520
|
+
language_model:
|
|
521
|
+
model_provider: ANTHROPIC
|
|
522
|
+
model_resource: claude-3-7-sonnet-latest
|
|
523
|
+
temperature: 1
|
|
524
|
+
ellm_model:
|
|
525
|
+
allow_short_responses: true
|
|
526
|
+
tools: []
|
|
527
|
+
builtin_tools: []
|
|
528
|
+
event_messages:
|
|
529
|
+
on_new_chat:
|
|
530
|
+
enabled: false
|
|
531
|
+
text: ''
|
|
532
|
+
on_inactivity_timeout:
|
|
533
|
+
enabled: false
|
|
534
|
+
text: ''
|
|
535
|
+
on_max_duration_timeout:
|
|
536
|
+
enabled: false
|
|
537
|
+
text: ''
|
|
538
|
+
timeouts:
|
|
539
|
+
inactivity:
|
|
540
|
+
enabled: true
|
|
541
|
+
duration_secs: 600
|
|
542
|
+
max_duration:
|
|
543
|
+
enabled: true
|
|
544
|
+
duration_secs: 1800
|
|
545
|
+
delete-config:
|
|
546
|
+
path: /v0/evi/configs/{id}
|
|
547
|
+
method: DELETE
|
|
548
|
+
auth: true
|
|
549
|
+
docs: >-
|
|
550
|
+
Deletes a **Config** and its versions.
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
For more details on configuration options and how to configure EVI, see
|
|
554
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
555
|
+
source:
|
|
556
|
+
openapi: evi-openapi.json
|
|
557
|
+
path-parameters:
|
|
558
|
+
id:
|
|
559
|
+
type: string
|
|
560
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
561
|
+
display-name: Delete config
|
|
562
|
+
errors:
|
|
563
|
+
- root.BadRequestError
|
|
564
|
+
examples:
|
|
565
|
+
- path-parameters:
|
|
566
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
567
|
+
update-config-name:
|
|
568
|
+
path: /v0/evi/configs/{id}
|
|
569
|
+
method: PATCH
|
|
570
|
+
auth: true
|
|
571
|
+
docs: >-
|
|
572
|
+
Updates the name of a **Config**.
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
For more details on configuration options and how to configure EVI, see
|
|
576
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
577
|
+
source:
|
|
578
|
+
openapi: evi-openapi.json
|
|
579
|
+
path-parameters:
|
|
580
|
+
id:
|
|
581
|
+
type: string
|
|
582
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
583
|
+
display-name: Update config name
|
|
584
|
+
request:
|
|
585
|
+
name: PostedConfigName
|
|
586
|
+
body:
|
|
587
|
+
properties:
|
|
588
|
+
name:
|
|
589
|
+
type: string
|
|
590
|
+
docs: Name applied to all versions of a particular Config.
|
|
591
|
+
content-type: application/json
|
|
592
|
+
response:
|
|
593
|
+
docs: Success
|
|
594
|
+
type: text
|
|
595
|
+
status-code: 200
|
|
596
|
+
errors:
|
|
597
|
+
- root.BadRequestError
|
|
598
|
+
examples:
|
|
599
|
+
- path-parameters:
|
|
600
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
601
|
+
request:
|
|
602
|
+
name: Updated Weather Assistant Config Name
|
|
603
|
+
get-config-version:
|
|
604
|
+
path: /v0/evi/configs/{id}/version/{version}
|
|
605
|
+
method: GET
|
|
606
|
+
auth: true
|
|
607
|
+
docs: >-
|
|
608
|
+
Fetches a specified version of a **Config**.
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
For more details on configuration options and how to configure EVI, see
|
|
612
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
613
|
+
source:
|
|
614
|
+
openapi: evi-openapi.json
|
|
615
|
+
path-parameters:
|
|
616
|
+
id:
|
|
617
|
+
type: string
|
|
618
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
619
|
+
version:
|
|
620
|
+
type: integer
|
|
621
|
+
docs: >-
|
|
622
|
+
Version number for a Config.
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This
|
|
626
|
+
versioning system supports iterative development, allowing you to
|
|
627
|
+
progressively refine configurations and revert to previous versions
|
|
628
|
+
if needed.
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
Version numbers are integer values representing different iterations
|
|
632
|
+
of the Config. Each update to the Config increments its version
|
|
633
|
+
number.
|
|
634
|
+
display-name: Get config version
|
|
635
|
+
response:
|
|
636
|
+
docs: Success
|
|
637
|
+
type: root.ReturnConfig
|
|
638
|
+
status-code: 200
|
|
639
|
+
errors:
|
|
640
|
+
- root.BadRequestError
|
|
641
|
+
examples:
|
|
642
|
+
- path-parameters:
|
|
643
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
644
|
+
version: 1
|
|
645
|
+
response:
|
|
646
|
+
body:
|
|
647
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
648
|
+
version: 1
|
|
649
|
+
version_description: ''
|
|
650
|
+
name: Weather Assistant Config
|
|
651
|
+
created_on: 1715275452390
|
|
652
|
+
modified_on: 1715275452390
|
|
653
|
+
evi_version: '3'
|
|
654
|
+
prompt:
|
|
655
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
656
|
+
version: 0
|
|
657
|
+
version_type: FIXED
|
|
658
|
+
version_description: ''
|
|
659
|
+
name: Weather Assistant Prompt
|
|
660
|
+
created_on: 1715267200693
|
|
661
|
+
modified_on: 1715267200693
|
|
662
|
+
text: >-
|
|
663
|
+
<role>You are an AI weather assistant providing users with
|
|
664
|
+
accurate and up-to-date weather information. Respond to user
|
|
665
|
+
queries concisely and clearly. Use simple language and avoid
|
|
666
|
+
technical jargon. Provide temperature, precipitation, wind
|
|
667
|
+
conditions, and any weather alerts. Include helpful tips if
|
|
668
|
+
severe weather is expected.</role>
|
|
669
|
+
voice:
|
|
670
|
+
provider: HUME_AI
|
|
671
|
+
name: Ava Song
|
|
672
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
673
|
+
language_model:
|
|
674
|
+
model_provider: ANTHROPIC
|
|
675
|
+
model_resource: claude-3-7-sonnet-latest
|
|
676
|
+
temperature: 1
|
|
677
|
+
ellm_model:
|
|
678
|
+
allow_short_responses: false
|
|
679
|
+
tools: []
|
|
680
|
+
builtin_tools: []
|
|
681
|
+
event_messages:
|
|
682
|
+
on_new_chat:
|
|
683
|
+
enabled: false
|
|
684
|
+
text: ''
|
|
685
|
+
on_inactivity_timeout:
|
|
686
|
+
enabled: false
|
|
687
|
+
text: ''
|
|
688
|
+
on_max_duration_timeout:
|
|
689
|
+
enabled: false
|
|
690
|
+
text: ''
|
|
691
|
+
timeouts:
|
|
692
|
+
inactivity:
|
|
693
|
+
enabled: true
|
|
694
|
+
duration_secs: 600
|
|
695
|
+
max_duration:
|
|
696
|
+
enabled: true
|
|
697
|
+
duration_secs: 1800
|
|
698
|
+
delete-config-version:
|
|
699
|
+
path: /v0/evi/configs/{id}/version/{version}
|
|
700
|
+
method: DELETE
|
|
701
|
+
auth: true
|
|
702
|
+
docs: >-
|
|
703
|
+
Deletes a specified version of a **Config**.
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
For more details on configuration options and how to configure EVI, see
|
|
707
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
708
|
+
source:
|
|
709
|
+
openapi: evi-openapi.json
|
|
710
|
+
path-parameters:
|
|
711
|
+
id:
|
|
712
|
+
type: string
|
|
713
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
714
|
+
version:
|
|
715
|
+
type: integer
|
|
716
|
+
docs: >-
|
|
717
|
+
Version number for a Config.
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This
|
|
721
|
+
versioning system supports iterative development, allowing you to
|
|
722
|
+
progressively refine configurations and revert to previous versions
|
|
723
|
+
if needed.
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
Version numbers are integer values representing different iterations
|
|
727
|
+
of the Config. Each update to the Config increments its version
|
|
728
|
+
number.
|
|
729
|
+
display-name: Delete config version
|
|
730
|
+
errors:
|
|
731
|
+
- root.BadRequestError
|
|
732
|
+
examples:
|
|
733
|
+
- path-parameters:
|
|
734
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
735
|
+
version: 1
|
|
736
|
+
update-config-description:
|
|
737
|
+
path: /v0/evi/configs/{id}/version/{version}
|
|
738
|
+
method: PATCH
|
|
739
|
+
auth: true
|
|
740
|
+
docs: >-
|
|
741
|
+
Updates the description of a **Config**.
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
For more details on configuration options and how to configure EVI, see
|
|
745
|
+
our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
746
|
+
source:
|
|
747
|
+
openapi: evi-openapi.json
|
|
748
|
+
path-parameters:
|
|
749
|
+
id:
|
|
750
|
+
type: string
|
|
751
|
+
docs: Identifier for a Config. Formatted as a UUID.
|
|
752
|
+
version:
|
|
753
|
+
type: integer
|
|
754
|
+
docs: >-
|
|
755
|
+
Version number for a Config.
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This
|
|
759
|
+
versioning system supports iterative development, allowing you to
|
|
760
|
+
progressively refine configurations and revert to previous versions
|
|
761
|
+
if needed.
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
Version numbers are integer values representing different iterations
|
|
765
|
+
of the Config. Each update to the Config increments its version
|
|
766
|
+
number.
|
|
767
|
+
display-name: Update config description
|
|
768
|
+
request:
|
|
769
|
+
name: PostedConfigVersionDescription
|
|
770
|
+
body:
|
|
771
|
+
properties:
|
|
772
|
+
version_description:
|
|
773
|
+
type: optional<string>
|
|
774
|
+
docs: An optional description of the Config version.
|
|
775
|
+
content-type: application/json
|
|
776
|
+
response:
|
|
777
|
+
docs: Success
|
|
778
|
+
type: root.ReturnConfig
|
|
779
|
+
status-code: 200
|
|
780
|
+
errors:
|
|
781
|
+
- root.BadRequestError
|
|
782
|
+
examples:
|
|
783
|
+
- path-parameters:
|
|
784
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
785
|
+
version: 1
|
|
786
|
+
request:
|
|
787
|
+
version_description: This is an updated version_description.
|
|
788
|
+
response:
|
|
789
|
+
body:
|
|
790
|
+
id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
791
|
+
version: 1
|
|
792
|
+
version_description: This is an updated version_description.
|
|
793
|
+
name: Weather Assistant Config
|
|
794
|
+
created_on: 1715275452390
|
|
795
|
+
modified_on: 1715275452390
|
|
796
|
+
evi_version: '3'
|
|
797
|
+
prompt:
|
|
798
|
+
id: af699d45-2985-42cc-91b9-af9e5da3bac5
|
|
799
|
+
version: 0
|
|
800
|
+
version_type: FIXED
|
|
801
|
+
version_description: ''
|
|
802
|
+
name: Weather Assistant Prompt
|
|
803
|
+
created_on: 1715267200693
|
|
804
|
+
modified_on: 1715267200693
|
|
805
|
+
text: >-
|
|
806
|
+
<role>You are an AI weather assistant providing users with
|
|
807
|
+
accurate and up-to-date weather information. Respond to user
|
|
808
|
+
queries concisely and clearly. Use simple language and avoid
|
|
809
|
+
technical jargon. Provide temperature, precipitation, wind
|
|
810
|
+
conditions, and any weather alerts. Include helpful tips if
|
|
811
|
+
severe weather is expected.</role>
|
|
812
|
+
voice:
|
|
813
|
+
provider: HUME_AI
|
|
814
|
+
name: Ava Song
|
|
815
|
+
id: 5bb7de05-c8fe-426a-8fcc-ba4fc4ce9f9c
|
|
816
|
+
language_model:
|
|
817
|
+
model_provider: ANTHROPIC
|
|
818
|
+
model_resource: claude-3-7-sonnet-latest
|
|
819
|
+
temperature: 1
|
|
820
|
+
ellm_model:
|
|
821
|
+
allow_short_responses: false
|
|
822
|
+
tools: []
|
|
823
|
+
builtin_tools: []
|
|
824
|
+
event_messages:
|
|
825
|
+
on_new_chat:
|
|
826
|
+
enabled: false
|
|
827
|
+
text: ''
|
|
828
|
+
on_inactivity_timeout:
|
|
829
|
+
enabled: false
|
|
830
|
+
text: ''
|
|
831
|
+
on_max_duration_timeout:
|
|
832
|
+
enabled: false
|
|
833
|
+
text: ''
|
|
834
|
+
timeouts:
|
|
835
|
+
inactivity:
|
|
836
|
+
enabled: true
|
|
837
|
+
duration_secs: 600
|
|
838
|
+
max_duration:
|
|
839
|
+
enabled: true
|
|
840
|
+
duration_secs: 1800
|
|
841
|
+
source:
|
|
842
|
+
openapi: evi-openapi.json
|