hume 0.15.3 → 0.15.5
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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/empathicVoice/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/empathicVoice/client/Client.js +8 -8
- package/dist/cjs/api/resources/empathicVoice/resources/chat/client/Client.js +1 -1
- package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.js +92 -92
- package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +18 -18
- package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +16 -16
- package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.js +9 -4
- package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.ts +24 -1
- package/dist/cjs/api/resources/empathicVoice/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/empathicVoice/types/JsonMessage.d.ts +31 -1
- package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedConfigPromptSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.d.ts +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.js +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChat.d.ts +11 -11
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +10 -10
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +16 -16
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +8 -8
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +27 -27
- package/dist/cjs/api/resources/empathicVoice/types/ReturnConfig.d.ts +20 -41
- package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPrompt.d.ts +12 -23
- package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +20 -20
- package/dist/cjs/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.d.ts +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.js +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/SubscribeEvent.d.ts +34 -1
- package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.js +7 -2
- package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tts/resources/voices/client/Client.js +7 -2
- package/dist/cjs/api/resources/tts/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/PostedTts.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/Snippet.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/Timestamp.d.ts +2 -0
- package/dist/cjs/core/websocket/ws.js +3 -2
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ErrorResponse.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedBuiltinTool.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedTimeoutSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedTimeoutSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookEventType.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnBuiltinTool.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChat.d.ts +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChat.js +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatEvent.js +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroup.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroup.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +12 -12
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnConfig.js +12 -12
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChats.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChats.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedConfigs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedPrompts.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +4 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPrompt.js +4 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookEventType.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookSpec.js +1 -1
- package/dist/cjs/serialization/resources/tts/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/serialization/resources/tts/types/ErrorResponse.js +1 -1
- package/dist/cjs/serialization/resources/tts/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/serialization/resources/tts/types/ReturnVoice.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/empathicVoice/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/empathicVoice/client/Client.mjs +8 -8
- package/dist/esm/api/resources/empathicVoice/resources/chat/client/Client.mjs +1 -1
- package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.mjs +92 -92
- package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +18 -18
- package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +16 -16
- package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs +9 -4
- package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.mts +24 -1
- package/dist/esm/api/resources/empathicVoice/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/api/resources/empathicVoice/types/JsonMessage.d.mts +31 -1
- package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinTool.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedConfigPromptSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.d.mts +1 -0
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.mjs +1 -0
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnChat.d.mts +11 -11
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.mts +10 -10
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatEvent.d.mts +16 -16
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroup.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +8 -8
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +27 -27
- package/dist/esm/api/resources/empathicVoice/types/ReturnConfig.d.mts +20 -41
- package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChats.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPrompt.d.mts +12 -23
- package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +20 -20
- package/dist/esm/api/resources/empathicVoice/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.d.mts +1 -0
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.mjs +1 -0
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/SubscribeEvent.d.mts +34 -1
- package/dist/esm/api/resources/tts/resources/streamInput/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tts/resources/streamInput/client/Client.mjs +7 -2
- package/dist/esm/api/resources/tts/resources/voices/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tts/resources/voices/client/Client.mjs +7 -2
- package/dist/esm/api/resources/tts/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/PostedTts.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/Snippet.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/Timestamp.d.mts +2 -0
- package/dist/esm/core/websocket/ws.mjs +3 -2
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ErrorResponse.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedBuiltinTool.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedBuiltinTool.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedTimeoutSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedTimeoutSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookEventType.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnBuiltinTool.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChat.d.mts +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChat.mjs +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatEvent.d.mts +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatEvent.mjs +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroup.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroup.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.mjs +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.mjs +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnConfig.d.mts +12 -12
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnConfig.mjs +12 -12
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChats.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChats.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedConfigs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedPrompts.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPrompt.d.mts +4 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPrompt.mjs +4 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookEventType.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookSpec.mjs +1 -1
- package/dist/esm/serialization/resources/tts/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/serialization/resources/tts/types/ErrorResponse.mjs +1 -1
- package/dist/esm/serialization/resources/tts/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/serialization/resources/tts/types/ReturnVoice.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +576 -576
package/reference.md
CHANGED
|
@@ -643,8 +643,8 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
643
643
|
</dl>
|
|
644
644
|
</details>
|
|
645
645
|
|
|
646
|
-
## EmpathicVoice
|
|
647
|
-
<details><summary><code>client.empathicVoice.
|
|
646
|
+
## EmpathicVoice ChatGroups
|
|
647
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
|
|
648
648
|
<dl>
|
|
649
649
|
<dd>
|
|
650
650
|
|
|
@@ -656,9 +656,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
656
656
|
<dl>
|
|
657
657
|
<dd>
|
|
658
658
|
|
|
659
|
-
Fetches a paginated list of **
|
|
660
|
-
|
|
661
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
659
|
+
Fetches a paginated list of **Chat Groups**.
|
|
662
660
|
</dd>
|
|
663
661
|
</dl>
|
|
664
662
|
</dd>
|
|
@@ -673,18 +671,22 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
673
671
|
<dd>
|
|
674
672
|
|
|
675
673
|
```typescript
|
|
676
|
-
const pageableResponse = await client.empathicVoice.
|
|
674
|
+
const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
|
|
677
675
|
pageNumber: 0,
|
|
678
|
-
pageSize:
|
|
676
|
+
pageSize: 1,
|
|
677
|
+
ascendingOrder: true,
|
|
678
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
679
679
|
});
|
|
680
680
|
for await (const item of pageableResponse) {
|
|
681
681
|
console.log(item);
|
|
682
682
|
}
|
|
683
683
|
|
|
684
684
|
// Or you can manually iterate page-by-page
|
|
685
|
-
let page = await client.empathicVoice.
|
|
685
|
+
let page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
686
686
|
pageNumber: 0,
|
|
687
|
-
pageSize:
|
|
687
|
+
pageSize: 1,
|
|
688
|
+
ascendingOrder: true,
|
|
689
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
688
690
|
});
|
|
689
691
|
while (page.hasNextPage()) {
|
|
690
692
|
page = page.getNextPage();
|
|
@@ -707,7 +709,7 @@ const response = page.response;
|
|
|
707
709
|
<dl>
|
|
708
710
|
<dd>
|
|
709
711
|
|
|
710
|
-
**request:** `Hume.empathicVoice.
|
|
712
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
711
713
|
|
|
712
714
|
</dd>
|
|
713
715
|
</dl>
|
|
@@ -715,7 +717,7 @@ const response = page.response;
|
|
|
715
717
|
<dl>
|
|
716
718
|
<dd>
|
|
717
719
|
|
|
718
|
-
**requestOptions:** `
|
|
720
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
719
721
|
|
|
720
722
|
</dd>
|
|
721
723
|
</dl>
|
|
@@ -727,7 +729,7 @@ const response = page.response;
|
|
|
727
729
|
</dl>
|
|
728
730
|
</details>
|
|
729
731
|
|
|
730
|
-
<details><summary><code>client.empathicVoice.
|
|
732
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getChatGroup</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedChats</code></summary>
|
|
731
733
|
<dl>
|
|
732
734
|
<dd>
|
|
733
735
|
|
|
@@ -739,9 +741,7 @@ const response = page.response;
|
|
|
739
741
|
<dl>
|
|
740
742
|
<dd>
|
|
741
743
|
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
744
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
745
745
|
</dd>
|
|
746
746
|
</dl>
|
|
747
747
|
</dd>
|
|
@@ -756,12 +756,10 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
756
756
|
<dd>
|
|
757
757
|
|
|
758
758
|
```typescript
|
|
759
|
-
await client.empathicVoice.
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
description: "This tool is for getting the current weather.",
|
|
764
|
-
fallbackContent: "Unable to fetch current weather."
|
|
759
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
760
|
+
pageNumber: 0,
|
|
761
|
+
pageSize: 1,
|
|
762
|
+
ascendingOrder: true
|
|
765
763
|
});
|
|
766
764
|
|
|
767
765
|
```
|
|
@@ -778,7 +776,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
778
776
|
<dl>
|
|
779
777
|
<dd>
|
|
780
778
|
|
|
781
|
-
**
|
|
779
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
782
780
|
|
|
783
781
|
</dd>
|
|
784
782
|
</dl>
|
|
@@ -786,7 +784,15 @@ await client.empathicVoice.tools.createTool({
|
|
|
786
784
|
<dl>
|
|
787
785
|
<dd>
|
|
788
786
|
|
|
789
|
-
**
|
|
787
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
788
|
+
|
|
789
|
+
</dd>
|
|
790
|
+
</dl>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
790
796
|
|
|
791
797
|
</dd>
|
|
792
798
|
</dl>
|
|
@@ -798,7 +804,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
798
804
|
</dl>
|
|
799
805
|
</details>
|
|
800
806
|
|
|
801
|
-
<details><summary><code>client.empathicVoice.
|
|
807
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">getAudio</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedAudioReconstructions</code></summary>
|
|
802
808
|
<dl>
|
|
803
809
|
<dd>
|
|
804
810
|
|
|
@@ -810,9 +816,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
810
816
|
<dl>
|
|
811
817
|
<dd>
|
|
812
818
|
|
|
813
|
-
Fetches a list of
|
|
814
|
-
|
|
815
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
819
|
+
Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
816
820
|
</dd>
|
|
817
821
|
</dl>
|
|
818
822
|
</dd>
|
|
@@ -827,19 +831,11 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
827
831
|
<dd>
|
|
828
832
|
|
|
829
833
|
```typescript
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
// Or you can manually iterate page-by-page
|
|
836
|
-
let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
837
|
-
while (page.hasNextPage()) {
|
|
838
|
-
page = page.getNextPage();
|
|
839
|
-
}
|
|
840
|
-
|
|
841
|
-
// You can also access the underlying response
|
|
842
|
-
const response = page.response;
|
|
834
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
835
|
+
pageNumber: 0,
|
|
836
|
+
pageSize: 10,
|
|
837
|
+
ascendingOrder: true
|
|
838
|
+
});
|
|
843
839
|
|
|
844
840
|
```
|
|
845
841
|
</dd>
|
|
@@ -855,7 +851,7 @@ const response = page.response;
|
|
|
855
851
|
<dl>
|
|
856
852
|
<dd>
|
|
857
853
|
|
|
858
|
-
**id:** `string` — Identifier for a
|
|
854
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
859
855
|
|
|
860
856
|
</dd>
|
|
861
857
|
</dl>
|
|
@@ -863,7 +859,7 @@ const response = page.response;
|
|
|
863
859
|
<dl>
|
|
864
860
|
<dd>
|
|
865
861
|
|
|
866
|
-
**request:** `Hume.empathicVoice.
|
|
862
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
867
863
|
|
|
868
864
|
</dd>
|
|
869
865
|
</dl>
|
|
@@ -871,7 +867,7 @@ const response = page.response;
|
|
|
871
867
|
<dl>
|
|
872
868
|
<dd>
|
|
873
869
|
|
|
874
|
-
**requestOptions:** `
|
|
870
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
875
871
|
|
|
876
872
|
</dd>
|
|
877
873
|
</dl>
|
|
@@ -883,7 +879,7 @@ const response = page.response;
|
|
|
883
879
|
</dl>
|
|
884
880
|
</details>
|
|
885
881
|
|
|
886
|
-
<details><summary><code>client.empathicVoice.
|
|
882
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatGroupPagedEvents></code></summary>
|
|
887
883
|
<dl>
|
|
888
884
|
<dd>
|
|
889
885
|
|
|
@@ -895,9 +891,7 @@ const response = page.response;
|
|
|
895
891
|
<dl>
|
|
896
892
|
<dd>
|
|
897
893
|
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
894
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
901
895
|
</dd>
|
|
902
896
|
</dl>
|
|
903
897
|
</dd>
|
|
@@ -912,12 +906,27 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
912
906
|
<dd>
|
|
913
907
|
|
|
914
908
|
```typescript
|
|
915
|
-
await client.empathicVoice.
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
909
|
+
const pageableResponse = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
910
|
+
pageNumber: 0,
|
|
911
|
+
pageSize: 3,
|
|
912
|
+
ascendingOrder: true
|
|
913
|
+
});
|
|
914
|
+
for await (const item of pageableResponse) {
|
|
915
|
+
console.log(item);
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
// Or you can manually iterate page-by-page
|
|
919
|
+
let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
920
|
+
pageNumber: 0,
|
|
921
|
+
pageSize: 3,
|
|
922
|
+
ascendingOrder: true
|
|
920
923
|
});
|
|
924
|
+
while (page.hasNextPage()) {
|
|
925
|
+
page = page.getNextPage();
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
// You can also access the underlying response
|
|
929
|
+
const response = page.response;
|
|
921
930
|
|
|
922
931
|
```
|
|
923
932
|
</dd>
|
|
@@ -933,7 +942,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
933
942
|
<dl>
|
|
934
943
|
<dd>
|
|
935
944
|
|
|
936
|
-
**id:** `string` — Identifier for a
|
|
945
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
937
946
|
|
|
938
947
|
</dd>
|
|
939
948
|
</dl>
|
|
@@ -941,7 +950,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
941
950
|
<dl>
|
|
942
951
|
<dd>
|
|
943
952
|
|
|
944
|
-
**request:** `Hume.empathicVoice.
|
|
953
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
945
954
|
|
|
946
955
|
</dd>
|
|
947
956
|
</dl>
|
|
@@ -949,7 +958,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
949
958
|
<dl>
|
|
950
959
|
<dd>
|
|
951
960
|
|
|
952
|
-
**requestOptions:** `
|
|
961
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
953
962
|
|
|
954
963
|
</dd>
|
|
955
964
|
</dl>
|
|
@@ -961,7 +970,8 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
961
970
|
</dl>
|
|
962
971
|
</details>
|
|
963
972
|
|
|
964
|
-
|
|
973
|
+
## EmpathicVoice Chats
|
|
974
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
|
|
965
975
|
<dl>
|
|
966
976
|
<dd>
|
|
967
977
|
|
|
@@ -973,9 +983,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
973
983
|
<dl>
|
|
974
984
|
<dd>
|
|
975
985
|
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
986
|
+
Fetches a paginated list of **Chats**.
|
|
979
987
|
</dd>
|
|
980
988
|
</dl>
|
|
981
989
|
</dd>
|
|
@@ -990,7 +998,27 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
990
998
|
<dd>
|
|
991
999
|
|
|
992
1000
|
```typescript
|
|
993
|
-
await client.empathicVoice.
|
|
1001
|
+
const pageableResponse = await client.empathicVoice.chats.listChats({
|
|
1002
|
+
pageNumber: 0,
|
|
1003
|
+
pageSize: 1,
|
|
1004
|
+
ascendingOrder: true
|
|
1005
|
+
});
|
|
1006
|
+
for await (const item of pageableResponse) {
|
|
1007
|
+
console.log(item);
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
// Or you can manually iterate page-by-page
|
|
1011
|
+
let page = await client.empathicVoice.chats.listChats({
|
|
1012
|
+
pageNumber: 0,
|
|
1013
|
+
pageSize: 1,
|
|
1014
|
+
ascendingOrder: true
|
|
1015
|
+
});
|
|
1016
|
+
while (page.hasNextPage()) {
|
|
1017
|
+
page = page.getNextPage();
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
// You can also access the underlying response
|
|
1021
|
+
const response = page.response;
|
|
994
1022
|
|
|
995
1023
|
```
|
|
996
1024
|
</dd>
|
|
@@ -1006,7 +1034,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
1006
1034
|
<dl>
|
|
1007
1035
|
<dd>
|
|
1008
1036
|
|
|
1009
|
-
**
|
|
1037
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
1010
1038
|
|
|
1011
1039
|
</dd>
|
|
1012
1040
|
</dl>
|
|
@@ -1014,7 +1042,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
1014
1042
|
<dl>
|
|
1015
1043
|
<dd>
|
|
1016
1044
|
|
|
1017
|
-
**requestOptions:** `
|
|
1045
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1018
1046
|
|
|
1019
1047
|
</dd>
|
|
1020
1048
|
</dl>
|
|
@@ -1026,7 +1054,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
1026
1054
|
</dl>
|
|
1027
1055
|
</details>
|
|
1028
1056
|
|
|
1029
|
-
<details><summary><code>client.empathicVoice.
|
|
1057
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChatEvents</a>(id, { ...params }) -> core.Page<Hume.ReturnChatEvent, Hume.ReturnChatPagedEvents></code></summary>
|
|
1030
1058
|
<dl>
|
|
1031
1059
|
<dd>
|
|
1032
1060
|
|
|
@@ -1038,9 +1066,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
1038
1066
|
<dl>
|
|
1039
1067
|
<dd>
|
|
1040
1068
|
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1069
|
+
Fetches a paginated list of **Chat** events.
|
|
1044
1070
|
</dd>
|
|
1045
1071
|
</dl>
|
|
1046
1072
|
</dd>
|
|
@@ -1055,9 +1081,27 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
1055
1081
|
<dd>
|
|
1056
1082
|
|
|
1057
1083
|
```typescript
|
|
1058
|
-
await client.empathicVoice.
|
|
1059
|
-
|
|
1084
|
+
const pageableResponse = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
1085
|
+
pageNumber: 0,
|
|
1086
|
+
pageSize: 3,
|
|
1087
|
+
ascendingOrder: true
|
|
1088
|
+
});
|
|
1089
|
+
for await (const item of pageableResponse) {
|
|
1090
|
+
console.log(item);
|
|
1091
|
+
}
|
|
1092
|
+
|
|
1093
|
+
// Or you can manually iterate page-by-page
|
|
1094
|
+
let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
1095
|
+
pageNumber: 0,
|
|
1096
|
+
pageSize: 3,
|
|
1097
|
+
ascendingOrder: true
|
|
1060
1098
|
});
|
|
1099
|
+
while (page.hasNextPage()) {
|
|
1100
|
+
page = page.getNextPage();
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
// You can also access the underlying response
|
|
1104
|
+
const response = page.response;
|
|
1061
1105
|
|
|
1062
1106
|
```
|
|
1063
1107
|
</dd>
|
|
@@ -1073,7 +1117,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1073
1117
|
<dl>
|
|
1074
1118
|
<dd>
|
|
1075
1119
|
|
|
1076
|
-
**id:** `string` — Identifier for a
|
|
1120
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
1077
1121
|
|
|
1078
1122
|
</dd>
|
|
1079
1123
|
</dl>
|
|
@@ -1081,7 +1125,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1081
1125
|
<dl>
|
|
1082
1126
|
<dd>
|
|
1083
1127
|
|
|
1084
|
-
**request:** `Hume.empathicVoice.
|
|
1128
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
1085
1129
|
|
|
1086
1130
|
</dd>
|
|
1087
1131
|
</dl>
|
|
@@ -1089,7 +1133,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1089
1133
|
<dl>
|
|
1090
1134
|
<dd>
|
|
1091
1135
|
|
|
1092
|
-
**requestOptions:** `
|
|
1136
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1093
1137
|
|
|
1094
1138
|
</dd>
|
|
1095
1139
|
</dl>
|
|
@@ -1101,7 +1145,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1101
1145
|
</dl>
|
|
1102
1146
|
</details>
|
|
1103
1147
|
|
|
1104
|
-
<details><summary><code>client.empathicVoice.
|
|
1148
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
|
|
1105
1149
|
<dl>
|
|
1106
1150
|
<dd>
|
|
1107
1151
|
|
|
@@ -1113,9 +1157,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1113
1157
|
<dl>
|
|
1114
1158
|
<dd>
|
|
1115
1159
|
|
|
1116
|
-
Fetches
|
|
1117
|
-
|
|
1118
|
-
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
1160
|
+
Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
1119
1161
|
</dd>
|
|
1120
1162
|
</dl>
|
|
1121
1163
|
</dd>
|
|
@@ -1130,7 +1172,7 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
1130
1172
|
<dd>
|
|
1131
1173
|
|
|
1132
1174
|
```typescript
|
|
1133
|
-
await client.empathicVoice.
|
|
1175
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
1134
1176
|
|
|
1135
1177
|
```
|
|
1136
1178
|
</dd>
|
|
@@ -1146,21 +1188,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1146
1188
|
<dl>
|
|
1147
1189
|
<dd>
|
|
1148
1190
|
|
|
1149
|
-
**id:** `string` — Identifier for a
|
|
1150
|
-
|
|
1151
|
-
</dd>
|
|
1152
|
-
</dl>
|
|
1153
|
-
|
|
1154
|
-
<dl>
|
|
1155
|
-
<dd>
|
|
1156
|
-
|
|
1157
|
-
**version:** `number`
|
|
1158
|
-
|
|
1159
|
-
Version number for a Tool.
|
|
1160
|
-
|
|
1161
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1162
|
-
|
|
1163
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1191
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
1164
1192
|
|
|
1165
1193
|
</dd>
|
|
1166
1194
|
</dl>
|
|
@@ -1168,7 +1196,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1168
1196
|
<dl>
|
|
1169
1197
|
<dd>
|
|
1170
1198
|
|
|
1171
|
-
**requestOptions:** `
|
|
1199
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1172
1200
|
|
|
1173
1201
|
</dd>
|
|
1174
1202
|
</dl>
|
|
@@ -1180,7 +1208,8 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1180
1208
|
</dl>
|
|
1181
1209
|
</details>
|
|
1182
1210
|
|
|
1183
|
-
|
|
1211
|
+
## EmpathicVoice Configs
|
|
1212
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
|
|
1184
1213
|
<dl>
|
|
1185
1214
|
<dd>
|
|
1186
1215
|
|
|
@@ -1192,9 +1221,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1192
1221
|
<dl>
|
|
1193
1222
|
<dd>
|
|
1194
1223
|
|
|
1195
|
-
|
|
1224
|
+
Fetches a paginated list of **Configs**.
|
|
1196
1225
|
|
|
1197
|
-
|
|
1226
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1198
1227
|
</dd>
|
|
1199
1228
|
</dl>
|
|
1200
1229
|
</dd>
|
|
@@ -1209,7 +1238,25 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
1209
1238
|
<dd>
|
|
1210
1239
|
|
|
1211
1240
|
```typescript
|
|
1212
|
-
await client.empathicVoice.
|
|
1241
|
+
const pageableResponse = await client.empathicVoice.configs.listConfigs({
|
|
1242
|
+
pageNumber: 0,
|
|
1243
|
+
pageSize: 1
|
|
1244
|
+
});
|
|
1245
|
+
for await (const item of pageableResponse) {
|
|
1246
|
+
console.log(item);
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1249
|
+
// Or you can manually iterate page-by-page
|
|
1250
|
+
let page = await client.empathicVoice.configs.listConfigs({
|
|
1251
|
+
pageNumber: 0,
|
|
1252
|
+
pageSize: 1
|
|
1253
|
+
});
|
|
1254
|
+
while (page.hasNextPage()) {
|
|
1255
|
+
page = page.getNextPage();
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
// You can also access the underlying response
|
|
1259
|
+
const response = page.response;
|
|
1213
1260
|
|
|
1214
1261
|
```
|
|
1215
1262
|
</dd>
|
|
@@ -1225,7 +1272,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
1225
1272
|
<dl>
|
|
1226
1273
|
<dd>
|
|
1227
1274
|
|
|
1228
|
-
**
|
|
1275
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
1229
1276
|
|
|
1230
1277
|
</dd>
|
|
1231
1278
|
</dl>
|
|
@@ -1233,33 +1280,19 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
1233
1280
|
<dl>
|
|
1234
1281
|
<dd>
|
|
1235
1282
|
|
|
1236
|
-
**
|
|
1237
|
-
|
|
1238
|
-
|
|
1283
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1284
|
+
|
|
1285
|
+
</dd>
|
|
1286
|
+
</dl>
|
|
1287
|
+
</dd>
|
|
1288
|
+
</dl>
|
|
1239
1289
|
|
|
1240
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1241
1290
|
|
|
1242
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1243
|
-
|
|
1244
1291
|
</dd>
|
|
1245
1292
|
</dl>
|
|
1293
|
+
</details>
|
|
1246
1294
|
|
|
1247
|
-
<
|
|
1248
|
-
<dd>
|
|
1249
|
-
|
|
1250
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
1251
|
-
|
|
1252
|
-
</dd>
|
|
1253
|
-
</dl>
|
|
1254
|
-
</dd>
|
|
1255
|
-
</dl>
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
</dd>
|
|
1259
|
-
</dl>
|
|
1260
|
-
</details>
|
|
1261
|
-
|
|
1262
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
1295
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1263
1296
|
<dl>
|
|
1264
1297
|
<dd>
|
|
1265
1298
|
|
|
@@ -1271,9 +1304,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1271
1304
|
<dl>
|
|
1272
1305
|
<dd>
|
|
1273
1306
|
|
|
1274
|
-
|
|
1307
|
+
Creates a **Config** which can be applied to EVI.
|
|
1275
1308
|
|
|
1276
|
-
|
|
1309
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1277
1310
|
</dd>
|
|
1278
1311
|
</dl>
|
|
1279
1312
|
</dd>
|
|
@@ -1288,8 +1321,36 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
1288
1321
|
<dd>
|
|
1289
1322
|
|
|
1290
1323
|
```typescript
|
|
1291
|
-
await client.empathicVoice.
|
|
1292
|
-
|
|
1324
|
+
await client.empathicVoice.configs.createConfig({
|
|
1325
|
+
name: "Weather Assistant Config",
|
|
1326
|
+
prompt: {
|
|
1327
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1328
|
+
version: 0
|
|
1329
|
+
},
|
|
1330
|
+
eviVersion: "3",
|
|
1331
|
+
voice: {
|
|
1332
|
+
provider: "HUME_AI",
|
|
1333
|
+
name: "Ava Song"
|
|
1334
|
+
},
|
|
1335
|
+
languageModel: {
|
|
1336
|
+
modelProvider: "ANTHROPIC",
|
|
1337
|
+
modelResource: "claude-3-7-sonnet-latest",
|
|
1338
|
+
temperature: 1
|
|
1339
|
+
},
|
|
1340
|
+
eventMessages: {
|
|
1341
|
+
onNewChat: {
|
|
1342
|
+
enabled: false,
|
|
1343
|
+
text: ""
|
|
1344
|
+
},
|
|
1345
|
+
onInactivityTimeout: {
|
|
1346
|
+
enabled: false,
|
|
1347
|
+
text: ""
|
|
1348
|
+
},
|
|
1349
|
+
onMaxDurationTimeout: {
|
|
1350
|
+
enabled: false,
|
|
1351
|
+
text: ""
|
|
1352
|
+
}
|
|
1353
|
+
}
|
|
1293
1354
|
});
|
|
1294
1355
|
|
|
1295
1356
|
```
|
|
@@ -1306,29 +1367,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
1306
1367
|
<dl>
|
|
1307
1368
|
<dd>
|
|
1308
1369
|
|
|
1309
|
-
**
|
|
1310
|
-
|
|
1311
|
-
</dd>
|
|
1312
|
-
</dl>
|
|
1313
|
-
|
|
1314
|
-
<dl>
|
|
1315
|
-
<dd>
|
|
1316
|
-
|
|
1317
|
-
**version:** `number`
|
|
1318
|
-
|
|
1319
|
-
Version number for a Tool.
|
|
1320
|
-
|
|
1321
|
-
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1322
|
-
|
|
1323
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1324
|
-
|
|
1325
|
-
</dd>
|
|
1326
|
-
</dl>
|
|
1327
|
-
|
|
1328
|
-
<dl>
|
|
1329
|
-
<dd>
|
|
1330
|
-
|
|
1331
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
1370
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
1332
1371
|
|
|
1333
1372
|
</dd>
|
|
1334
1373
|
</dl>
|
|
@@ -1336,7 +1375,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1336
1375
|
<dl>
|
|
1337
1376
|
<dd>
|
|
1338
1377
|
|
|
1339
|
-
**requestOptions:** `
|
|
1378
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1340
1379
|
|
|
1341
1380
|
</dd>
|
|
1342
1381
|
</dl>
|
|
@@ -1348,8 +1387,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1348
1387
|
</dl>
|
|
1349
1388
|
</details>
|
|
1350
1389
|
|
|
1351
|
-
|
|
1352
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts></code></summary>
|
|
1390
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
|
|
1353
1391
|
<dl>
|
|
1354
1392
|
<dd>
|
|
1355
1393
|
|
|
@@ -1361,9 +1399,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1361
1399
|
<dl>
|
|
1362
1400
|
<dd>
|
|
1363
1401
|
|
|
1364
|
-
Fetches a
|
|
1402
|
+
Fetches a list of a **Config's** versions.
|
|
1365
1403
|
|
|
1366
|
-
|
|
1404
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1367
1405
|
</dd>
|
|
1368
1406
|
</dl>
|
|
1369
1407
|
</dd>
|
|
@@ -1378,19 +1416,13 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1378
1416
|
<dd>
|
|
1379
1417
|
|
|
1380
1418
|
```typescript
|
|
1381
|
-
const pageableResponse = await client.empathicVoice.
|
|
1382
|
-
pageNumber: 0,
|
|
1383
|
-
pageSize: 2
|
|
1384
|
-
});
|
|
1419
|
+
const pageableResponse = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1385
1420
|
for await (const item of pageableResponse) {
|
|
1386
1421
|
console.log(item);
|
|
1387
1422
|
}
|
|
1388
1423
|
|
|
1389
1424
|
// Or you can manually iterate page-by-page
|
|
1390
|
-
let page = await client.empathicVoice.
|
|
1391
|
-
pageNumber: 0,
|
|
1392
|
-
pageSize: 2
|
|
1393
|
-
});
|
|
1425
|
+
let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1394
1426
|
while (page.hasNextPage()) {
|
|
1395
1427
|
page = page.getNextPage();
|
|
1396
1428
|
}
|
|
@@ -1412,7 +1444,7 @@ const response = page.response;
|
|
|
1412
1444
|
<dl>
|
|
1413
1445
|
<dd>
|
|
1414
1446
|
|
|
1415
|
-
**
|
|
1447
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1416
1448
|
|
|
1417
1449
|
</dd>
|
|
1418
1450
|
</dl>
|
|
@@ -1420,7 +1452,15 @@ const response = page.response;
|
|
|
1420
1452
|
<dl>
|
|
1421
1453
|
<dd>
|
|
1422
1454
|
|
|
1423
|
-
**
|
|
1455
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
1456
|
+
|
|
1457
|
+
</dd>
|
|
1458
|
+
</dl>
|
|
1459
|
+
|
|
1460
|
+
<dl>
|
|
1461
|
+
<dd>
|
|
1462
|
+
|
|
1463
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1424
1464
|
|
|
1425
1465
|
</dd>
|
|
1426
1466
|
</dl>
|
|
@@ -1432,7 +1472,7 @@ const response = page.response;
|
|
|
1432
1472
|
</dl>
|
|
1433
1473
|
</details>
|
|
1434
1474
|
|
|
1435
|
-
<details><summary><code>client.empathicVoice.
|
|
1475
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1436
1476
|
<dl>
|
|
1437
1477
|
<dd>
|
|
1438
1478
|
|
|
@@ -1444,9 +1484,9 @@ const response = page.response;
|
|
|
1444
1484
|
<dl>
|
|
1445
1485
|
<dd>
|
|
1446
1486
|
|
|
1447
|
-
|
|
1487
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
1448
1488
|
|
|
1449
|
-
|
|
1489
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1450
1490
|
</dd>
|
|
1451
1491
|
</dl>
|
|
1452
1492
|
</dd>
|
|
@@ -1461,9 +1501,39 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1461
1501
|
<dd>
|
|
1462
1502
|
|
|
1463
1503
|
```typescript
|
|
1464
|
-
await client.empathicVoice.
|
|
1465
|
-
|
|
1466
|
-
|
|
1504
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
1505
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
1506
|
+
eviVersion: "3",
|
|
1507
|
+
prompt: {
|
|
1508
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
1509
|
+
version: 0
|
|
1510
|
+
},
|
|
1511
|
+
voice: {
|
|
1512
|
+
provider: "HUME_AI",
|
|
1513
|
+
name: "Ava Song"
|
|
1514
|
+
},
|
|
1515
|
+
languageModel: {
|
|
1516
|
+
modelProvider: "ANTHROPIC",
|
|
1517
|
+
modelResource: "claude-3-7-sonnet-latest",
|
|
1518
|
+
temperature: 1
|
|
1519
|
+
},
|
|
1520
|
+
ellmModel: {
|
|
1521
|
+
allowShortResponses: true
|
|
1522
|
+
},
|
|
1523
|
+
eventMessages: {
|
|
1524
|
+
onNewChat: {
|
|
1525
|
+
enabled: false,
|
|
1526
|
+
text: ""
|
|
1527
|
+
},
|
|
1528
|
+
onInactivityTimeout: {
|
|
1529
|
+
enabled: false,
|
|
1530
|
+
text: ""
|
|
1531
|
+
},
|
|
1532
|
+
onMaxDurationTimeout: {
|
|
1533
|
+
enabled: false,
|
|
1534
|
+
text: ""
|
|
1535
|
+
}
|
|
1536
|
+
}
|
|
1467
1537
|
});
|
|
1468
1538
|
|
|
1469
1539
|
```
|
|
@@ -1480,7 +1550,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1480
1550
|
<dl>
|
|
1481
1551
|
<dd>
|
|
1482
1552
|
|
|
1483
|
-
**
|
|
1553
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1484
1554
|
|
|
1485
1555
|
</dd>
|
|
1486
1556
|
</dl>
|
|
@@ -1488,7 +1558,15 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1488
1558
|
<dl>
|
|
1489
1559
|
<dd>
|
|
1490
1560
|
|
|
1491
|
-
**
|
|
1561
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
1562
|
+
|
|
1563
|
+
</dd>
|
|
1564
|
+
</dl>
|
|
1565
|
+
|
|
1566
|
+
<dl>
|
|
1567
|
+
<dd>
|
|
1568
|
+
|
|
1569
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1492
1570
|
|
|
1493
1571
|
</dd>
|
|
1494
1572
|
</dl>
|
|
@@ -1500,7 +1578,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1500
1578
|
</dl>
|
|
1501
1579
|
</details>
|
|
1502
1580
|
|
|
1503
|
-
<details><summary><code>client.empathicVoice.
|
|
1581
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
1504
1582
|
<dl>
|
|
1505
1583
|
<dd>
|
|
1506
1584
|
|
|
@@ -1512,9 +1590,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1512
1590
|
<dl>
|
|
1513
1591
|
<dd>
|
|
1514
1592
|
|
|
1515
|
-
|
|
1593
|
+
Deletes a **Config** and its versions.
|
|
1516
1594
|
|
|
1517
|
-
|
|
1595
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1518
1596
|
</dd>
|
|
1519
1597
|
</dl>
|
|
1520
1598
|
</dd>
|
|
@@ -1529,7 +1607,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1529
1607
|
<dd>
|
|
1530
1608
|
|
|
1531
1609
|
```typescript
|
|
1532
|
-
await client.empathicVoice.
|
|
1610
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
1533
1611
|
|
|
1534
1612
|
```
|
|
1535
1613
|
</dd>
|
|
@@ -1545,15 +1623,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1545
1623
|
<dl>
|
|
1546
1624
|
<dd>
|
|
1547
1625
|
|
|
1548
|
-
**id:** `string` — Identifier for a
|
|
1549
|
-
|
|
1550
|
-
</dd>
|
|
1551
|
-
</dl>
|
|
1552
|
-
|
|
1553
|
-
<dl>
|
|
1554
|
-
<dd>
|
|
1555
|
-
|
|
1556
|
-
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1626
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1557
1627
|
|
|
1558
1628
|
</dd>
|
|
1559
1629
|
</dl>
|
|
@@ -1561,7 +1631,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1561
1631
|
<dl>
|
|
1562
1632
|
<dd>
|
|
1563
1633
|
|
|
1564
|
-
**requestOptions:** `
|
|
1634
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1565
1635
|
|
|
1566
1636
|
</dd>
|
|
1567
1637
|
</dl>
|
|
@@ -1573,7 +1643,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1573
1643
|
</dl>
|
|
1574
1644
|
</details>
|
|
1575
1645
|
|
|
1576
|
-
<details><summary><code>client.empathicVoice.
|
|
1646
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
1577
1647
|
<dl>
|
|
1578
1648
|
<dd>
|
|
1579
1649
|
|
|
@@ -1585,9 +1655,9 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1585
1655
|
<dl>
|
|
1586
1656
|
<dd>
|
|
1587
1657
|
|
|
1588
|
-
Updates
|
|
1658
|
+
Updates the name of a **Config**.
|
|
1589
1659
|
|
|
1590
|
-
|
|
1660
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1591
1661
|
</dd>
|
|
1592
1662
|
</dl>
|
|
1593
1663
|
</dd>
|
|
@@ -1602,9 +1672,8 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1602
1672
|
<dd>
|
|
1603
1673
|
|
|
1604
1674
|
```typescript
|
|
1605
|
-
await client.empathicVoice.
|
|
1606
|
-
|
|
1607
|
-
versionDescription: "This is an updated version of the Weather Assistant Prompt."
|
|
1675
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
1676
|
+
name: "Updated Weather Assistant Config Name"
|
|
1608
1677
|
});
|
|
1609
1678
|
|
|
1610
1679
|
```
|
|
@@ -1621,7 +1690,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1621
1690
|
<dl>
|
|
1622
1691
|
<dd>
|
|
1623
1692
|
|
|
1624
|
-
**id:** `string` — Identifier for a
|
|
1693
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1625
1694
|
|
|
1626
1695
|
</dd>
|
|
1627
1696
|
</dl>
|
|
@@ -1629,7 +1698,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1629
1698
|
<dl>
|
|
1630
1699
|
<dd>
|
|
1631
1700
|
|
|
1632
|
-
**request:** `Hume.empathicVoice.
|
|
1701
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
1633
1702
|
|
|
1634
1703
|
</dd>
|
|
1635
1704
|
</dl>
|
|
@@ -1637,7 +1706,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1637
1706
|
<dl>
|
|
1638
1707
|
<dd>
|
|
1639
1708
|
|
|
1640
|
-
**requestOptions:** `
|
|
1709
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1641
1710
|
|
|
1642
1711
|
</dd>
|
|
1643
1712
|
</dl>
|
|
@@ -1649,7 +1718,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1649
1718
|
</dl>
|
|
1650
1719
|
</details>
|
|
1651
1720
|
|
|
1652
|
-
<details><summary><code>client.empathicVoice.
|
|
1721
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
|
|
1653
1722
|
<dl>
|
|
1654
1723
|
<dd>
|
|
1655
1724
|
|
|
@@ -1661,9 +1730,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1661
1730
|
<dl>
|
|
1662
1731
|
<dd>
|
|
1663
1732
|
|
|
1664
|
-
|
|
1733
|
+
Fetches a specified version of a **Config**.
|
|
1665
1734
|
|
|
1666
|
-
|
|
1735
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1667
1736
|
</dd>
|
|
1668
1737
|
</dl>
|
|
1669
1738
|
</dd>
|
|
@@ -1678,7 +1747,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1678
1747
|
<dd>
|
|
1679
1748
|
|
|
1680
1749
|
```typescript
|
|
1681
|
-
await client.empathicVoice.
|
|
1750
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
1682
1751
|
|
|
1683
1752
|
```
|
|
1684
1753
|
</dd>
|
|
@@ -1694,7 +1763,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1694
1763
|
<dl>
|
|
1695
1764
|
<dd>
|
|
1696
1765
|
|
|
1697
|
-
**id:** `string` — Identifier for a
|
|
1766
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1698
1767
|
|
|
1699
1768
|
</dd>
|
|
1700
1769
|
</dl>
|
|
@@ -1702,7 +1771,21 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1702
1771
|
<dl>
|
|
1703
1772
|
<dd>
|
|
1704
1773
|
|
|
1705
|
-
**
|
|
1774
|
+
**version:** `number`
|
|
1775
|
+
|
|
1776
|
+
Version number for a Config.
|
|
1777
|
+
|
|
1778
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1779
|
+
|
|
1780
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1781
|
+
|
|
1782
|
+
</dd>
|
|
1783
|
+
</dl>
|
|
1784
|
+
|
|
1785
|
+
<dl>
|
|
1786
|
+
<dd>
|
|
1787
|
+
|
|
1788
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1706
1789
|
|
|
1707
1790
|
</dd>
|
|
1708
1791
|
</dl>
|
|
@@ -1714,7 +1797,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1714
1797
|
</dl>
|
|
1715
1798
|
</details>
|
|
1716
1799
|
|
|
1717
|
-
<details><summary><code>client.empathicVoice.
|
|
1800
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
1718
1801
|
<dl>
|
|
1719
1802
|
<dd>
|
|
1720
1803
|
|
|
@@ -1726,9 +1809,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1726
1809
|
<dl>
|
|
1727
1810
|
<dd>
|
|
1728
1811
|
|
|
1729
|
-
|
|
1812
|
+
Deletes a specified version of a **Config**.
|
|
1730
1813
|
|
|
1731
|
-
|
|
1814
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1732
1815
|
</dd>
|
|
1733
1816
|
</dl>
|
|
1734
1817
|
</dd>
|
|
@@ -1743,9 +1826,7 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1743
1826
|
<dd>
|
|
1744
1827
|
|
|
1745
1828
|
```typescript
|
|
1746
|
-
await client.empathicVoice.
|
|
1747
|
-
name: "Updated Weather Assistant Prompt Name"
|
|
1748
|
-
});
|
|
1829
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
1749
1830
|
|
|
1750
1831
|
```
|
|
1751
1832
|
</dd>
|
|
@@ -1761,7 +1842,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1761
1842
|
<dl>
|
|
1762
1843
|
<dd>
|
|
1763
1844
|
|
|
1764
|
-
**id:** `string` — Identifier for a
|
|
1845
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1765
1846
|
|
|
1766
1847
|
</dd>
|
|
1767
1848
|
</dl>
|
|
@@ -1769,7 +1850,13 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1769
1850
|
<dl>
|
|
1770
1851
|
<dd>
|
|
1771
1852
|
|
|
1772
|
-
**
|
|
1853
|
+
**version:** `number`
|
|
1854
|
+
|
|
1855
|
+
Version number for a Config.
|
|
1856
|
+
|
|
1857
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1858
|
+
|
|
1859
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1773
1860
|
|
|
1774
1861
|
</dd>
|
|
1775
1862
|
</dl>
|
|
@@ -1777,7 +1864,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1777
1864
|
<dl>
|
|
1778
1865
|
<dd>
|
|
1779
1866
|
|
|
1780
|
-
**requestOptions:** `
|
|
1867
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1781
1868
|
|
|
1782
1869
|
</dd>
|
|
1783
1870
|
</dl>
|
|
@@ -1789,7 +1876,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1789
1876
|
</dl>
|
|
1790
1877
|
</details>
|
|
1791
1878
|
|
|
1792
|
-
<details><summary><code>client.empathicVoice.
|
|
1879
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
1793
1880
|
<dl>
|
|
1794
1881
|
<dd>
|
|
1795
1882
|
|
|
@@ -1801,9 +1888,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1801
1888
|
<dl>
|
|
1802
1889
|
<dd>
|
|
1803
1890
|
|
|
1804
|
-
|
|
1891
|
+
Updates the description of a **Config**.
|
|
1805
1892
|
|
|
1806
|
-
|
|
1893
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration).
|
|
1807
1894
|
</dd>
|
|
1808
1895
|
</dl>
|
|
1809
1896
|
</dd>
|
|
@@ -1818,7 +1905,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1818
1905
|
<dd>
|
|
1819
1906
|
|
|
1820
1907
|
```typescript
|
|
1821
|
-
await client.empathicVoice.
|
|
1908
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
1909
|
+
versionDescription: "This is an updated version_description."
|
|
1910
|
+
});
|
|
1822
1911
|
|
|
1823
1912
|
```
|
|
1824
1913
|
</dd>
|
|
@@ -1834,7 +1923,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1834
1923
|
<dl>
|
|
1835
1924
|
<dd>
|
|
1836
1925
|
|
|
1837
|
-
**id:** `string` — Identifier for a
|
|
1926
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
1838
1927
|
|
|
1839
1928
|
</dd>
|
|
1840
1929
|
</dl>
|
|
@@ -1844,11 +1933,11 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1844
1933
|
|
|
1845
1934
|
**version:** `number`
|
|
1846
1935
|
|
|
1847
|
-
Version number for a
|
|
1936
|
+
Version number for a Config.
|
|
1848
1937
|
|
|
1849
|
-
|
|
1938
|
+
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
1850
1939
|
|
|
1851
|
-
Version numbers are integer values representing different iterations of the
|
|
1940
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
1852
1941
|
|
|
1853
1942
|
</dd>
|
|
1854
1943
|
</dl>
|
|
@@ -1856,7 +1945,15 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1856
1945
|
<dl>
|
|
1857
1946
|
<dd>
|
|
1858
1947
|
|
|
1859
|
-
**
|
|
1948
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
1949
|
+
|
|
1950
|
+
</dd>
|
|
1951
|
+
</dl>
|
|
1952
|
+
|
|
1953
|
+
<dl>
|
|
1954
|
+
<dd>
|
|
1955
|
+
|
|
1956
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
1860
1957
|
|
|
1861
1958
|
</dd>
|
|
1862
1959
|
</dl>
|
|
@@ -1868,7 +1965,8 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1868
1965
|
</dl>
|
|
1869
1966
|
</details>
|
|
1870
1967
|
|
|
1871
|
-
|
|
1968
|
+
## EmpathicVoice Prompts
|
|
1969
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> core.Page<(Hume.ReturnPrompt | undefined), Hume.ReturnPagedPrompts></code></summary>
|
|
1872
1970
|
<dl>
|
|
1873
1971
|
<dd>
|
|
1874
1972
|
|
|
@@ -1880,7 +1978,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1880
1978
|
<dl>
|
|
1881
1979
|
<dd>
|
|
1882
1980
|
|
|
1883
|
-
|
|
1981
|
+
Fetches a paginated list of **Prompts**.
|
|
1884
1982
|
|
|
1885
1983
|
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1886
1984
|
</dd>
|
|
@@ -1897,7 +1995,25 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1897
1995
|
<dd>
|
|
1898
1996
|
|
|
1899
1997
|
```typescript
|
|
1900
|
-
await client.empathicVoice.prompts.
|
|
1998
|
+
const pageableResponse = await client.empathicVoice.prompts.listPrompts({
|
|
1999
|
+
pageNumber: 0,
|
|
2000
|
+
pageSize: 2
|
|
2001
|
+
});
|
|
2002
|
+
for await (const item of pageableResponse) {
|
|
2003
|
+
console.log(item);
|
|
2004
|
+
}
|
|
2005
|
+
|
|
2006
|
+
// Or you can manually iterate page-by-page
|
|
2007
|
+
let page = await client.empathicVoice.prompts.listPrompts({
|
|
2008
|
+
pageNumber: 0,
|
|
2009
|
+
pageSize: 2
|
|
2010
|
+
});
|
|
2011
|
+
while (page.hasNextPage()) {
|
|
2012
|
+
page = page.getNextPage();
|
|
2013
|
+
}
|
|
2014
|
+
|
|
2015
|
+
// You can also access the underlying response
|
|
2016
|
+
const response = page.response;
|
|
1901
2017
|
|
|
1902
2018
|
```
|
|
1903
2019
|
</dd>
|
|
@@ -1913,21 +2029,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1913
2029
|
<dl>
|
|
1914
2030
|
<dd>
|
|
1915
2031
|
|
|
1916
|
-
**
|
|
1917
|
-
|
|
1918
|
-
</dd>
|
|
1919
|
-
</dl>
|
|
1920
|
-
|
|
1921
|
-
<dl>
|
|
1922
|
-
<dd>
|
|
1923
|
-
|
|
1924
|
-
**version:** `number`
|
|
1925
|
-
|
|
1926
|
-
Version number for a Prompt.
|
|
1927
|
-
|
|
1928
|
-
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1929
|
-
|
|
1930
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2032
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
1931
2033
|
|
|
1932
2034
|
</dd>
|
|
1933
2035
|
</dl>
|
|
@@ -1947,7 +2049,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1947
2049
|
</dl>
|
|
1948
2050
|
</details>
|
|
1949
2051
|
|
|
1950
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
2052
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPrompt</a>({ ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
1951
2053
|
<dl>
|
|
1952
2054
|
<dd>
|
|
1953
2055
|
|
|
@@ -1959,7 +2061,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1959
2061
|
<dl>
|
|
1960
2062
|
<dd>
|
|
1961
2063
|
|
|
1962
|
-
|
|
2064
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
1963
2065
|
|
|
1964
2066
|
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1965
2067
|
</dd>
|
|
@@ -1976,8 +2078,9 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1976
2078
|
<dd>
|
|
1977
2079
|
|
|
1978
2080
|
```typescript
|
|
1979
|
-
await client.empathicVoice.prompts.
|
|
1980
|
-
|
|
2081
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
2082
|
+
name: "Weather Assistant Prompt",
|
|
2083
|
+
text: "<role>You are an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>"
|
|
1981
2084
|
});
|
|
1982
2085
|
|
|
1983
2086
|
```
|
|
@@ -1994,29 +2097,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1994
2097
|
<dl>
|
|
1995
2098
|
<dd>
|
|
1996
2099
|
|
|
1997
|
-
**
|
|
1998
|
-
|
|
1999
|
-
</dd>
|
|
2000
|
-
</dl>
|
|
2001
|
-
|
|
2002
|
-
<dl>
|
|
2003
|
-
<dd>
|
|
2004
|
-
|
|
2005
|
-
**version:** `number`
|
|
2006
|
-
|
|
2007
|
-
Version number for a Prompt.
|
|
2008
|
-
|
|
2009
|
-
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
2010
|
-
|
|
2011
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2012
|
-
|
|
2013
|
-
</dd>
|
|
2014
|
-
</dl>
|
|
2015
|
-
|
|
2016
|
-
<dl>
|
|
2017
|
-
<dd>
|
|
2018
|
-
|
|
2019
|
-
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
2100
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
2020
2101
|
|
|
2021
2102
|
</dd>
|
|
2022
2103
|
</dl>
|
|
@@ -2036,8 +2117,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
2036
2117
|
</dl>
|
|
2037
2118
|
</details>
|
|
2038
2119
|
|
|
2039
|
-
|
|
2040
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> core.Page<Hume.ReturnConfig, Hume.ReturnPagedConfigs></code></summary>
|
|
2120
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPromptVersions</a>(id, { ...params }) -> Hume.ReturnPagedPrompts</code></summary>
|
|
2041
2121
|
<dl>
|
|
2042
2122
|
<dd>
|
|
2043
2123
|
|
|
@@ -2049,9 +2129,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
2049
2129
|
<dl>
|
|
2050
2130
|
<dd>
|
|
2051
2131
|
|
|
2052
|
-
Fetches a
|
|
2132
|
+
Fetches a list of a **Prompt's** versions.
|
|
2053
2133
|
|
|
2054
|
-
|
|
2134
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2055
2135
|
</dd>
|
|
2056
2136
|
</dl>
|
|
2057
2137
|
</dd>
|
|
@@ -2066,25 +2146,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2066
2146
|
<dd>
|
|
2067
2147
|
|
|
2068
2148
|
```typescript
|
|
2069
|
-
|
|
2070
|
-
pageNumber: 0,
|
|
2071
|
-
pageSize: 1
|
|
2072
|
-
});
|
|
2073
|
-
for await (const item of pageableResponse) {
|
|
2074
|
-
console.log(item);
|
|
2075
|
-
}
|
|
2076
|
-
|
|
2077
|
-
// Or you can manually iterate page-by-page
|
|
2078
|
-
let page = await client.empathicVoice.configs.listConfigs({
|
|
2079
|
-
pageNumber: 0,
|
|
2080
|
-
pageSize: 1
|
|
2081
|
-
});
|
|
2082
|
-
while (page.hasNextPage()) {
|
|
2083
|
-
page = page.getNextPage();
|
|
2084
|
-
}
|
|
2085
|
-
|
|
2086
|
-
// You can also access the underlying response
|
|
2087
|
-
const response = page.response;
|
|
2149
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
2088
2150
|
|
|
2089
2151
|
```
|
|
2090
2152
|
</dd>
|
|
@@ -2100,7 +2162,7 @@ const response = page.response;
|
|
|
2100
2162
|
<dl>
|
|
2101
2163
|
<dd>
|
|
2102
2164
|
|
|
2103
|
-
**
|
|
2165
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2104
2166
|
|
|
2105
2167
|
</dd>
|
|
2106
2168
|
</dl>
|
|
@@ -2108,7 +2170,15 @@ const response = page.response;
|
|
|
2108
2170
|
<dl>
|
|
2109
2171
|
<dd>
|
|
2110
2172
|
|
|
2111
|
-
**
|
|
2173
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
2174
|
+
|
|
2175
|
+
</dd>
|
|
2176
|
+
</dl>
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2112
2182
|
|
|
2113
2183
|
</dd>
|
|
2114
2184
|
</dl>
|
|
@@ -2120,7 +2190,7 @@ const response = page.response;
|
|
|
2120
2190
|
</dl>
|
|
2121
2191
|
</details>
|
|
2122
2192
|
|
|
2123
|
-
<details><summary><code>client.empathicVoice.
|
|
2193
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVersion</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
2124
2194
|
<dl>
|
|
2125
2195
|
<dd>
|
|
2126
2196
|
|
|
@@ -2132,9 +2202,9 @@ const response = page.response;
|
|
|
2132
2202
|
<dl>
|
|
2133
2203
|
<dd>
|
|
2134
2204
|
|
|
2135
|
-
|
|
2205
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
2136
2206
|
|
|
2137
|
-
|
|
2207
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2138
2208
|
</dd>
|
|
2139
2209
|
</dl>
|
|
2140
2210
|
</dd>
|
|
@@ -2149,36 +2219,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2149
2219
|
<dd>
|
|
2150
2220
|
|
|
2151
2221
|
```typescript
|
|
2152
|
-
await client.empathicVoice.
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2156
|
-
version: 0
|
|
2157
|
-
},
|
|
2158
|
-
eviVersion: "3",
|
|
2159
|
-
voice: {
|
|
2160
|
-
provider: "HUME_AI",
|
|
2161
|
-
name: "Ava Song"
|
|
2162
|
-
},
|
|
2163
|
-
languageModel: {
|
|
2164
|
-
modelProvider: "ANTHROPIC",
|
|
2165
|
-
modelResource: "claude-3-7-sonnet-latest",
|
|
2166
|
-
temperature: 1
|
|
2167
|
-
},
|
|
2168
|
-
eventMessages: {
|
|
2169
|
-
onNewChat: {
|
|
2170
|
-
enabled: false,
|
|
2171
|
-
text: ""
|
|
2172
|
-
},
|
|
2173
|
-
onInactivityTimeout: {
|
|
2174
|
-
enabled: false,
|
|
2175
|
-
text: ""
|
|
2176
|
-
},
|
|
2177
|
-
onMaxDurationTimeout: {
|
|
2178
|
-
enabled: false,
|
|
2179
|
-
text: ""
|
|
2180
|
-
}
|
|
2181
|
-
}
|
|
2222
|
+
await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
2223
|
+
text: "<role>You are an updated version of an AI weather assistant providing users with accurate and up-to-date weather information. Respond to user queries concisely and clearly. Use simple language and avoid technical jargon. Provide temperature, precipitation, wind conditions, and any weather alerts. Include helpful tips if severe weather is expected.</role>",
|
|
2224
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt."
|
|
2182
2225
|
});
|
|
2183
2226
|
|
|
2184
2227
|
```
|
|
@@ -2195,7 +2238,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2195
2238
|
<dl>
|
|
2196
2239
|
<dd>
|
|
2197
2240
|
|
|
2198
|
-
**
|
|
2241
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2199
2242
|
|
|
2200
2243
|
</dd>
|
|
2201
2244
|
</dl>
|
|
@@ -2203,7 +2246,15 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2203
2246
|
<dl>
|
|
2204
2247
|
<dd>
|
|
2205
2248
|
|
|
2206
|
-
**
|
|
2249
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
2250
|
+
|
|
2251
|
+
</dd>
|
|
2252
|
+
</dl>
|
|
2253
|
+
|
|
2254
|
+
<dl>
|
|
2255
|
+
<dd>
|
|
2256
|
+
|
|
2257
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2207
2258
|
|
|
2208
2259
|
</dd>
|
|
2209
2260
|
</dl>
|
|
@@ -2215,7 +2266,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2215
2266
|
</dl>
|
|
2216
2267
|
</details>
|
|
2217
2268
|
|
|
2218
|
-
<details><summary><code>client.empathicVoice.
|
|
2269
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
2219
2270
|
<dl>
|
|
2220
2271
|
<dd>
|
|
2221
2272
|
|
|
@@ -2227,9 +2278,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2227
2278
|
<dl>
|
|
2228
2279
|
<dd>
|
|
2229
2280
|
|
|
2230
|
-
|
|
2281
|
+
Deletes a **Prompt** and its versions.
|
|
2231
2282
|
|
|
2232
|
-
|
|
2283
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2233
2284
|
</dd>
|
|
2234
2285
|
</dl>
|
|
2235
2286
|
</dd>
|
|
@@ -2244,19 +2295,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2244
2295
|
<dd>
|
|
2245
2296
|
|
|
2246
2297
|
```typescript
|
|
2247
|
-
|
|
2248
|
-
for await (const item of pageableResponse) {
|
|
2249
|
-
console.log(item);
|
|
2250
|
-
}
|
|
2251
|
-
|
|
2252
|
-
// Or you can manually iterate page-by-page
|
|
2253
|
-
let page = await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2254
|
-
while (page.hasNextPage()) {
|
|
2255
|
-
page = page.getNextPage();
|
|
2256
|
-
}
|
|
2257
|
-
|
|
2258
|
-
// You can also access the underlying response
|
|
2259
|
-
const response = page.response;
|
|
2298
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
2260
2299
|
|
|
2261
2300
|
```
|
|
2262
2301
|
</dd>
|
|
@@ -2272,15 +2311,7 @@ const response = page.response;
|
|
|
2272
2311
|
<dl>
|
|
2273
2312
|
<dd>
|
|
2274
2313
|
|
|
2275
|
-
**id:** `string` — Identifier for a
|
|
2276
|
-
|
|
2277
|
-
</dd>
|
|
2278
|
-
</dl>
|
|
2279
|
-
|
|
2280
|
-
<dl>
|
|
2281
|
-
<dd>
|
|
2282
|
-
|
|
2283
|
-
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2314
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2284
2315
|
|
|
2285
2316
|
</dd>
|
|
2286
2317
|
</dl>
|
|
@@ -2288,7 +2319,7 @@ const response = page.response;
|
|
|
2288
2319
|
<dl>
|
|
2289
2320
|
<dd>
|
|
2290
2321
|
|
|
2291
|
-
**requestOptions:** `
|
|
2322
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2292
2323
|
|
|
2293
2324
|
</dd>
|
|
2294
2325
|
</dl>
|
|
@@ -2300,7 +2331,7 @@ const response = page.response;
|
|
|
2300
2331
|
</dl>
|
|
2301
2332
|
</details>
|
|
2302
2333
|
|
|
2303
|
-
<details><summary><code>client.empathicVoice.
|
|
2334
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
2304
2335
|
<dl>
|
|
2305
2336
|
<dd>
|
|
2306
2337
|
|
|
@@ -2312,9 +2343,9 @@ const response = page.response;
|
|
|
2312
2343
|
<dl>
|
|
2313
2344
|
<dd>
|
|
2314
2345
|
|
|
2315
|
-
Updates
|
|
2346
|
+
Updates the name of a **Prompt**.
|
|
2316
2347
|
|
|
2317
|
-
|
|
2348
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2318
2349
|
</dd>
|
|
2319
2350
|
</dl>
|
|
2320
2351
|
</dd>
|
|
@@ -2329,39 +2360,8 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2329
2360
|
<dd>
|
|
2330
2361
|
|
|
2331
2362
|
```typescript
|
|
2332
|
-
await client.empathicVoice.
|
|
2333
|
-
|
|
2334
|
-
eviVersion: "3",
|
|
2335
|
-
prompt: {
|
|
2336
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2337
|
-
version: 0
|
|
2338
|
-
},
|
|
2339
|
-
voice: {
|
|
2340
|
-
provider: "HUME_AI",
|
|
2341
|
-
name: "Ava Song"
|
|
2342
|
-
},
|
|
2343
|
-
languageModel: {
|
|
2344
|
-
modelProvider: "ANTHROPIC",
|
|
2345
|
-
modelResource: "claude-3-7-sonnet-latest",
|
|
2346
|
-
temperature: 1
|
|
2347
|
-
},
|
|
2348
|
-
ellmModel: {
|
|
2349
|
-
allowShortResponses: true
|
|
2350
|
-
},
|
|
2351
|
-
eventMessages: {
|
|
2352
|
-
onNewChat: {
|
|
2353
|
-
enabled: false,
|
|
2354
|
-
text: ""
|
|
2355
|
-
},
|
|
2356
|
-
onInactivityTimeout: {
|
|
2357
|
-
enabled: false,
|
|
2358
|
-
text: ""
|
|
2359
|
-
},
|
|
2360
|
-
onMaxDurationTimeout: {
|
|
2361
|
-
enabled: false,
|
|
2362
|
-
text: ""
|
|
2363
|
-
}
|
|
2364
|
-
}
|
|
2363
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
2364
|
+
name: "Updated Weather Assistant Prompt Name"
|
|
2365
2365
|
});
|
|
2366
2366
|
|
|
2367
2367
|
```
|
|
@@ -2378,7 +2378,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2378
2378
|
<dl>
|
|
2379
2379
|
<dd>
|
|
2380
2380
|
|
|
2381
|
-
**id:** `string` — Identifier for a
|
|
2381
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2382
2382
|
|
|
2383
2383
|
</dd>
|
|
2384
2384
|
</dl>
|
|
@@ -2386,7 +2386,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2386
2386
|
<dl>
|
|
2387
2387
|
<dd>
|
|
2388
2388
|
|
|
2389
|
-
**request:** `Hume.empathicVoice.
|
|
2389
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
2390
2390
|
|
|
2391
2391
|
</dd>
|
|
2392
2392
|
</dl>
|
|
@@ -2394,7 +2394,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2394
2394
|
<dl>
|
|
2395
2395
|
<dd>
|
|
2396
2396
|
|
|
2397
|
-
**requestOptions:** `
|
|
2397
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2398
2398
|
|
|
2399
2399
|
</dd>
|
|
2400
2400
|
</dl>
|
|
@@ -2406,7 +2406,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2406
2406
|
</dl>
|
|
2407
2407
|
</details>
|
|
2408
2408
|
|
|
2409
|
-
<details><summary><code>client.empathicVoice.
|
|
2409
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">getPromptVersion</a>(id, version) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
2410
2410
|
<dl>
|
|
2411
2411
|
<dd>
|
|
2412
2412
|
|
|
@@ -2418,9 +2418,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2418
2418
|
<dl>
|
|
2419
2419
|
<dd>
|
|
2420
2420
|
|
|
2421
|
-
|
|
2421
|
+
Fetches a specified version of a **Prompt**.
|
|
2422
2422
|
|
|
2423
|
-
|
|
2423
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2424
2424
|
</dd>
|
|
2425
2425
|
</dl>
|
|
2426
2426
|
</dd>
|
|
@@ -2435,7 +2435,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2435
2435
|
<dd>
|
|
2436
2436
|
|
|
2437
2437
|
```typescript
|
|
2438
|
-
await client.empathicVoice.
|
|
2438
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
2439
2439
|
|
|
2440
2440
|
```
|
|
2441
2441
|
</dd>
|
|
@@ -2451,7 +2451,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2451
2451
|
<dl>
|
|
2452
2452
|
<dd>
|
|
2453
2453
|
|
|
2454
|
-
**id:** `string` — Identifier for a
|
|
2454
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2455
2455
|
|
|
2456
2456
|
</dd>
|
|
2457
2457
|
</dl>
|
|
@@ -2459,7 +2459,21 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2459
2459
|
<dl>
|
|
2460
2460
|
<dd>
|
|
2461
2461
|
|
|
2462
|
-
**
|
|
2462
|
+
**version:** `number`
|
|
2463
|
+
|
|
2464
|
+
Version number for a Prompt.
|
|
2465
|
+
|
|
2466
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
2467
|
+
|
|
2468
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2469
|
+
|
|
2470
|
+
</dd>
|
|
2471
|
+
</dl>
|
|
2472
|
+
|
|
2473
|
+
<dl>
|
|
2474
|
+
<dd>
|
|
2475
|
+
|
|
2476
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2463
2477
|
|
|
2464
2478
|
</dd>
|
|
2465
2479
|
</dl>
|
|
@@ -2471,7 +2485,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2471
2485
|
</dl>
|
|
2472
2486
|
</details>
|
|
2473
2487
|
|
|
2474
|
-
<details><summary><code>client.empathicVoice.
|
|
2488
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
2475
2489
|
<dl>
|
|
2476
2490
|
<dd>
|
|
2477
2491
|
|
|
@@ -2483,9 +2497,9 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2483
2497
|
<dl>
|
|
2484
2498
|
<dd>
|
|
2485
2499
|
|
|
2486
|
-
|
|
2500
|
+
Deletes a specified version of a **Prompt**.
|
|
2487
2501
|
|
|
2488
|
-
|
|
2502
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2489
2503
|
</dd>
|
|
2490
2504
|
</dl>
|
|
2491
2505
|
</dd>
|
|
@@ -2500,9 +2514,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2500
2514
|
<dd>
|
|
2501
2515
|
|
|
2502
2516
|
```typescript
|
|
2503
|
-
await client.empathicVoice.
|
|
2504
|
-
name: "Updated Weather Assistant Config Name"
|
|
2505
|
-
});
|
|
2517
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
2506
2518
|
|
|
2507
2519
|
```
|
|
2508
2520
|
</dd>
|
|
@@ -2518,7 +2530,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2518
2530
|
<dl>
|
|
2519
2531
|
<dd>
|
|
2520
2532
|
|
|
2521
|
-
**id:** `string` — Identifier for a
|
|
2533
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2522
2534
|
|
|
2523
2535
|
</dd>
|
|
2524
2536
|
</dl>
|
|
@@ -2526,7 +2538,13 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2526
2538
|
<dl>
|
|
2527
2539
|
<dd>
|
|
2528
2540
|
|
|
2529
|
-
**
|
|
2541
|
+
**version:** `number`
|
|
2542
|
+
|
|
2543
|
+
Version number for a Prompt.
|
|
2544
|
+
|
|
2545
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
2546
|
+
|
|
2547
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2530
2548
|
|
|
2531
2549
|
</dd>
|
|
2532
2550
|
</dl>
|
|
@@ -2534,7 +2552,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2534
2552
|
<dl>
|
|
2535
2553
|
<dd>
|
|
2536
2554
|
|
|
2537
|
-
**requestOptions:** `
|
|
2555
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2538
2556
|
|
|
2539
2557
|
</dd>
|
|
2540
2558
|
</dl>
|
|
@@ -2546,7 +2564,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2546
2564
|
</dl>
|
|
2547
2565
|
</details>
|
|
2548
2566
|
|
|
2549
|
-
<details><summary><code>client.empathicVoice.
|
|
2567
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptDescription</a>(id, version, { ...params }) -> Hume.ReturnPrompt | undefined</code></summary>
|
|
2550
2568
|
<dl>
|
|
2551
2569
|
<dd>
|
|
2552
2570
|
|
|
@@ -2558,9 +2576,9 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2558
2576
|
<dl>
|
|
2559
2577
|
<dd>
|
|
2560
2578
|
|
|
2561
|
-
|
|
2579
|
+
Updates the description of a **Prompt**.
|
|
2562
2580
|
|
|
2563
|
-
|
|
2581
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2564
2582
|
</dd>
|
|
2565
2583
|
</dl>
|
|
2566
2584
|
</dd>
|
|
@@ -2575,7 +2593,9 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2575
2593
|
<dd>
|
|
2576
2594
|
|
|
2577
2595
|
```typescript
|
|
2578
|
-
await client.empathicVoice.
|
|
2596
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
2597
|
+
versionDescription: "This is an updated version_description."
|
|
2598
|
+
});
|
|
2579
2599
|
|
|
2580
2600
|
```
|
|
2581
2601
|
</dd>
|
|
@@ -2591,7 +2611,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2591
2611
|
<dl>
|
|
2592
2612
|
<dd>
|
|
2593
2613
|
|
|
2594
|
-
**id:** `string` — Identifier for a
|
|
2614
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2595
2615
|
|
|
2596
2616
|
</dd>
|
|
2597
2617
|
</dl>
|
|
@@ -2601,11 +2621,11 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2601
2621
|
|
|
2602
2622
|
**version:** `number`
|
|
2603
2623
|
|
|
2604
|
-
Version number for a
|
|
2624
|
+
Version number for a Prompt.
|
|
2605
2625
|
|
|
2606
|
-
|
|
2626
|
+
Prompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
2607
2627
|
|
|
2608
|
-
Version numbers are integer values representing different iterations of the
|
|
2628
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2609
2629
|
|
|
2610
2630
|
</dd>
|
|
2611
2631
|
</dl>
|
|
@@ -2613,7 +2633,15 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2613
2633
|
<dl>
|
|
2614
2634
|
<dd>
|
|
2615
2635
|
|
|
2616
|
-
**
|
|
2636
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
2637
|
+
|
|
2638
|
+
</dd>
|
|
2639
|
+
</dl>
|
|
2640
|
+
|
|
2641
|
+
<dl>
|
|
2642
|
+
<dd>
|
|
2643
|
+
|
|
2644
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2617
2645
|
|
|
2618
2646
|
</dd>
|
|
2619
2647
|
</dl>
|
|
@@ -2625,7 +2653,8 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2625
2653
|
</dl>
|
|
2626
2654
|
</details>
|
|
2627
2655
|
|
|
2628
|
-
|
|
2656
|
+
## EmpathicVoice Tools
|
|
2657
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listTools</a>({ ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
|
|
2629
2658
|
<dl>
|
|
2630
2659
|
<dd>
|
|
2631
2660
|
|
|
@@ -2637,9 +2666,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2637
2666
|
<dl>
|
|
2638
2667
|
<dd>
|
|
2639
2668
|
|
|
2640
|
-
|
|
2669
|
+
Fetches a paginated list of **Tools**.
|
|
2641
2670
|
|
|
2642
|
-
|
|
2671
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
2643
2672
|
</dd>
|
|
2644
2673
|
</dl>
|
|
2645
2674
|
</dd>
|
|
@@ -2654,7 +2683,25 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2654
2683
|
<dd>
|
|
2655
2684
|
|
|
2656
2685
|
```typescript
|
|
2657
|
-
await client.empathicVoice.
|
|
2686
|
+
const pageableResponse = await client.empathicVoice.tools.listTools({
|
|
2687
|
+
pageNumber: 0,
|
|
2688
|
+
pageSize: 2
|
|
2689
|
+
});
|
|
2690
|
+
for await (const item of pageableResponse) {
|
|
2691
|
+
console.log(item);
|
|
2692
|
+
}
|
|
2693
|
+
|
|
2694
|
+
// Or you can manually iterate page-by-page
|
|
2695
|
+
let page = await client.empathicVoice.tools.listTools({
|
|
2696
|
+
pageNumber: 0,
|
|
2697
|
+
pageSize: 2
|
|
2698
|
+
});
|
|
2699
|
+
while (page.hasNextPage()) {
|
|
2700
|
+
page = page.getNextPage();
|
|
2701
|
+
}
|
|
2702
|
+
|
|
2703
|
+
// You can also access the underlying response
|
|
2704
|
+
const response = page.response;
|
|
2658
2705
|
|
|
2659
2706
|
```
|
|
2660
2707
|
</dd>
|
|
@@ -2670,21 +2717,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2670
2717
|
<dl>
|
|
2671
2718
|
<dd>
|
|
2672
2719
|
|
|
2673
|
-
**
|
|
2674
|
-
|
|
2675
|
-
</dd>
|
|
2676
|
-
</dl>
|
|
2677
|
-
|
|
2678
|
-
<dl>
|
|
2679
|
-
<dd>
|
|
2680
|
-
|
|
2681
|
-
**version:** `number`
|
|
2682
|
-
|
|
2683
|
-
Version number for a Config.
|
|
2684
|
-
|
|
2685
|
-
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2686
|
-
|
|
2687
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2720
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
2688
2721
|
|
|
2689
2722
|
</dd>
|
|
2690
2723
|
</dl>
|
|
@@ -2692,7 +2725,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2692
2725
|
<dl>
|
|
2693
2726
|
<dd>
|
|
2694
2727
|
|
|
2695
|
-
**requestOptions:** `
|
|
2728
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2696
2729
|
|
|
2697
2730
|
</dd>
|
|
2698
2731
|
</dl>
|
|
@@ -2704,7 +2737,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2704
2737
|
</dl>
|
|
2705
2738
|
</details>
|
|
2706
2739
|
|
|
2707
|
-
<details><summary><code>client.empathicVoice.
|
|
2740
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createTool</a>({ ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
2708
2741
|
<dl>
|
|
2709
2742
|
<dd>
|
|
2710
2743
|
|
|
@@ -2716,9 +2749,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2716
2749
|
<dl>
|
|
2717
2750
|
<dd>
|
|
2718
2751
|
|
|
2719
|
-
|
|
2752
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
2720
2753
|
|
|
2721
|
-
|
|
2754
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
2722
2755
|
</dd>
|
|
2723
2756
|
</dl>
|
|
2724
2757
|
</dd>
|
|
@@ -2733,8 +2766,12 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2733
2766
|
<dd>
|
|
2734
2767
|
|
|
2735
2768
|
```typescript
|
|
2736
|
-
await client.empathicVoice.
|
|
2737
|
-
|
|
2769
|
+
await client.empathicVoice.tools.createTool({
|
|
2770
|
+
name: "get_current_weather",
|
|
2771
|
+
parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
|
|
2772
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
2773
|
+
description: "This tool is for getting the current weather.",
|
|
2774
|
+
fallbackContent: "Unable to fetch current weather."
|
|
2738
2775
|
});
|
|
2739
2776
|
|
|
2740
2777
|
```
|
|
@@ -2751,29 +2788,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
2751
2788
|
<dl>
|
|
2752
2789
|
<dd>
|
|
2753
2790
|
|
|
2754
|
-
**
|
|
2755
|
-
|
|
2756
|
-
</dd>
|
|
2757
|
-
</dl>
|
|
2758
|
-
|
|
2759
|
-
<dl>
|
|
2760
|
-
<dd>
|
|
2761
|
-
|
|
2762
|
-
**version:** `number`
|
|
2763
|
-
|
|
2764
|
-
Version number for a Config.
|
|
2765
|
-
|
|
2766
|
-
Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2767
|
-
|
|
2768
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2769
|
-
|
|
2770
|
-
</dd>
|
|
2771
|
-
</dl>
|
|
2772
|
-
|
|
2773
|
-
<dl>
|
|
2774
|
-
<dd>
|
|
2775
|
-
|
|
2776
|
-
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2791
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
2777
2792
|
|
|
2778
2793
|
</dd>
|
|
2779
2794
|
</dl>
|
|
@@ -2781,7 +2796,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2781
2796
|
<dl>
|
|
2782
2797
|
<dd>
|
|
2783
2798
|
|
|
2784
|
-
**requestOptions:** `
|
|
2799
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2785
2800
|
|
|
2786
2801
|
</dd>
|
|
2787
2802
|
</dl>
|
|
@@ -2793,8 +2808,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2793
2808
|
</dl>
|
|
2794
2809
|
</details>
|
|
2795
2810
|
|
|
2796
|
-
|
|
2797
|
-
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat, Hume.ReturnPagedChats></code></summary>
|
|
2811
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> core.Page<(Hume.ReturnUserDefinedTool | undefined), Hume.ReturnPagedUserDefinedTools></code></summary>
|
|
2798
2812
|
<dl>
|
|
2799
2813
|
<dd>
|
|
2800
2814
|
|
|
@@ -2806,7 +2820,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2806
2820
|
<dl>
|
|
2807
2821
|
<dd>
|
|
2808
2822
|
|
|
2809
|
-
Fetches a
|
|
2823
|
+
Fetches a list of a **Tool's** versions.
|
|
2824
|
+
|
|
2825
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
2810
2826
|
</dd>
|
|
2811
2827
|
</dl>
|
|
2812
2828
|
</dd>
|
|
@@ -2821,21 +2837,13 @@ Fetches a paginated list of **Chats**.
|
|
|
2821
2837
|
<dd>
|
|
2822
2838
|
|
|
2823
2839
|
```typescript
|
|
2824
|
-
const pageableResponse = await client.empathicVoice.
|
|
2825
|
-
pageNumber: 0,
|
|
2826
|
-
pageSize: 1,
|
|
2827
|
-
ascendingOrder: true
|
|
2828
|
-
});
|
|
2840
|
+
const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
2829
2841
|
for await (const item of pageableResponse) {
|
|
2830
2842
|
console.log(item);
|
|
2831
2843
|
}
|
|
2832
2844
|
|
|
2833
2845
|
// Or you can manually iterate page-by-page
|
|
2834
|
-
let page = await client.empathicVoice.
|
|
2835
|
-
pageNumber: 0,
|
|
2836
|
-
pageSize: 1,
|
|
2837
|
-
ascendingOrder: true
|
|
2838
|
-
});
|
|
2846
|
+
let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
2839
2847
|
while (page.hasNextPage()) {
|
|
2840
2848
|
page = page.getNextPage();
|
|
2841
2849
|
}
|
|
@@ -2857,7 +2865,7 @@ const response = page.response;
|
|
|
2857
2865
|
<dl>
|
|
2858
2866
|
<dd>
|
|
2859
2867
|
|
|
2860
|
-
**
|
|
2868
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
2861
2869
|
|
|
2862
2870
|
</dd>
|
|
2863
2871
|
</dl>
|
|
@@ -2865,7 +2873,15 @@ const response = page.response;
|
|
|
2865
2873
|
<dl>
|
|
2866
2874
|
<dd>
|
|
2867
2875
|
|
|
2868
|
-
**
|
|
2876
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
2877
|
+
|
|
2878
|
+
</dd>
|
|
2879
|
+
</dl>
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2869
2885
|
|
|
2870
2886
|
</dd>
|
|
2871
2887
|
</dl>
|
|
@@ -2877,7 +2893,7 @@ const response = page.response;
|
|
|
2877
2893
|
</dl>
|
|
2878
2894
|
</details>
|
|
2879
2895
|
|
|
2880
|
-
<details><summary><code>client.empathicVoice.
|
|
2896
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">createToolVersion</a>(id, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
2881
2897
|
<dl>
|
|
2882
2898
|
<dd>
|
|
2883
2899
|
|
|
@@ -2889,7 +2905,9 @@ const response = page.response;
|
|
|
2889
2905
|
<dl>
|
|
2890
2906
|
<dd>
|
|
2891
2907
|
|
|
2892
|
-
|
|
2908
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
2909
|
+
|
|
2910
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
2893
2911
|
</dd>
|
|
2894
2912
|
</dl>
|
|
2895
2913
|
</dd>
|
|
@@ -2904,27 +2922,12 @@ Fetches a paginated list of **Chat** events.
|
|
|
2904
2922
|
<dd>
|
|
2905
2923
|
|
|
2906
2924
|
```typescript
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
for await (const item of pageableResponse) {
|
|
2913
|
-
console.log(item);
|
|
2914
|
-
}
|
|
2915
|
-
|
|
2916
|
-
// Or you can manually iterate page-by-page
|
|
2917
|
-
let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2918
|
-
pageNumber: 0,
|
|
2919
|
-
pageSize: 3,
|
|
2920
|
-
ascendingOrder: true
|
|
2925
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
2926
|
+
parameters: "{ \"type\": \"object\", \"properties\": { \"location\": { \"type\": \"string\", \"description\": \"The city and state, e.g. San Francisco, CA\" }, \"format\": { \"type\": \"string\", \"enum\": [\"celsius\", \"fahrenheit\", \"kelvin\"], \"description\": \"The temperature unit to use. Infer this from the users location.\" } }, \"required\": [\"location\", \"format\"] }",
|
|
2927
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
2928
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
2929
|
+
description: "This tool is for getting the current weather."
|
|
2921
2930
|
});
|
|
2922
|
-
while (page.hasNextPage()) {
|
|
2923
|
-
page = page.getNextPage();
|
|
2924
|
-
}
|
|
2925
|
-
|
|
2926
|
-
// You can also access the underlying response
|
|
2927
|
-
const response = page.response;
|
|
2928
2931
|
|
|
2929
2932
|
```
|
|
2930
2933
|
</dd>
|
|
@@ -2940,7 +2943,7 @@ const response = page.response;
|
|
|
2940
2943
|
<dl>
|
|
2941
2944
|
<dd>
|
|
2942
2945
|
|
|
2943
|
-
**id:** `string` — Identifier for a
|
|
2946
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
2944
2947
|
|
|
2945
2948
|
</dd>
|
|
2946
2949
|
</dl>
|
|
@@ -2948,7 +2951,7 @@ const response = page.response;
|
|
|
2948
2951
|
<dl>
|
|
2949
2952
|
<dd>
|
|
2950
2953
|
|
|
2951
|
-
**request:** `Hume.empathicVoice.
|
|
2954
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
2952
2955
|
|
|
2953
2956
|
</dd>
|
|
2954
2957
|
</dl>
|
|
@@ -2956,7 +2959,7 @@ const response = page.response;
|
|
|
2956
2959
|
<dl>
|
|
2957
2960
|
<dd>
|
|
2958
2961
|
|
|
2959
|
-
**requestOptions:** `
|
|
2962
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2960
2963
|
|
|
2961
2964
|
</dd>
|
|
2962
2965
|
</dl>
|
|
@@ -2968,7 +2971,7 @@ const response = page.response;
|
|
|
2968
2971
|
</dl>
|
|
2969
2972
|
</details>
|
|
2970
2973
|
|
|
2971
|
-
<details><summary><code>client.empathicVoice.
|
|
2974
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
2972
2975
|
<dl>
|
|
2973
2976
|
<dd>
|
|
2974
2977
|
|
|
@@ -2980,7 +2983,9 @@ const response = page.response;
|
|
|
2980
2983
|
<dl>
|
|
2981
2984
|
<dd>
|
|
2982
2985
|
|
|
2983
|
-
|
|
2986
|
+
Deletes a **Tool** and its versions.
|
|
2987
|
+
|
|
2988
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
2984
2989
|
</dd>
|
|
2985
2990
|
</dl>
|
|
2986
2991
|
</dd>
|
|
@@ -2995,7 +3000,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
|
|
|
2995
3000
|
<dd>
|
|
2996
3001
|
|
|
2997
3002
|
```typescript
|
|
2998
|
-
await client.empathicVoice.
|
|
3003
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
2999
3004
|
|
|
3000
3005
|
```
|
|
3001
3006
|
</dd>
|
|
@@ -3011,7 +3016,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3011
3016
|
<dl>
|
|
3012
3017
|
<dd>
|
|
3013
3018
|
|
|
3014
|
-
**id:** `string` — Identifier for a
|
|
3019
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3015
3020
|
|
|
3016
3021
|
</dd>
|
|
3017
3022
|
</dl>
|
|
@@ -3019,7 +3024,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3019
3024
|
<dl>
|
|
3020
3025
|
<dd>
|
|
3021
3026
|
|
|
3022
|
-
**requestOptions:** `
|
|
3027
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3023
3028
|
|
|
3024
3029
|
</dd>
|
|
3025
3030
|
</dl>
|
|
@@ -3031,8 +3036,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3031
3036
|
</dl>
|
|
3032
3037
|
</details>
|
|
3033
3038
|
|
|
3034
|
-
|
|
3035
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> core.Page<Hume.ReturnChatGroup, Hume.ReturnPagedChatGroups></code></summary>
|
|
3039
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
3036
3040
|
<dl>
|
|
3037
3041
|
<dd>
|
|
3038
3042
|
|
|
@@ -3044,7 +3048,9 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3044
3048
|
<dl>
|
|
3045
3049
|
<dd>
|
|
3046
3050
|
|
|
3047
|
-
|
|
3051
|
+
Updates the name of a **Tool**.
|
|
3052
|
+
|
|
3053
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
3048
3054
|
</dd>
|
|
3049
3055
|
</dl>
|
|
3050
3056
|
</dd>
|
|
@@ -3059,29 +3065,9 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
3059
3065
|
<dd>
|
|
3060
3066
|
|
|
3061
3067
|
```typescript
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
pageSize: 1,
|
|
3065
|
-
ascendingOrder: true,
|
|
3066
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
3067
|
-
});
|
|
3068
|
-
for await (const item of pageableResponse) {
|
|
3069
|
-
console.log(item);
|
|
3070
|
-
}
|
|
3071
|
-
|
|
3072
|
-
// Or you can manually iterate page-by-page
|
|
3073
|
-
let page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
3074
|
-
pageNumber: 0,
|
|
3075
|
-
pageSize: 1,
|
|
3076
|
-
ascendingOrder: true,
|
|
3077
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
3068
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
3069
|
+
name: "get_current_temperature"
|
|
3078
3070
|
});
|
|
3079
|
-
while (page.hasNextPage()) {
|
|
3080
|
-
page = page.getNextPage();
|
|
3081
|
-
}
|
|
3082
|
-
|
|
3083
|
-
// You can also access the underlying response
|
|
3084
|
-
const response = page.response;
|
|
3085
3071
|
|
|
3086
3072
|
```
|
|
3087
3073
|
</dd>
|
|
@@ -3097,7 +3083,7 @@ const response = page.response;
|
|
|
3097
3083
|
<dl>
|
|
3098
3084
|
<dd>
|
|
3099
3085
|
|
|
3100
|
-
**
|
|
3086
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3101
3087
|
|
|
3102
3088
|
</dd>
|
|
3103
3089
|
</dl>
|
|
@@ -3105,7 +3091,15 @@ const response = page.response;
|
|
|
3105
3091
|
<dl>
|
|
3106
3092
|
<dd>
|
|
3107
3093
|
|
|
3108
|
-
**
|
|
3094
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
3095
|
+
|
|
3096
|
+
</dd>
|
|
3097
|
+
</dl>
|
|
3098
|
+
|
|
3099
|
+
<dl>
|
|
3100
|
+
<dd>
|
|
3101
|
+
|
|
3102
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3109
3103
|
|
|
3110
3104
|
</dd>
|
|
3111
3105
|
</dl>
|
|
@@ -3117,7 +3111,7 @@ const response = page.response;
|
|
|
3117
3111
|
</dl>
|
|
3118
3112
|
</details>
|
|
3119
3113
|
|
|
3120
|
-
<details><summary><code>client.empathicVoice.
|
|
3114
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">getToolVersion</a>(id, version) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
3121
3115
|
<dl>
|
|
3122
3116
|
<dd>
|
|
3123
3117
|
|
|
@@ -3129,7 +3123,9 @@ const response = page.response;
|
|
|
3129
3123
|
<dl>
|
|
3130
3124
|
<dd>
|
|
3131
3125
|
|
|
3132
|
-
Fetches a
|
|
3126
|
+
Fetches a specified version of a **Tool**.
|
|
3127
|
+
|
|
3128
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
3133
3129
|
</dd>
|
|
3134
3130
|
</dl>
|
|
3135
3131
|
</dd>
|
|
@@ -3144,11 +3140,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
3144
3140
|
<dd>
|
|
3145
3141
|
|
|
3146
3142
|
```typescript
|
|
3147
|
-
await client.empathicVoice.
|
|
3148
|
-
pageNumber: 0,
|
|
3149
|
-
pageSize: 1,
|
|
3150
|
-
ascendingOrder: true
|
|
3151
|
-
});
|
|
3143
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
3152
3144
|
|
|
3153
3145
|
```
|
|
3154
3146
|
</dd>
|
|
@@ -3164,7 +3156,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3164
3156
|
<dl>
|
|
3165
3157
|
<dd>
|
|
3166
3158
|
|
|
3167
|
-
**id:** `string` — Identifier for a
|
|
3159
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3168
3160
|
|
|
3169
3161
|
</dd>
|
|
3170
3162
|
</dl>
|
|
@@ -3172,7 +3164,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3172
3164
|
<dl>
|
|
3173
3165
|
<dd>
|
|
3174
3166
|
|
|
3175
|
-
**
|
|
3167
|
+
**version:** `number`
|
|
3168
|
+
|
|
3169
|
+
Version number for a Tool.
|
|
3170
|
+
|
|
3171
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
3172
|
+
|
|
3173
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
3176
3174
|
|
|
3177
3175
|
</dd>
|
|
3178
3176
|
</dl>
|
|
@@ -3180,7 +3178,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3180
3178
|
<dl>
|
|
3181
3179
|
<dd>
|
|
3182
3180
|
|
|
3183
|
-
**requestOptions:** `
|
|
3181
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3184
3182
|
|
|
3185
3183
|
</dd>
|
|
3186
3184
|
</dl>
|
|
@@ -3192,7 +3190,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3192
3190
|
</dl>
|
|
3193
3191
|
</details>
|
|
3194
3192
|
|
|
3195
|
-
<details><summary><code>client.empathicVoice.
|
|
3193
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
3196
3194
|
<dl>
|
|
3197
3195
|
<dd>
|
|
3198
3196
|
|
|
@@ -3204,7 +3202,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3204
3202
|
<dl>
|
|
3205
3203
|
<dd>
|
|
3206
3204
|
|
|
3207
|
-
|
|
3205
|
+
Deletes a specified version of a **Tool**.
|
|
3206
|
+
|
|
3207
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
3208
3208
|
</dd>
|
|
3209
3209
|
</dl>
|
|
3210
3210
|
</dd>
|
|
@@ -3219,27 +3219,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
3219
3219
|
<dd>
|
|
3220
3220
|
|
|
3221
3221
|
```typescript
|
|
3222
|
-
|
|
3223
|
-
pageNumber: 0,
|
|
3224
|
-
pageSize: 3,
|
|
3225
|
-
ascendingOrder: true
|
|
3226
|
-
});
|
|
3227
|
-
for await (const item of pageableResponse) {
|
|
3228
|
-
console.log(item);
|
|
3229
|
-
}
|
|
3230
|
-
|
|
3231
|
-
// Or you can manually iterate page-by-page
|
|
3232
|
-
let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3233
|
-
pageNumber: 0,
|
|
3234
|
-
pageSize: 3,
|
|
3235
|
-
ascendingOrder: true
|
|
3236
|
-
});
|
|
3237
|
-
while (page.hasNextPage()) {
|
|
3238
|
-
page = page.getNextPage();
|
|
3239
|
-
}
|
|
3240
|
-
|
|
3241
|
-
// You can also access the underlying response
|
|
3242
|
-
const response = page.response;
|
|
3222
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
3243
3223
|
|
|
3244
3224
|
```
|
|
3245
3225
|
</dd>
|
|
@@ -3255,7 +3235,7 @@ const response = page.response;
|
|
|
3255
3235
|
<dl>
|
|
3256
3236
|
<dd>
|
|
3257
3237
|
|
|
3258
|
-
**id:** `string` — Identifier for a
|
|
3238
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3259
3239
|
|
|
3260
3240
|
</dd>
|
|
3261
3241
|
</dl>
|
|
@@ -3263,7 +3243,13 @@ const response = page.response;
|
|
|
3263
3243
|
<dl>
|
|
3264
3244
|
<dd>
|
|
3265
3245
|
|
|
3266
|
-
**
|
|
3246
|
+
**version:** `number`
|
|
3247
|
+
|
|
3248
|
+
Version number for a Tool.
|
|
3249
|
+
|
|
3250
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
3251
|
+
|
|
3252
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
3267
3253
|
|
|
3268
3254
|
</dd>
|
|
3269
3255
|
</dl>
|
|
@@ -3271,7 +3257,7 @@ const response = page.response;
|
|
|
3271
3257
|
<dl>
|
|
3272
3258
|
<dd>
|
|
3273
3259
|
|
|
3274
|
-
**requestOptions:** `
|
|
3260
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3275
3261
|
|
|
3276
3262
|
</dd>
|
|
3277
3263
|
</dl>
|
|
@@ -3283,7 +3269,7 @@ const response = page.response;
|
|
|
3283
3269
|
</dl>
|
|
3284
3270
|
</details>
|
|
3285
3271
|
|
|
3286
|
-
<details><summary><code>client.empathicVoice.
|
|
3272
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolDescription</a>(id, version, { ...params }) -> Hume.ReturnUserDefinedTool | undefined</code></summary>
|
|
3287
3273
|
<dl>
|
|
3288
3274
|
<dd>
|
|
3289
3275
|
|
|
@@ -3295,7 +3281,9 @@ const response = page.response;
|
|
|
3295
3281
|
<dl>
|
|
3296
3282
|
<dd>
|
|
3297
3283
|
|
|
3298
|
-
|
|
3284
|
+
Updates the description of a specified **Tool** version.
|
|
3285
|
+
|
|
3286
|
+
Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
3299
3287
|
</dd>
|
|
3300
3288
|
</dl>
|
|
3301
3289
|
</dd>
|
|
@@ -3310,10 +3298,8 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
|
|
|
3310
3298
|
<dd>
|
|
3311
3299
|
|
|
3312
3300
|
```typescript
|
|
3313
|
-
await client.empathicVoice.
|
|
3314
|
-
|
|
3315
|
-
pageSize: 10,
|
|
3316
|
-
ascendingOrder: true
|
|
3301
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
3302
|
+
versionDescription: "Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region."
|
|
3317
3303
|
});
|
|
3318
3304
|
|
|
3319
3305
|
```
|
|
@@ -3330,7 +3316,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3330
3316
|
<dl>
|
|
3331
3317
|
<dd>
|
|
3332
3318
|
|
|
3333
|
-
**id:** `string` — Identifier for a
|
|
3319
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3334
3320
|
|
|
3335
3321
|
</dd>
|
|
3336
3322
|
</dl>
|
|
@@ -3338,7 +3324,13 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3338
3324
|
<dl>
|
|
3339
3325
|
<dd>
|
|
3340
3326
|
|
|
3341
|
-
**
|
|
3327
|
+
**version:** `number`
|
|
3328
|
+
|
|
3329
|
+
Version number for a Tool.
|
|
3330
|
+
|
|
3331
|
+
Tools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
3332
|
+
|
|
3333
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
3342
3334
|
|
|
3343
3335
|
</dd>
|
|
3344
3336
|
</dl>
|
|
@@ -3346,7 +3338,15 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3346
3338
|
<dl>
|
|
3347
3339
|
<dd>
|
|
3348
3340
|
|
|
3349
|
-
**
|
|
3341
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
3342
|
+
|
|
3343
|
+
</dd>
|
|
3344
|
+
</dl>
|
|
3345
|
+
|
|
3346
|
+
<dl>
|
|
3347
|
+
<dd>
|
|
3348
|
+
|
|
3349
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3350
3350
|
|
|
3351
3351
|
</dd>
|
|
3352
3352
|
</dl>
|