hume 0.9.15 → 0.9.17
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 +2347 -2345
- package/.mock/definition/empathic-voice/chat.yml +34 -34
- package/.mock/definition/empathic-voice/chatGroups.yml +9 -9
- package/.mock/definition/empathic-voice/chatWebhooks.yml +3 -3
- package/.mock/definition/empathic-voice/chats.yml +7 -7
- package/.mock/definition/empathic-voice/configs.yml +19 -19
- package/.mock/definition/empathic-voice/customVoices.yml +13 -13
- package/.mock/definition/empathic-voice/prompts.yml +19 -19
- package/.mock/definition/empathic-voice/tools.yml +19 -19
- package/.mock/definition/expression-measurement/stream/stream.yml +206 -206
- package/.mock/definition/tts/__package__.yml +60 -2
- package/.mock/definition/tts/voices.yml +76 -0
- package/.mock/fern.config.json +1 -1
- package/api/resources/empathicVoice/resources/chat/types/index.d.ts +1 -1
- package/api/resources/empathicVoice/resources/chat/types/index.js +1 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/empathicVoice/types/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/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/ErrorResponse.d.ts +1 -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 +10 -10
- package/api/resources/empathicVoice/types/WebSocketError.d.ts +10 -8
- 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 +84 -84
- package/api/resources/empathicVoice/types/index.js +84 -84
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +4 -4
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +4 -4
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/api/resources/tts/client/Client.d.ts +1 -1
- package/api/resources/tts/client/Client.js +5 -5
- package/api/resources/tts/errors/BadRequestError.d.ts +8 -0
- package/api/resources/tts/errors/BadRequestError.js +41 -0
- package/api/resources/tts/errors/index.d.ts +1 -0
- package/api/resources/tts/errors/index.js +1 -0
- package/api/resources/tts/resources/voices/client/Client.d.ts +28 -0
- package/api/resources/tts/resources/voices/client/Client.js +144 -2
- package/api/resources/tts/resources/voices/client/requests/VoicesDeleteRequest.d.ts +15 -0
- package/api/resources/tts/resources/voices/client/requests/VoicesDeleteRequest.js +5 -0
- package/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +29 -0
- package/api/resources/tts/resources/voices/client/requests/VoicesListRequest.js +5 -0
- package/api/resources/tts/resources/voices/client/requests/index.d.ts +2 -0
- package/api/resources/tts/types/ErrorResponse.d.ts +8 -0
- package/api/resources/tts/types/ErrorResponse.js +5 -0
- package/api/resources/tts/types/ReturnPagedVoices.d.ts +13 -0
- package/api/resources/tts/types/ReturnPagedVoices.js +5 -0
- package/api/resources/tts/types/ReturnVoice.d.ts +17 -1
- package/api/resources/tts/types/SnippetAudioChunk.d.ts +15 -0
- package/api/resources/tts/types/SnippetAudioChunk.js +5 -0
- package/api/resources/tts/types/index.d.ts +3 -0
- package/api/resources/tts/types/index.js +3 -0
- package/dist/api/resources/empathicVoice/resources/chat/types/index.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/chat/types/index.js +1 -1
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/types/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/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/ErrorResponse.d.ts +1 -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 +10 -10
- package/dist/api/resources/empathicVoice/types/WebSocketError.d.ts +10 -8
- 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 +84 -84
- package/dist/api/resources/empathicVoice/types/index.js +84 -84
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +4 -4
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +4 -4
- 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 +1 -1
- package/dist/api/resources/tts/client/Client.js +5 -5
- package/dist/api/resources/tts/errors/BadRequestError.d.ts +8 -0
- package/dist/api/resources/tts/errors/BadRequestError.js +41 -0
- package/dist/api/resources/tts/errors/index.d.ts +1 -0
- package/dist/api/resources/tts/errors/index.js +1 -0
- package/dist/api/resources/tts/resources/voices/client/Client.d.ts +28 -0
- package/dist/api/resources/tts/resources/voices/client/Client.js +144 -2
- package/dist/api/resources/tts/resources/voices/client/requests/VoicesDeleteRequest.d.ts +15 -0
- package/dist/api/resources/tts/resources/voices/client/requests/VoicesDeleteRequest.js +5 -0
- package/dist/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts +29 -0
- package/dist/api/resources/tts/resources/voices/client/requests/VoicesListRequest.js +5 -0
- package/dist/api/resources/tts/resources/voices/client/requests/index.d.ts +2 -0
- package/dist/api/resources/tts/types/ErrorResponse.d.ts +8 -0
- package/dist/api/resources/tts/types/ErrorResponse.js +5 -0
- package/dist/api/resources/tts/types/ReturnPagedVoices.d.ts +13 -0
- package/dist/api/resources/tts/types/ReturnPagedVoices.js +5 -0
- package/dist/api/resources/tts/types/ReturnVoice.d.ts +17 -1
- package/dist/api/resources/tts/types/SnippetAudioChunk.d.ts +15 -0
- package/dist/api/resources/tts/types/SnippetAudioChunk.js +5 -0
- package/dist/api/resources/tts/types/index.d.ts +3 -0
- package/dist/api/resources/tts/types/index.js +3 -0
- package/dist/serialization/resources/empathicVoice/resources/chat/types/index.d.ts +1 -1
- package/dist/serialization/resources/empathicVoice/resources/chat/types/index.js +1 -1
- 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/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/ErrorResponse.d.ts +1 -0
- package/dist/serialization/resources/empathicVoice/types/ErrorResponse.js +1 -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 +4 -3
- package/dist/serialization/resources/empathicVoice/types/WebSocketError.js +4 -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 +84 -84
- package/dist/serialization/resources/empathicVoice/types/index.js +84 -84
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +4 -4
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +4 -4
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/serialization/resources/tts/types/ErrorResponse.d.ts +14 -0
- package/dist/serialization/resources/tts/types/ErrorResponse.js +35 -0
- package/dist/serialization/resources/tts/types/ReturnPagedVoices.d.ts +16 -0
- package/dist/serialization/resources/tts/types/ReturnPagedVoices.js +37 -0
- package/dist/serialization/resources/tts/types/ReturnVoice.d.ts +3 -1
- package/dist/serialization/resources/tts/types/ReturnVoice.js +3 -1
- package/dist/serialization/resources/tts/types/SnippetAudioChunk.d.ts +16 -0
- package/dist/serialization/resources/tts/types/SnippetAudioChunk.js +37 -0
- package/dist/serialization/resources/tts/types/index.d.ts +3 -0
- package/dist/serialization/resources/tts/types/index.js +3 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +351 -221
- package/serialization/resources/empathicVoice/resources/chat/types/index.d.ts +1 -1
- package/serialization/resources/empathicVoice/resources/chat/types/index.js +1 -1
- 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/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/ErrorResponse.d.ts +1 -0
- package/serialization/resources/empathicVoice/types/ErrorResponse.js +1 -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 +4 -3
- package/serialization/resources/empathicVoice/types/WebSocketError.js +4 -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 +84 -84
- package/serialization/resources/empathicVoice/types/index.js +84 -84
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +4 -4
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +4 -4
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/serialization/resources/tts/types/ErrorResponse.d.ts +14 -0
- package/serialization/resources/tts/types/ErrorResponse.js +35 -0
- package/serialization/resources/tts/types/ReturnPagedVoices.d.ts +16 -0
- package/serialization/resources/tts/types/ReturnPagedVoices.js +37 -0
- package/serialization/resources/tts/types/ReturnVoice.d.ts +3 -1
- package/serialization/resources/tts/types/ReturnVoice.js +3 -1
- package/serialization/resources/tts/types/SnippetAudioChunk.d.ts +16 -0
- package/serialization/resources/tts/types/SnippetAudioChunk.js +37 -0
- package/serialization/resources/tts/types/index.d.ts +3 -0
- package/serialization/resources/tts/types/index.js +3 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
channel:
|
|
2
|
-
path: /
|
|
2
|
+
path: /chat
|
|
3
3
|
url: prod
|
|
4
4
|
auth: false
|
|
5
5
|
docs: Chat with Empathic Voice Interface (EVI)
|
|
6
6
|
query-parameters:
|
|
7
|
+
access_token:
|
|
8
|
+
type: optional<string>
|
|
9
|
+
default: ''
|
|
10
|
+
docs: >-
|
|
11
|
+
Access token used for authenticating the client. If not provided, an
|
|
12
|
+
`api_key` must be provided to authenticate.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
The access token is generated using both an API key and a Secret key,
|
|
16
|
+
which provides an additional layer of security compared to using just an
|
|
17
|
+
API key.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
For more details, refer to the [Authentication Strategies
|
|
21
|
+
Guide](/docs/introduction/api-key#authentication-strategies).
|
|
7
22
|
config_id:
|
|
8
23
|
type: optional<string>
|
|
9
24
|
docs: >-
|
|
@@ -87,21 +102,6 @@ channel:
|
|
|
87
102
|
field on a
|
|
88
103
|
[UserMessage](/reference/empathic-voice-interface-evi/chat/chat#receive.User%20Message.type)
|
|
89
104
|
denotes whether the message is "interim" or "final."
|
|
90
|
-
access_token:
|
|
91
|
-
type: optional<string>
|
|
92
|
-
default: ''
|
|
93
|
-
docs: >-
|
|
94
|
-
Access token used for authenticating the client. If not provided, an
|
|
95
|
-
`api_key` must be provided to authenticate.
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
The access token is generated using both an API key and a Secret key,
|
|
99
|
-
which provides an additional layer of security compared to using just an
|
|
100
|
-
API key.
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
For more details, refer to the [Authentication Strategies
|
|
104
|
-
Guide](/docs/introduction/api-key#authentication-strategies).
|
|
105
105
|
api_key:
|
|
106
106
|
type: optional<string>
|
|
107
107
|
default: ''
|
|
@@ -113,24 +113,37 @@ channel:
|
|
|
113
113
|
For more details, refer to the [Authentication Strategies
|
|
114
114
|
Guide](/docs/introduction/api-key#authentication-strategies).
|
|
115
115
|
messages:
|
|
116
|
-
subscribe:
|
|
117
|
-
origin: server
|
|
118
|
-
body: SubscribeEvent
|
|
119
116
|
publish:
|
|
120
117
|
origin: client
|
|
121
118
|
body: PublishEvent
|
|
119
|
+
subscribe:
|
|
120
|
+
origin: server
|
|
121
|
+
body: SubscribeEvent
|
|
122
122
|
examples:
|
|
123
123
|
- messages:
|
|
124
124
|
- type: publish
|
|
125
125
|
body:
|
|
126
|
-
type: audio_input
|
|
127
126
|
data: data
|
|
127
|
+
type: audio_input
|
|
128
128
|
- type: subscribe
|
|
129
129
|
body:
|
|
130
130
|
type: assistant_end
|
|
131
131
|
imports:
|
|
132
132
|
root: __package__.yml
|
|
133
133
|
types:
|
|
134
|
+
PublishEvent:
|
|
135
|
+
discriminated: false
|
|
136
|
+
union:
|
|
137
|
+
- type: root.AudioInput
|
|
138
|
+
- type: root.SessionSettings
|
|
139
|
+
- type: root.UserInput
|
|
140
|
+
- type: root.AssistantInput
|
|
141
|
+
- type: root.ToolResponseMessage
|
|
142
|
+
- type: root.ToolErrorMessage
|
|
143
|
+
- type: root.PauseAssistantMessage
|
|
144
|
+
- type: root.ResumeAssistantMessage
|
|
145
|
+
source:
|
|
146
|
+
openapi: evi-asyncapi.json
|
|
134
147
|
SubscribeEvent:
|
|
135
148
|
discriminated: false
|
|
136
149
|
union:
|
|
@@ -145,17 +158,4 @@ types:
|
|
|
145
158
|
- type: root.ToolResponseMessage
|
|
146
159
|
- type: root.ToolErrorMessage
|
|
147
160
|
source:
|
|
148
|
-
openapi:
|
|
149
|
-
PublishEvent:
|
|
150
|
-
discriminated: false
|
|
151
|
-
union:
|
|
152
|
-
- type: root.AudioInput
|
|
153
|
-
- type: root.SessionSettings
|
|
154
|
-
- type: root.UserInput
|
|
155
|
-
- type: root.AssistantInput
|
|
156
|
-
- type: root.ToolResponseMessage
|
|
157
|
-
- type: root.ToolErrorMessage
|
|
158
|
-
- type: root.PauseAssistantMessage
|
|
159
|
-
- type: root.ResumeAssistantMessage
|
|
160
|
-
source:
|
|
161
|
-
openapi: assistant-asyncapi.json
|
|
161
|
+
openapi: evi-asyncapi.json
|
|
@@ -7,10 +7,10 @@ service:
|
|
|
7
7
|
list-chat-groups:
|
|
8
8
|
path: /v0/evi/chat_groups
|
|
9
9
|
method: GET
|
|
10
|
-
auth:
|
|
10
|
+
auth: false
|
|
11
11
|
docs: Fetches a paginated list of **Chat Groups**.
|
|
12
12
|
source:
|
|
13
|
-
openapi:
|
|
13
|
+
openapi: evi-openapi.json
|
|
14
14
|
display-name: List chat_groups
|
|
15
15
|
request:
|
|
16
16
|
name: ChatGroupsListChatGroupsRequest
|
|
@@ -82,12 +82,12 @@ service:
|
|
|
82
82
|
get-chat-group:
|
|
83
83
|
path: /v0/evi/chat_groups/{id}
|
|
84
84
|
method: GET
|
|
85
|
-
auth:
|
|
85
|
+
auth: false
|
|
86
86
|
docs: >-
|
|
87
87
|
Fetches a **ChatGroup** by ID, including a paginated list of **Chats**
|
|
88
88
|
associated with the **ChatGroup**.
|
|
89
89
|
source:
|
|
90
|
-
openapi:
|
|
90
|
+
openapi: evi-openapi.json
|
|
91
91
|
path-parameters:
|
|
92
92
|
id:
|
|
93
93
|
type: string
|
|
@@ -161,12 +161,12 @@ service:
|
|
|
161
161
|
list-chat-group-events:
|
|
162
162
|
path: /v0/evi/chat_groups/{id}/events
|
|
163
163
|
method: GET
|
|
164
|
-
auth:
|
|
164
|
+
auth: false
|
|
165
165
|
docs: >-
|
|
166
166
|
Fetches a paginated list of **Chat** events associated with a **Chat
|
|
167
167
|
Group**.
|
|
168
168
|
source:
|
|
169
|
-
openapi:
|
|
169
|
+
openapi: evi-openapi.json
|
|
170
170
|
path-parameters:
|
|
171
171
|
id:
|
|
172
172
|
type: string
|
|
@@ -538,13 +538,13 @@ service:
|
|
|
538
538
|
get-audio:
|
|
539
539
|
path: /v0/evi/chat_groups/{id}/audio
|
|
540
540
|
method: GET
|
|
541
|
-
auth:
|
|
541
|
+
auth: false
|
|
542
542
|
docs: >-
|
|
543
543
|
Fetches a paginated list of audio for each **Chat** within the specified
|
|
544
544
|
**Chat Group**. For more details, see our guide on audio reconstruction
|
|
545
545
|
[here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
546
546
|
source:
|
|
547
|
-
openapi:
|
|
547
|
+
openapi: evi-openapi.json
|
|
548
548
|
path-parameters:
|
|
549
549
|
id:
|
|
550
550
|
type: string
|
|
@@ -614,4 +614,4 @@ service:
|
|
|
614
614
|
signed_audio_url: https://storage.googleapis.com/...etc.
|
|
615
615
|
signed_url_expiration_timestamp_millis: 1730232816964
|
|
616
616
|
source:
|
|
617
|
-
openapi:
|
|
617
|
+
openapi: evi-openapi.json
|
|
@@ -11,10 +11,10 @@ webhooks:
|
|
|
11
11
|
chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
|
|
12
12
|
chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
|
|
13
13
|
config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
14
|
-
event_name: chat_ended
|
|
15
|
-
end_time: 1716244958546
|
|
16
14
|
duration_seconds: 180
|
|
17
15
|
end_reason: USER_ENDED
|
|
16
|
+
end_time: 1716244958546
|
|
17
|
+
event_name: chat_ended
|
|
18
18
|
docs: Sent when an EVI chat ends.
|
|
19
19
|
chatStarted:
|
|
20
20
|
method: POST
|
|
@@ -26,7 +26,7 @@ webhooks:
|
|
|
26
26
|
chat_group_id: 9fc18597-3567-42d5-94d6-935bde84bf2f
|
|
27
27
|
chat_id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
|
|
28
28
|
config_id: 1b60e1a0-cc59-424a-8d2c-189d354db3f3
|
|
29
|
+
chat_start_type: new_chat_group
|
|
29
30
|
event_name: chat_started
|
|
30
31
|
start_time: 1716244940648
|
|
31
|
-
chat_start_type: new_chat_group
|
|
32
32
|
docs: Sent when an EVI chat is started.
|
|
@@ -7,13 +7,13 @@ service:
|
|
|
7
7
|
list-chats:
|
|
8
8
|
path: /v0/evi/chats
|
|
9
9
|
method: GET
|
|
10
|
-
auth:
|
|
10
|
+
auth: false
|
|
11
11
|
docs: Fetches a paginated list of **Chats**.
|
|
12
12
|
pagination:
|
|
13
13
|
offset: $request.page_number
|
|
14
14
|
results: $response.chats_page
|
|
15
15
|
source:
|
|
16
|
-
openapi:
|
|
16
|
+
openapi: evi-openapi.json
|
|
17
17
|
display-name: List chats
|
|
18
18
|
request:
|
|
19
19
|
name: ChatsListChatsRequest
|
|
@@ -83,13 +83,13 @@ service:
|
|
|
83
83
|
list-chat-events:
|
|
84
84
|
path: /v0/evi/chats/{id}
|
|
85
85
|
method: GET
|
|
86
|
-
auth:
|
|
86
|
+
auth: false
|
|
87
87
|
docs: Fetches a paginated list of **Chat** events.
|
|
88
88
|
pagination:
|
|
89
89
|
offset: $request.page_number
|
|
90
90
|
results: $response.events_page
|
|
91
91
|
source:
|
|
92
|
-
openapi:
|
|
92
|
+
openapi: evi-openapi.json
|
|
93
93
|
path-parameters:
|
|
94
94
|
id:
|
|
95
95
|
type: string
|
|
@@ -469,13 +469,13 @@ service:
|
|
|
469
469
|
get-audio:
|
|
470
470
|
path: /v0/evi/chats/{id}/audio
|
|
471
471
|
method: GET
|
|
472
|
-
auth:
|
|
472
|
+
auth: false
|
|
473
473
|
docs: >-
|
|
474
474
|
Fetches the audio of a previous **Chat**. For more details, see our
|
|
475
475
|
guide on audio reconstruction
|
|
476
476
|
[here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
477
477
|
source:
|
|
478
|
-
openapi:
|
|
478
|
+
openapi: evi-openapi.json
|
|
479
479
|
path-parameters:
|
|
480
480
|
id:
|
|
481
481
|
type: string
|
|
@@ -501,4 +501,4 @@ service:
|
|
|
501
501
|
signed_audio_url: https://storage.googleapis.com/...etc.
|
|
502
502
|
signed_url_expiration_timestamp_millis: 1730232816964
|
|
503
503
|
source:
|
|
504
|
-
openapi:
|
|
504
|
+
openapi: evi-openapi.json
|
|
@@ -7,7 +7,7 @@ service:
|
|
|
7
7
|
list-configs:
|
|
8
8
|
path: /v0/evi/configs
|
|
9
9
|
method: GET
|
|
10
|
-
auth:
|
|
10
|
+
auth: false
|
|
11
11
|
docs: >-
|
|
12
12
|
Fetches a paginated list of **Configs**.
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ service:
|
|
|
16
16
|
our [configuration
|
|
17
17
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
18
18
|
source:
|
|
19
|
-
openapi:
|
|
19
|
+
openapi: evi-openapi.json
|
|
20
20
|
display-name: List configs
|
|
21
21
|
request:
|
|
22
22
|
name: ConfigsListConfigsRequest
|
|
@@ -139,7 +139,7 @@ service:
|
|
|
139
139
|
create-config:
|
|
140
140
|
path: /v0/evi/configs
|
|
141
141
|
method: POST
|
|
142
|
-
auth:
|
|
142
|
+
auth: false
|
|
143
143
|
docs: >-
|
|
144
144
|
Creates a **Config** which can be applied to EVI.
|
|
145
145
|
|
|
@@ -148,7 +148,7 @@ service:
|
|
|
148
148
|
our [configuration
|
|
149
149
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
150
150
|
source:
|
|
151
|
-
openapi:
|
|
151
|
+
openapi: evi-openapi.json
|
|
152
152
|
display-name: Create config
|
|
153
153
|
request:
|
|
154
154
|
name: PostedConfig
|
|
@@ -307,7 +307,7 @@ service:
|
|
|
307
307
|
list-config-versions:
|
|
308
308
|
path: /v0/evi/configs/{id}
|
|
309
309
|
method: GET
|
|
310
|
-
auth:
|
|
310
|
+
auth: false
|
|
311
311
|
docs: >-
|
|
312
312
|
Fetches a list of a **Config's** versions.
|
|
313
313
|
|
|
@@ -316,7 +316,7 @@ service:
|
|
|
316
316
|
our [configuration
|
|
317
317
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
318
318
|
source:
|
|
319
|
-
openapi:
|
|
319
|
+
openapi: evi-openapi.json
|
|
320
320
|
path-parameters:
|
|
321
321
|
id:
|
|
322
322
|
type: string
|
|
@@ -439,7 +439,7 @@ service:
|
|
|
439
439
|
create-config-version:
|
|
440
440
|
path: /v0/evi/configs/{id}
|
|
441
441
|
method: POST
|
|
442
|
-
auth:
|
|
442
|
+
auth: false
|
|
443
443
|
docs: >-
|
|
444
444
|
Updates a **Config** by creating a new version of the **Config**.
|
|
445
445
|
|
|
@@ -448,7 +448,7 @@ service:
|
|
|
448
448
|
our [configuration
|
|
449
449
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
450
450
|
source:
|
|
451
|
-
openapi:
|
|
451
|
+
openapi: evi-openapi.json
|
|
452
452
|
path-parameters:
|
|
453
453
|
id:
|
|
454
454
|
type: string
|
|
@@ -609,7 +609,7 @@ service:
|
|
|
609
609
|
delete-config:
|
|
610
610
|
path: /v0/evi/configs/{id}
|
|
611
611
|
method: DELETE
|
|
612
|
-
auth:
|
|
612
|
+
auth: false
|
|
613
613
|
docs: >-
|
|
614
614
|
Deletes a **Config** and its versions.
|
|
615
615
|
|
|
@@ -618,7 +618,7 @@ service:
|
|
|
618
618
|
our [configuration
|
|
619
619
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
620
620
|
source:
|
|
621
|
-
openapi:
|
|
621
|
+
openapi: evi-openapi.json
|
|
622
622
|
path-parameters:
|
|
623
623
|
id:
|
|
624
624
|
type: string
|
|
@@ -632,7 +632,7 @@ service:
|
|
|
632
632
|
update-config-name:
|
|
633
633
|
path: /v0/evi/configs/{id}
|
|
634
634
|
method: PATCH
|
|
635
|
-
auth:
|
|
635
|
+
auth: false
|
|
636
636
|
docs: >-
|
|
637
637
|
Updates the name of a **Config**.
|
|
638
638
|
|
|
@@ -641,7 +641,7 @@ service:
|
|
|
641
641
|
our [configuration
|
|
642
642
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
643
643
|
source:
|
|
644
|
-
openapi:
|
|
644
|
+
openapi: evi-openapi.json
|
|
645
645
|
path-parameters:
|
|
646
646
|
id:
|
|
647
647
|
type: string
|
|
@@ -669,7 +669,7 @@ service:
|
|
|
669
669
|
get-config-version:
|
|
670
670
|
path: /v0/evi/configs/{id}/version/{version}
|
|
671
671
|
method: GET
|
|
672
|
-
auth:
|
|
672
|
+
auth: false
|
|
673
673
|
docs: >-
|
|
674
674
|
Fetches a specified version of a **Config**.
|
|
675
675
|
|
|
@@ -678,7 +678,7 @@ service:
|
|
|
678
678
|
our [configuration
|
|
679
679
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
680
680
|
source:
|
|
681
|
-
openapi:
|
|
681
|
+
openapi: evi-openapi.json
|
|
682
682
|
path-parameters:
|
|
683
683
|
id:
|
|
684
684
|
type: string
|
|
@@ -783,7 +783,7 @@ service:
|
|
|
783
783
|
delete-config-version:
|
|
784
784
|
path: /v0/evi/configs/{id}/version/{version}
|
|
785
785
|
method: DELETE
|
|
786
|
-
auth:
|
|
786
|
+
auth: false
|
|
787
787
|
docs: >-
|
|
788
788
|
Deletes a specified version of a **Config**.
|
|
789
789
|
|
|
@@ -792,7 +792,7 @@ service:
|
|
|
792
792
|
our [configuration
|
|
793
793
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
794
794
|
source:
|
|
795
|
-
openapi:
|
|
795
|
+
openapi: evi-openapi.json
|
|
796
796
|
path-parameters:
|
|
797
797
|
id:
|
|
798
798
|
type: string
|
|
@@ -822,7 +822,7 @@ service:
|
|
|
822
822
|
update-config-description:
|
|
823
823
|
path: /v0/evi/configs/{id}/version/{version}
|
|
824
824
|
method: PATCH
|
|
825
|
-
auth:
|
|
825
|
+
auth: false
|
|
826
826
|
docs: >-
|
|
827
827
|
Updates the description of a **Config**.
|
|
828
828
|
|
|
@@ -831,7 +831,7 @@ service:
|
|
|
831
831
|
our [configuration
|
|
832
832
|
guide](/docs/empathic-voice-interface-evi/configuration).
|
|
833
833
|
source:
|
|
834
|
-
openapi:
|
|
834
|
+
openapi: evi-openapi.json
|
|
835
835
|
path-parameters:
|
|
836
836
|
id:
|
|
837
837
|
type: string
|
|
@@ -944,4 +944,4 @@ service:
|
|
|
944
944
|
enabled: true
|
|
945
945
|
duration_secs: 1800
|
|
946
946
|
source:
|
|
947
|
-
openapi:
|
|
947
|
+
openapi: evi-openapi.json
|
|
@@ -7,7 +7,7 @@ service:
|
|
|
7
7
|
list-custom-voices:
|
|
8
8
|
path: /v0/evi/custom_voices
|
|
9
9
|
method: GET
|
|
10
|
-
auth:
|
|
10
|
+
auth: false
|
|
11
11
|
docs: >-
|
|
12
12
|
Fetches a paginated list of **Custom Voices**.
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ service:
|
|
|
16
16
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
17
17
|
details on creating a custom voice.
|
|
18
18
|
source:
|
|
19
|
-
openapi:
|
|
19
|
+
openapi: evi-openapi.json
|
|
20
20
|
display-name: List custom voices
|
|
21
21
|
request:
|
|
22
22
|
name: CustomVoicesListCustomVoicesRequest
|
|
@@ -69,7 +69,7 @@ service:
|
|
|
69
69
|
create-custom-voice:
|
|
70
70
|
path: /v0/evi/custom_voices
|
|
71
71
|
method: POST
|
|
72
|
-
auth:
|
|
72
|
+
auth: false
|
|
73
73
|
docs: >-
|
|
74
74
|
Creates a **Custom Voice** that can be added to an [EVI
|
|
75
75
|
configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
@@ -79,7 +79,7 @@ service:
|
|
|
79
79
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
80
80
|
details on creating a custom voice.
|
|
81
81
|
source:
|
|
82
|
-
openapi:
|
|
82
|
+
openapi: evi-openapi.json
|
|
83
83
|
display-name: Create custom voice
|
|
84
84
|
request:
|
|
85
85
|
body: root.PostedCustomVoice
|
|
@@ -118,7 +118,7 @@ service:
|
|
|
118
118
|
get-custom-voice:
|
|
119
119
|
path: /v0/evi/custom_voices/{id}
|
|
120
120
|
method: GET
|
|
121
|
-
auth:
|
|
121
|
+
auth: false
|
|
122
122
|
docs: >-
|
|
123
123
|
Fetches a specific **Custom Voice** by ID.
|
|
124
124
|
|
|
@@ -127,7 +127,7 @@ service:
|
|
|
127
127
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
128
128
|
details on creating a custom voice.
|
|
129
129
|
source:
|
|
130
|
-
openapi:
|
|
130
|
+
openapi: evi-openapi.json
|
|
131
131
|
path-parameters:
|
|
132
132
|
id:
|
|
133
133
|
type: string
|
|
@@ -165,7 +165,7 @@ service:
|
|
|
165
165
|
create-custom-voice-version:
|
|
166
166
|
path: /v0/evi/custom_voices/{id}
|
|
167
167
|
method: POST
|
|
168
|
-
auth:
|
|
168
|
+
auth: false
|
|
169
169
|
docs: >-
|
|
170
170
|
Updates a **Custom Voice** by creating a new version of the **Custom
|
|
171
171
|
Voice**.
|
|
@@ -175,7 +175,7 @@ service:
|
|
|
175
175
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
176
176
|
details on creating a custom voice.
|
|
177
177
|
source:
|
|
178
|
-
openapi:
|
|
178
|
+
openapi: evi-openapi.json
|
|
179
179
|
path-parameters:
|
|
180
180
|
id:
|
|
181
181
|
type: string
|
|
@@ -220,7 +220,7 @@ service:
|
|
|
220
220
|
delete-custom-voice:
|
|
221
221
|
path: /v0/evi/custom_voices/{id}
|
|
222
222
|
method: DELETE
|
|
223
|
-
auth:
|
|
223
|
+
auth: false
|
|
224
224
|
docs: >-
|
|
225
225
|
Deletes a **Custom Voice** and its versions.
|
|
226
226
|
|
|
@@ -229,7 +229,7 @@ service:
|
|
|
229
229
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
230
230
|
details on creating a custom voice.
|
|
231
231
|
source:
|
|
232
|
-
openapi:
|
|
232
|
+
openapi: evi-openapi.json
|
|
233
233
|
path-parameters:
|
|
234
234
|
id:
|
|
235
235
|
type: string
|
|
@@ -243,7 +243,7 @@ service:
|
|
|
243
243
|
update-custom-voice-name:
|
|
244
244
|
path: /v0/evi/custom_voices/{id}
|
|
245
245
|
method: PATCH
|
|
246
|
-
auth:
|
|
246
|
+
auth: false
|
|
247
247
|
docs: >-
|
|
248
248
|
Updates the name of a **Custom Voice**.
|
|
249
249
|
|
|
@@ -252,7 +252,7 @@ service:
|
|
|
252
252
|
guide](/docs/empathic-voice-interface-evi/configuration/voices) for
|
|
253
253
|
details on creating a custom voice.
|
|
254
254
|
source:
|
|
255
|
-
openapi:
|
|
255
|
+
openapi: evi-openapi.json
|
|
256
256
|
path-parameters:
|
|
257
257
|
id:
|
|
258
258
|
type: string
|
|
@@ -276,4 +276,4 @@ service:
|
|
|
276
276
|
errors:
|
|
277
277
|
- root.BadRequestError
|
|
278
278
|
source:
|
|
279
|
-
openapi:
|
|
279
|
+
openapi: evi-openapi.json
|
|
@@ -7,7 +7,7 @@ service:
|
|
|
7
7
|
list-prompts:
|
|
8
8
|
path: /v0/evi/prompts
|
|
9
9
|
method: GET
|
|
10
|
-
auth:
|
|
10
|
+
auth: false
|
|
11
11
|
docs: >-
|
|
12
12
|
Fetches a paginated list of **Prompts**.
|
|
13
13
|
|
|
@@ -19,7 +19,7 @@ service:
|
|
|
19
19
|
offset: $request.page_number
|
|
20
20
|
results: $response.prompts_page
|
|
21
21
|
source:
|
|
22
|
-
openapi:
|
|
22
|
+
openapi: evi-openapi.json
|
|
23
23
|
display-name: List prompts
|
|
24
24
|
request:
|
|
25
25
|
name: PromptsListPromptsRequest
|
|
@@ -100,7 +100,7 @@ service:
|
|
|
100
100
|
create-prompt:
|
|
101
101
|
path: /v0/evi/prompts
|
|
102
102
|
method: POST
|
|
103
|
-
auth:
|
|
103
|
+
auth: false
|
|
104
104
|
docs: >-
|
|
105
105
|
Creates a **Prompt** that can be added to an [EVI
|
|
106
106
|
configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
@@ -110,7 +110,7 @@ service:
|
|
|
110
110
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
111
111
|
on crafting your system prompt.
|
|
112
112
|
source:
|
|
113
|
-
openapi:
|
|
113
|
+
openapi: evi-openapi.json
|
|
114
114
|
display-name: Create prompt
|
|
115
115
|
request:
|
|
116
116
|
name: PostedPrompt
|
|
@@ -174,7 +174,7 @@ service:
|
|
|
174
174
|
list-prompt-versions:
|
|
175
175
|
path: /v0/evi/prompts/{id}
|
|
176
176
|
method: GET
|
|
177
|
-
auth:
|
|
177
|
+
auth: false
|
|
178
178
|
docs: >-
|
|
179
179
|
Fetches a list of a **Prompt's** versions.
|
|
180
180
|
|
|
@@ -183,7 +183,7 @@ service:
|
|
|
183
183
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
184
184
|
on crafting your system prompt.
|
|
185
185
|
source:
|
|
186
|
-
openapi:
|
|
186
|
+
openapi: evi-openapi.json
|
|
187
187
|
path-parameters:
|
|
188
188
|
id:
|
|
189
189
|
type: string
|
|
@@ -251,7 +251,7 @@ service:
|
|
|
251
251
|
create-prompt-version:
|
|
252
252
|
path: /v0/evi/prompts/{id}
|
|
253
253
|
method: POST
|
|
254
|
-
auth:
|
|
254
|
+
auth: false
|
|
255
255
|
docs: >-
|
|
256
256
|
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
257
257
|
|
|
@@ -260,7 +260,7 @@ service:
|
|
|
260
260
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
261
261
|
on crafting your system prompt.
|
|
262
262
|
source:
|
|
263
|
-
openapi:
|
|
263
|
+
openapi: evi-openapi.json
|
|
264
264
|
path-parameters:
|
|
265
265
|
id:
|
|
266
266
|
type: string
|
|
@@ -328,7 +328,7 @@ service:
|
|
|
328
328
|
delete-prompt:
|
|
329
329
|
path: /v0/evi/prompts/{id}
|
|
330
330
|
method: DELETE
|
|
331
|
-
auth:
|
|
331
|
+
auth: false
|
|
332
332
|
docs: >-
|
|
333
333
|
Deletes a **Prompt** and its versions.
|
|
334
334
|
|
|
@@ -337,7 +337,7 @@ service:
|
|
|
337
337
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
338
338
|
on crafting your system prompt.
|
|
339
339
|
source:
|
|
340
|
-
openapi:
|
|
340
|
+
openapi: evi-openapi.json
|
|
341
341
|
path-parameters:
|
|
342
342
|
id:
|
|
343
343
|
type: string
|
|
@@ -351,7 +351,7 @@ service:
|
|
|
351
351
|
update-prompt-name:
|
|
352
352
|
path: /v0/evi/prompts/{id}
|
|
353
353
|
method: PATCH
|
|
354
|
-
auth:
|
|
354
|
+
auth: false
|
|
355
355
|
docs: >-
|
|
356
356
|
Updates the name of a **Prompt**.
|
|
357
357
|
|
|
@@ -360,7 +360,7 @@ service:
|
|
|
360
360
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
361
361
|
on crafting your system prompt.
|
|
362
362
|
source:
|
|
363
|
-
openapi:
|
|
363
|
+
openapi: evi-openapi.json
|
|
364
364
|
path-parameters:
|
|
365
365
|
id:
|
|
366
366
|
type: string
|
|
@@ -388,7 +388,7 @@ service:
|
|
|
388
388
|
get-prompt-version:
|
|
389
389
|
path: /v0/evi/prompts/{id}/version/{version}
|
|
390
390
|
method: GET
|
|
391
|
-
auth:
|
|
391
|
+
auth: false
|
|
392
392
|
docs: >-
|
|
393
393
|
Fetches a specified version of a **Prompt**.
|
|
394
394
|
|
|
@@ -397,7 +397,7 @@ service:
|
|
|
397
397
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
398
398
|
on crafting your system prompt.
|
|
399
399
|
source:
|
|
400
|
-
openapi:
|
|
400
|
+
openapi: evi-openapi.json
|
|
401
401
|
path-parameters:
|
|
402
402
|
id:
|
|
403
403
|
type: string
|
|
@@ -447,7 +447,7 @@ service:
|
|
|
447
447
|
delete-prompt-version:
|
|
448
448
|
path: /v0/evi/prompts/{id}/version/{version}
|
|
449
449
|
method: DELETE
|
|
450
|
-
auth:
|
|
450
|
+
auth: false
|
|
451
451
|
docs: >-
|
|
452
452
|
Deletes a specified version of a **Prompt**.
|
|
453
453
|
|
|
@@ -456,7 +456,7 @@ service:
|
|
|
456
456
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
457
457
|
on crafting your system prompt.
|
|
458
458
|
source:
|
|
459
|
-
openapi:
|
|
459
|
+
openapi: evi-openapi.json
|
|
460
460
|
path-parameters:
|
|
461
461
|
id:
|
|
462
462
|
type: string
|
|
@@ -486,7 +486,7 @@ service:
|
|
|
486
486
|
update-prompt-description:
|
|
487
487
|
path: /v0/evi/prompts/{id}/version/{version}
|
|
488
488
|
method: PATCH
|
|
489
|
-
auth:
|
|
489
|
+
auth: false
|
|
490
490
|
docs: >-
|
|
491
491
|
Updates the description of a **Prompt**.
|
|
492
492
|
|
|
@@ -495,7 +495,7 @@ service:
|
|
|
495
495
|
guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips
|
|
496
496
|
on crafting your system prompt.
|
|
497
497
|
source:
|
|
498
|
-
openapi:
|
|
498
|
+
openapi: evi-openapi.json
|
|
499
499
|
path-parameters:
|
|
500
500
|
id:
|
|
501
501
|
type: string
|
|
@@ -553,4 +553,4 @@ service:
|
|
|
553
553
|
conditions, and any weather alerts. Include helpful tips if
|
|
554
554
|
severe weather is expected.</role>
|
|
555
555
|
source:
|
|
556
|
-
openapi:
|
|
556
|
+
openapi: evi-openapi.json
|