hume 0.15.4 → 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.d.ts +2 -2
- package/dist/cjs/Client.js +6 -6
- 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/empathicVoice/types/ToolCallMessage.d.ts +3 -7
- 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/empathicVoice/types/ToolCallMessage.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ToolCallMessage.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.d.mts +2 -2
- package/dist/esm/Client.mjs +6 -6
- 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/empathicVoice/types/ToolCallMessage.d.mts +3 -7
- 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/empathicVoice/types/ToolCallMessage.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ToolCallMessage.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 +740 -740
package/reference.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
##
|
|
3
|
-
<details><summary><code>client.
|
|
2
|
+
## Tts
|
|
3
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
|
|
4
4
|
<dl>
|
|
5
5
|
<dd>
|
|
6
6
|
|
|
@@ -12,7 +12,9 @@
|
|
|
12
12
|
<dl>
|
|
13
13
|
<dd>
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
16
|
+
|
|
17
|
+
The response includes the base64-encoded audio and metadata in JSON format.
|
|
16
18
|
</dd>
|
|
17
19
|
</dl>
|
|
18
20
|
</dd>
|
|
@@ -27,8 +29,21 @@ Send a message to a specific chat.
|
|
|
27
29
|
<dd>
|
|
28
30
|
|
|
29
31
|
```typescript
|
|
30
|
-
await client.
|
|
31
|
-
|
|
32
|
+
await client.tts.synthesizeJson({
|
|
33
|
+
context: {
|
|
34
|
+
utterances: [{
|
|
35
|
+
text: "How can people see beauty so differently?",
|
|
36
|
+
description: "A curious student with a clear and respectful tone, seeking clarification on Hume's ideas with a straightforward question."
|
|
37
|
+
}]
|
|
38
|
+
},
|
|
39
|
+
format: {
|
|
40
|
+
type: "mp3"
|
|
41
|
+
},
|
|
42
|
+
numGenerations: 1,
|
|
43
|
+
utterances: [{
|
|
44
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
45
|
+
description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
|
|
46
|
+
}]
|
|
32
47
|
});
|
|
33
48
|
|
|
34
49
|
```
|
|
@@ -45,15 +60,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
45
60
|
<dl>
|
|
46
61
|
<dd>
|
|
47
62
|
|
|
48
|
-
**
|
|
49
|
-
|
|
50
|
-
</dd>
|
|
51
|
-
</dl>
|
|
52
|
-
|
|
53
|
-
<dl>
|
|
54
|
-
<dd>
|
|
55
|
-
|
|
56
|
-
**request:** `Hume.ControlPlanePublishEvent`
|
|
63
|
+
**request:** `Hume.PostedTts`
|
|
57
64
|
|
|
58
65
|
</dd>
|
|
59
66
|
</dl>
|
|
@@ -61,7 +68,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
61
68
|
<dl>
|
|
62
69
|
<dd>
|
|
63
70
|
|
|
64
|
-
**requestOptions:** `
|
|
71
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
65
72
|
|
|
66
73
|
</dd>
|
|
67
74
|
</dl>
|
|
@@ -73,8 +80,7 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
73
80
|
</dl>
|
|
74
81
|
</details>
|
|
75
82
|
|
|
76
|
-
|
|
77
|
-
<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>
|
|
83
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFile</a>({ ...params }) -> core.BinaryResponse</code></summary>
|
|
78
84
|
<dl>
|
|
79
85
|
<dd>
|
|
80
86
|
|
|
@@ -86,9 +92,9 @@ await client.empathicVoice.controlPlane.send("chat_id", {
|
|
|
86
92
|
<dl>
|
|
87
93
|
<dd>
|
|
88
94
|
|
|
89
|
-
|
|
95
|
+
Synthesizes one or more input texts into speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
90
96
|
|
|
91
|
-
|
|
97
|
+
The response contains the generated audio file in the requested format.
|
|
92
98
|
</dd>
|
|
93
99
|
</dl>
|
|
94
100
|
</dd>
|
|
@@ -103,25 +109,19 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
103
109
|
<dd>
|
|
104
110
|
|
|
105
111
|
```typescript
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
112
|
+
await client.tts.synthesizeFile({
|
|
113
|
+
context: {
|
|
114
|
+
generationId: "09ad914d-8e7f-40f8-a279-e34f07f7dab2"
|
|
115
|
+
},
|
|
116
|
+
format: {
|
|
117
|
+
type: "mp3"
|
|
118
|
+
},
|
|
119
|
+
numGenerations: 1,
|
|
120
|
+
utterances: [{
|
|
121
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
122
|
+
description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
|
|
123
|
+
}]
|
|
118
124
|
});
|
|
119
|
-
while (page.hasNextPage()) {
|
|
120
|
-
page = page.getNextPage();
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
// You can also access the underlying response
|
|
124
|
-
const response = page.response;
|
|
125
125
|
|
|
126
126
|
```
|
|
127
127
|
</dd>
|
|
@@ -137,7 +137,7 @@ const response = page.response;
|
|
|
137
137
|
<dl>
|
|
138
138
|
<dd>
|
|
139
139
|
|
|
140
|
-
**request:** `Hume.
|
|
140
|
+
**request:** `Hume.PostedTts`
|
|
141
141
|
|
|
142
142
|
</dd>
|
|
143
143
|
</dl>
|
|
@@ -145,7 +145,7 @@ const response = page.response;
|
|
|
145
145
|
<dl>
|
|
146
146
|
<dd>
|
|
147
147
|
|
|
148
|
-
**requestOptions:** `
|
|
148
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
149
149
|
|
|
150
150
|
</dd>
|
|
151
151
|
</dl>
|
|
@@ -157,7 +157,7 @@ const response = page.response;
|
|
|
157
157
|
</dl>
|
|
158
158
|
</details>
|
|
159
159
|
|
|
160
|
-
<details><summary><code>client.
|
|
160
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeFileStreaming</a>({ ...params }) -> core.BinaryResponse</code></summary>
|
|
161
161
|
<dl>
|
|
162
162
|
<dd>
|
|
163
163
|
|
|
@@ -169,9 +169,7 @@ const response = page.response;
|
|
|
169
169
|
<dl>
|
|
170
170
|
<dd>
|
|
171
171
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
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.
|
|
172
|
+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
175
173
|
</dd>
|
|
176
174
|
</dl>
|
|
177
175
|
</dd>
|
|
@@ -186,12 +184,14 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
186
184
|
<dd>
|
|
187
185
|
|
|
188
186
|
```typescript
|
|
189
|
-
await client.
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
187
|
+
await client.tts.synthesizeFileStreaming({
|
|
188
|
+
utterances: [{
|
|
189
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
190
|
+
voice: {
|
|
191
|
+
name: "Male English Actor",
|
|
192
|
+
provider: "HUME_AI"
|
|
193
|
+
}
|
|
194
|
+
}]
|
|
195
195
|
});
|
|
196
196
|
|
|
197
197
|
```
|
|
@@ -208,7 +208,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
208
208
|
<dl>
|
|
209
209
|
<dd>
|
|
210
210
|
|
|
211
|
-
**request:** `Hume.
|
|
211
|
+
**request:** `Hume.PostedTts`
|
|
212
212
|
|
|
213
213
|
</dd>
|
|
214
214
|
</dl>
|
|
@@ -216,7 +216,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
216
216
|
<dl>
|
|
217
217
|
<dd>
|
|
218
218
|
|
|
219
|
-
**requestOptions:** `
|
|
219
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
220
220
|
|
|
221
221
|
</dd>
|
|
222
222
|
</dl>
|
|
@@ -228,7 +228,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
228
228
|
</dl>
|
|
229
229
|
</details>
|
|
230
230
|
|
|
231
|
-
<details><summary><code>client.
|
|
231
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJsonStreaming</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
|
|
232
232
|
<dl>
|
|
233
233
|
<dd>
|
|
234
234
|
|
|
@@ -240,9 +240,9 @@ await client.empathicVoice.tools.createTool({
|
|
|
240
240
|
<dl>
|
|
241
241
|
<dd>
|
|
242
242
|
|
|
243
|
-
|
|
243
|
+
Streams synthesized speech using the specified voice. If no voice is provided, a novel voice will be generated dynamically. Optionally, additional context can be included to influence the speech's style and prosody.
|
|
244
244
|
|
|
245
|
-
|
|
245
|
+
The response is a stream of JSON objects including audio encoded in base64.
|
|
246
246
|
</dd>
|
|
247
247
|
</dl>
|
|
248
248
|
</dd>
|
|
@@ -257,20 +257,19 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
257
257
|
<dd>
|
|
258
258
|
|
|
259
259
|
```typescript
|
|
260
|
-
const
|
|
261
|
-
|
|
260
|
+
const response = await client.tts.synthesizeJsonStreaming({
|
|
261
|
+
utterances: [{
|
|
262
|
+
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
263
|
+
voice: {
|
|
264
|
+
name: "Male English Actor",
|
|
265
|
+
provider: "HUME_AI"
|
|
266
|
+
}
|
|
267
|
+
}]
|
|
268
|
+
});
|
|
269
|
+
for await (const item of response) {
|
|
262
270
|
console.log(item);
|
|
263
271
|
}
|
|
264
272
|
|
|
265
|
-
// Or you can manually iterate page-by-page
|
|
266
|
-
let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
267
|
-
while (page.hasNextPage()) {
|
|
268
|
-
page = page.getNextPage();
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
// You can also access the underlying response
|
|
272
|
-
const response = page.response;
|
|
273
|
-
|
|
274
273
|
```
|
|
275
274
|
</dd>
|
|
276
275
|
</dl>
|
|
@@ -285,15 +284,7 @@ const response = page.response;
|
|
|
285
284
|
<dl>
|
|
286
285
|
<dd>
|
|
287
286
|
|
|
288
|
-
**
|
|
289
|
-
|
|
290
|
-
</dd>
|
|
291
|
-
</dl>
|
|
292
|
-
|
|
293
|
-
<dl>
|
|
294
|
-
<dd>
|
|
295
|
-
|
|
296
|
-
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
287
|
+
**request:** `Hume.PostedTts`
|
|
297
288
|
|
|
298
289
|
</dd>
|
|
299
290
|
</dl>
|
|
@@ -301,7 +292,7 @@ const response = page.response;
|
|
|
301
292
|
<dl>
|
|
302
293
|
<dd>
|
|
303
294
|
|
|
304
|
-
**requestOptions:** `
|
|
295
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
305
296
|
|
|
306
297
|
</dd>
|
|
307
298
|
</dl>
|
|
@@ -313,26 +304,10 @@ const response = page.response;
|
|
|
313
304
|
</dl>
|
|
314
305
|
</details>
|
|
315
306
|
|
|
316
|
-
<details><summary><code>client.
|
|
317
|
-
<dl>
|
|
318
|
-
<dd>
|
|
319
|
-
|
|
320
|
-
#### 📝 Description
|
|
321
|
-
|
|
322
|
-
<dl>
|
|
323
|
-
<dd>
|
|
324
|
-
|
|
307
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">convertVoiceJson</a>({ ...params }) -> core.Stream<Hume.TtsOutput></code></summary>
|
|
325
308
|
<dl>
|
|
326
309
|
<dd>
|
|
327
310
|
|
|
328
|
-
Updates a **Tool** by creating a new version of the **Tool**.
|
|
329
|
-
|
|
330
|
-
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.
|
|
331
|
-
</dd>
|
|
332
|
-
</dl>
|
|
333
|
-
</dd>
|
|
334
|
-
</dl>
|
|
335
|
-
|
|
336
311
|
#### 🔌 Usage
|
|
337
312
|
|
|
338
313
|
<dl>
|
|
@@ -342,12 +317,10 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
342
317
|
<dd>
|
|
343
318
|
|
|
344
319
|
```typescript
|
|
345
|
-
await client.
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
description: "This tool is for getting the current weather."
|
|
350
|
-
});
|
|
320
|
+
const response = await client.tts.convertVoiceJson({});
|
|
321
|
+
for await (const item of response) {
|
|
322
|
+
console.log(item);
|
|
323
|
+
}
|
|
351
324
|
|
|
352
325
|
```
|
|
353
326
|
</dd>
|
|
@@ -363,15 +336,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
363
336
|
<dl>
|
|
364
337
|
<dd>
|
|
365
338
|
|
|
366
|
-
**
|
|
367
|
-
|
|
368
|
-
</dd>
|
|
369
|
-
</dl>
|
|
370
|
-
|
|
371
|
-
<dl>
|
|
372
|
-
<dd>
|
|
373
|
-
|
|
374
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
339
|
+
**request:** `Hume.tts.ConvertVoiceJsonRequest`
|
|
375
340
|
|
|
376
341
|
</dd>
|
|
377
342
|
</dl>
|
|
@@ -379,7 +344,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
379
344
|
<dl>
|
|
380
345
|
<dd>
|
|
381
346
|
|
|
382
|
-
**requestOptions:** `
|
|
347
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
383
348
|
|
|
384
349
|
</dd>
|
|
385
350
|
</dl>
|
|
@@ -391,7 +356,8 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
391
356
|
</dl>
|
|
392
357
|
</details>
|
|
393
358
|
|
|
394
|
-
|
|
359
|
+
## Tts Voices
|
|
360
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
|
|
395
361
|
<dl>
|
|
396
362
|
<dd>
|
|
397
363
|
|
|
@@ -403,9 +369,7 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
403
369
|
<dl>
|
|
404
370
|
<dd>
|
|
405
371
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
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.
|
|
372
|
+
Lists voices you have saved in your account, or voices from the [Voice Library](https://platform.hume.ai/tts/voice-library).
|
|
409
373
|
</dd>
|
|
410
374
|
</dl>
|
|
411
375
|
</dd>
|
|
@@ -420,7 +384,23 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
420
384
|
<dd>
|
|
421
385
|
|
|
422
386
|
```typescript
|
|
423
|
-
await client.
|
|
387
|
+
const pageableResponse = await client.tts.voices.list({
|
|
388
|
+
provider: "CUSTOM_VOICE"
|
|
389
|
+
});
|
|
390
|
+
for await (const item of pageableResponse) {
|
|
391
|
+
console.log(item);
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
// Or you can manually iterate page-by-page
|
|
395
|
+
let page = await client.tts.voices.list({
|
|
396
|
+
provider: "CUSTOM_VOICE"
|
|
397
|
+
});
|
|
398
|
+
while (page.hasNextPage()) {
|
|
399
|
+
page = page.getNextPage();
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
// You can also access the underlying response
|
|
403
|
+
const response = page.response;
|
|
424
404
|
|
|
425
405
|
```
|
|
426
406
|
</dd>
|
|
@@ -436,7 +416,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
436
416
|
<dl>
|
|
437
417
|
<dd>
|
|
438
418
|
|
|
439
|
-
**
|
|
419
|
+
**request:** `Hume.tts.VoicesListRequest`
|
|
440
420
|
|
|
441
421
|
</dd>
|
|
442
422
|
</dl>
|
|
@@ -444,7 +424,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
444
424
|
<dl>
|
|
445
425
|
<dd>
|
|
446
426
|
|
|
447
|
-
**requestOptions:** `
|
|
427
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
448
428
|
|
|
449
429
|
</dd>
|
|
450
430
|
</dl>
|
|
@@ -456,7 +436,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
456
436
|
</dl>
|
|
457
437
|
</details>
|
|
458
438
|
|
|
459
|
-
<details><summary><code>client.
|
|
439
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">create</a>({ ...params }) -> Hume.ReturnVoice</code></summary>
|
|
460
440
|
<dl>
|
|
461
441
|
<dd>
|
|
462
442
|
|
|
@@ -468,9 +448,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
468
448
|
<dl>
|
|
469
449
|
<dd>
|
|
470
450
|
|
|
471
|
-
|
|
451
|
+
Saves a new custom voice to your account using the specified TTS generation ID.
|
|
472
452
|
|
|
473
|
-
|
|
453
|
+
Once saved, this voice can be reused in subsequent TTS requests, ensuring consistent speech style and prosody. For more details on voice creation, see the [Voices Guide](/docs/text-to-speech-tts/voices).
|
|
474
454
|
</dd>
|
|
475
455
|
</dl>
|
|
476
456
|
</dd>
|
|
@@ -485,8 +465,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
485
465
|
<dd>
|
|
486
466
|
|
|
487
467
|
```typescript
|
|
488
|
-
await client.
|
|
489
|
-
|
|
468
|
+
await client.tts.voices.create({
|
|
469
|
+
generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
|
|
470
|
+
name: "David Hume"
|
|
490
471
|
});
|
|
491
472
|
|
|
492
473
|
```
|
|
@@ -503,15 +484,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
503
484
|
<dl>
|
|
504
485
|
<dd>
|
|
505
486
|
|
|
506
|
-
**
|
|
507
|
-
|
|
508
|
-
</dd>
|
|
509
|
-
</dl>
|
|
510
|
-
|
|
511
|
-
<dl>
|
|
512
|
-
<dd>
|
|
513
|
-
|
|
514
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
487
|
+
**request:** `Hume.tts.PostedVoice`
|
|
515
488
|
|
|
516
489
|
</dd>
|
|
517
490
|
</dl>
|
|
@@ -519,7 +492,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
519
492
|
<dl>
|
|
520
493
|
<dd>
|
|
521
494
|
|
|
522
|
-
**requestOptions:** `
|
|
495
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
523
496
|
|
|
524
497
|
</dd>
|
|
525
498
|
</dl>
|
|
@@ -531,7 +504,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
531
504
|
</dl>
|
|
532
505
|
</details>
|
|
533
506
|
|
|
534
|
-
<details><summary><code>client.
|
|
507
|
+
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
|
535
508
|
<dl>
|
|
536
509
|
<dd>
|
|
537
510
|
|
|
@@ -543,9 +516,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
543
516
|
<dl>
|
|
544
517
|
<dd>
|
|
545
518
|
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
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.
|
|
519
|
+
Deletes a previously generated custom voice.
|
|
549
520
|
</dd>
|
|
550
521
|
</dl>
|
|
551
522
|
</dd>
|
|
@@ -560,7 +531,9 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
560
531
|
<dd>
|
|
561
532
|
|
|
562
533
|
```typescript
|
|
563
|
-
await client.
|
|
534
|
+
await client.tts.voices.delete({
|
|
535
|
+
name: "David Hume"
|
|
536
|
+
});
|
|
564
537
|
|
|
565
538
|
```
|
|
566
539
|
</dd>
|
|
@@ -576,7 +549,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
576
549
|
<dl>
|
|
577
550
|
<dd>
|
|
578
551
|
|
|
579
|
-
**
|
|
552
|
+
**request:** `Hume.tts.VoicesDeleteRequest`
|
|
580
553
|
|
|
581
554
|
</dd>
|
|
582
555
|
</dl>
|
|
@@ -584,103 +557,10 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
584
557
|
<dl>
|
|
585
558
|
<dd>
|
|
586
559
|
|
|
587
|
-
**
|
|
588
|
-
|
|
589
|
-
Version number for a Tool.
|
|
590
|
-
|
|
591
|
-
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.
|
|
592
|
-
|
|
593
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
560
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
594
561
|
|
|
595
|
-
</dd>
|
|
596
|
-
</dl>
|
|
597
|
-
|
|
598
|
-
<dl>
|
|
599
|
-
<dd>
|
|
600
|
-
|
|
601
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
602
|
-
|
|
603
|
-
</dd>
|
|
604
|
-
</dl>
|
|
605
|
-
</dd>
|
|
606
|
-
</dl>
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
</dd>
|
|
610
|
-
</dl>
|
|
611
|
-
</details>
|
|
612
|
-
|
|
613
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
614
|
-
<dl>
|
|
615
|
-
<dd>
|
|
616
|
-
|
|
617
|
-
#### 📝 Description
|
|
618
|
-
|
|
619
|
-
<dl>
|
|
620
|
-
<dd>
|
|
621
|
-
|
|
622
|
-
<dl>
|
|
623
|
-
<dd>
|
|
624
|
-
|
|
625
|
-
Deletes a specified version of a **Tool**.
|
|
626
|
-
|
|
627
|
-
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.
|
|
628
|
-
</dd>
|
|
629
|
-
</dl>
|
|
630
|
-
</dd>
|
|
631
|
-
</dl>
|
|
632
|
-
|
|
633
|
-
#### 🔌 Usage
|
|
634
|
-
|
|
635
|
-
<dl>
|
|
636
|
-
<dd>
|
|
637
|
-
|
|
638
|
-
<dl>
|
|
639
|
-
<dd>
|
|
640
|
-
|
|
641
|
-
```typescript
|
|
642
|
-
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
643
|
-
|
|
644
|
-
```
|
|
645
|
-
</dd>
|
|
646
|
-
</dl>
|
|
647
|
-
</dd>
|
|
648
|
-
</dl>
|
|
649
|
-
|
|
650
|
-
#### ⚙️ Parameters
|
|
651
|
-
|
|
652
|
-
<dl>
|
|
653
|
-
<dd>
|
|
654
|
-
|
|
655
|
-
<dl>
|
|
656
|
-
<dd>
|
|
657
|
-
|
|
658
|
-
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
659
|
-
|
|
660
|
-
</dd>
|
|
661
|
-
</dl>
|
|
662
|
-
|
|
663
|
-
<dl>
|
|
664
|
-
<dd>
|
|
665
|
-
|
|
666
|
-
**version:** `number`
|
|
667
|
-
|
|
668
|
-
Version number for a Tool.
|
|
669
|
-
|
|
670
|
-
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.
|
|
671
|
-
|
|
672
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
673
|
-
|
|
674
|
-
</dd>
|
|
675
|
-
</dl>
|
|
676
|
-
|
|
677
|
-
<dl>
|
|
678
|
-
<dd>
|
|
679
|
-
|
|
680
|
-
**requestOptions:** `Tools.RequestOptions`
|
|
681
|
-
|
|
682
|
-
</dd>
|
|
683
|
-
</dl>
|
|
562
|
+
</dd>
|
|
563
|
+
</dl>
|
|
684
564
|
</dd>
|
|
685
565
|
</dl>
|
|
686
566
|
|
|
@@ -689,7 +569,8 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
689
569
|
</dl>
|
|
690
570
|
</details>
|
|
691
571
|
|
|
692
|
-
|
|
572
|
+
## EmpathicVoice ControlPlane
|
|
573
|
+
<details><summary><code>client.empathicVoice.controlPlane.<a href="/src/api/resources/empathicVoice/resources/controlPlane/client/Client.ts">send</a>(chatId, { ...params }) -> void</code></summary>
|
|
693
574
|
<dl>
|
|
694
575
|
<dd>
|
|
695
576
|
|
|
@@ -701,9 +582,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
701
582
|
<dl>
|
|
702
583
|
<dd>
|
|
703
584
|
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
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.
|
|
585
|
+
Send a message to a specific chat.
|
|
707
586
|
</dd>
|
|
708
587
|
</dl>
|
|
709
588
|
</dd>
|
|
@@ -718,8 +597,8 @@ Refer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-ca
|
|
|
718
597
|
<dd>
|
|
719
598
|
|
|
720
599
|
```typescript
|
|
721
|
-
await client.empathicVoice.
|
|
722
|
-
|
|
600
|
+
await client.empathicVoice.controlPlane.send("chat_id", {
|
|
601
|
+
type: "session_settings"
|
|
723
602
|
});
|
|
724
603
|
|
|
725
604
|
```
|
|
@@ -736,21 +615,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
736
615
|
<dl>
|
|
737
616
|
<dd>
|
|
738
617
|
|
|
739
|
-
**
|
|
740
|
-
|
|
741
|
-
</dd>
|
|
742
|
-
</dl>
|
|
743
|
-
|
|
744
|
-
<dl>
|
|
745
|
-
<dd>
|
|
746
|
-
|
|
747
|
-
**version:** `number`
|
|
748
|
-
|
|
749
|
-
Version number for a Tool.
|
|
750
|
-
|
|
751
|
-
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.
|
|
752
|
-
|
|
753
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
618
|
+
**chatId:** `string`
|
|
754
619
|
|
|
755
620
|
</dd>
|
|
756
621
|
</dl>
|
|
@@ -758,7 +623,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
758
623
|
<dl>
|
|
759
624
|
<dd>
|
|
760
625
|
|
|
761
|
-
**request:** `Hume.
|
|
626
|
+
**request:** `Hume.ControlPlanePublishEvent`
|
|
762
627
|
|
|
763
628
|
</dd>
|
|
764
629
|
</dl>
|
|
@@ -766,7 +631,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
766
631
|
<dl>
|
|
767
632
|
<dd>
|
|
768
633
|
|
|
769
|
-
**requestOptions:** `
|
|
634
|
+
**requestOptions:** `ControlPlane.RequestOptions`
|
|
770
635
|
|
|
771
636
|
</dd>
|
|
772
637
|
</dl>
|
|
@@ -778,8 +643,8 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
778
643
|
</dl>
|
|
779
644
|
</details>
|
|
780
645
|
|
|
781
|
-
## EmpathicVoice
|
|
782
|
-
<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>
|
|
783
648
|
<dl>
|
|
784
649
|
<dd>
|
|
785
650
|
|
|
@@ -791,9 +656,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
791
656
|
<dl>
|
|
792
657
|
<dd>
|
|
793
658
|
|
|
794
|
-
Fetches a paginated list of **
|
|
795
|
-
|
|
796
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
659
|
+
Fetches a paginated list of **Chat Groups**.
|
|
797
660
|
</dd>
|
|
798
661
|
</dl>
|
|
799
662
|
</dd>
|
|
@@ -808,18 +671,22 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
808
671
|
<dd>
|
|
809
672
|
|
|
810
673
|
```typescript
|
|
811
|
-
const pageableResponse = await client.empathicVoice.
|
|
674
|
+
const pageableResponse = await client.empathicVoice.chatGroups.listChatGroups({
|
|
812
675
|
pageNumber: 0,
|
|
813
|
-
pageSize:
|
|
676
|
+
pageSize: 1,
|
|
677
|
+
ascendingOrder: true,
|
|
678
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
814
679
|
});
|
|
815
680
|
for await (const item of pageableResponse) {
|
|
816
681
|
console.log(item);
|
|
817
682
|
}
|
|
818
683
|
|
|
819
684
|
// Or you can manually iterate page-by-page
|
|
820
|
-
let page = await client.empathicVoice.
|
|
685
|
+
let page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
821
686
|
pageNumber: 0,
|
|
822
|
-
pageSize:
|
|
687
|
+
pageSize: 1,
|
|
688
|
+
ascendingOrder: true,
|
|
689
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
823
690
|
});
|
|
824
691
|
while (page.hasNextPage()) {
|
|
825
692
|
page = page.getNextPage();
|
|
@@ -842,7 +709,7 @@ const response = page.response;
|
|
|
842
709
|
<dl>
|
|
843
710
|
<dd>
|
|
844
711
|
|
|
845
|
-
**request:** `Hume.empathicVoice.
|
|
712
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
846
713
|
|
|
847
714
|
</dd>
|
|
848
715
|
</dl>
|
|
@@ -850,7 +717,7 @@ const response = page.response;
|
|
|
850
717
|
<dl>
|
|
851
718
|
<dd>
|
|
852
719
|
|
|
853
|
-
**requestOptions:** `
|
|
720
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
854
721
|
|
|
855
722
|
</dd>
|
|
856
723
|
</dl>
|
|
@@ -862,7 +729,7 @@ const response = page.response;
|
|
|
862
729
|
</dl>
|
|
863
730
|
</details>
|
|
864
731
|
|
|
865
|
-
<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>
|
|
866
733
|
<dl>
|
|
867
734
|
<dd>
|
|
868
735
|
|
|
@@ -874,9 +741,7 @@ const response = page.response;
|
|
|
874
741
|
<dl>
|
|
875
742
|
<dd>
|
|
876
743
|
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
744
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
880
745
|
</dd>
|
|
881
746
|
</dl>
|
|
882
747
|
</dd>
|
|
@@ -891,9 +756,10 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
891
756
|
<dd>
|
|
892
757
|
|
|
893
758
|
```typescript
|
|
894
|
-
await client.empathicVoice.
|
|
895
|
-
|
|
896
|
-
|
|
759
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
760
|
+
pageNumber: 0,
|
|
761
|
+
pageSize: 1,
|
|
762
|
+
ascendingOrder: true
|
|
897
763
|
});
|
|
898
764
|
|
|
899
765
|
```
|
|
@@ -910,72 +776,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
910
776
|
<dl>
|
|
911
777
|
<dd>
|
|
912
778
|
|
|
913
|
-
**
|
|
914
|
-
|
|
915
|
-
</dd>
|
|
916
|
-
</dl>
|
|
917
|
-
|
|
918
|
-
<dl>
|
|
919
|
-
<dd>
|
|
920
|
-
|
|
921
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
922
|
-
|
|
923
|
-
</dd>
|
|
924
|
-
</dl>
|
|
925
|
-
</dd>
|
|
926
|
-
</dl>
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
</dd>
|
|
930
|
-
</dl>
|
|
931
|
-
</details>
|
|
932
|
-
|
|
933
|
-
<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>
|
|
934
|
-
<dl>
|
|
935
|
-
<dd>
|
|
936
|
-
|
|
937
|
-
#### 📝 Description
|
|
938
|
-
|
|
939
|
-
<dl>
|
|
940
|
-
<dd>
|
|
941
|
-
|
|
942
|
-
<dl>
|
|
943
|
-
<dd>
|
|
944
|
-
|
|
945
|
-
Fetches a list of a **Prompt's** versions.
|
|
946
|
-
|
|
947
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
948
|
-
</dd>
|
|
949
|
-
</dl>
|
|
950
|
-
</dd>
|
|
951
|
-
</dl>
|
|
952
|
-
|
|
953
|
-
#### 🔌 Usage
|
|
954
|
-
|
|
955
|
-
<dl>
|
|
956
|
-
<dd>
|
|
957
|
-
|
|
958
|
-
<dl>
|
|
959
|
-
<dd>
|
|
960
|
-
|
|
961
|
-
```typescript
|
|
962
|
-
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
963
|
-
|
|
964
|
-
```
|
|
965
|
-
</dd>
|
|
966
|
-
</dl>
|
|
967
|
-
</dd>
|
|
968
|
-
</dl>
|
|
969
|
-
|
|
970
|
-
#### ⚙️ Parameters
|
|
971
|
-
|
|
972
|
-
<dl>
|
|
973
|
-
<dd>
|
|
974
|
-
|
|
975
|
-
<dl>
|
|
976
|
-
<dd>
|
|
977
|
-
|
|
978
|
-
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
779
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
979
780
|
|
|
980
781
|
</dd>
|
|
981
782
|
</dl>
|
|
@@ -983,7 +784,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
983
784
|
<dl>
|
|
984
785
|
<dd>
|
|
985
786
|
|
|
986
|
-
**request:** `Hume.empathicVoice.
|
|
787
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
987
788
|
|
|
988
789
|
</dd>
|
|
989
790
|
</dl>
|
|
@@ -991,7 +792,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
991
792
|
<dl>
|
|
992
793
|
<dd>
|
|
993
794
|
|
|
994
|
-
**requestOptions:** `
|
|
795
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
995
796
|
|
|
996
797
|
</dd>
|
|
997
798
|
</dl>
|
|
@@ -1003,7 +804,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1003
804
|
</dl>
|
|
1004
805
|
</details>
|
|
1005
806
|
|
|
1006
|
-
<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>
|
|
1007
808
|
<dl>
|
|
1008
809
|
<dd>
|
|
1009
810
|
|
|
@@ -1015,9 +816,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1015
816
|
<dl>
|
|
1016
817
|
<dd>
|
|
1017
818
|
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
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).
|
|
1021
820
|
</dd>
|
|
1022
821
|
</dl>
|
|
1023
822
|
</dd>
|
|
@@ -1032,9 +831,10 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1032
831
|
<dd>
|
|
1033
832
|
|
|
1034
833
|
```typescript
|
|
1035
|
-
await client.empathicVoice.
|
|
1036
|
-
|
|
1037
|
-
|
|
834
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
835
|
+
pageNumber: 0,
|
|
836
|
+
pageSize: 10,
|
|
837
|
+
ascendingOrder: true
|
|
1038
838
|
});
|
|
1039
839
|
|
|
1040
840
|
```
|
|
@@ -1051,7 +851,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1051
851
|
<dl>
|
|
1052
852
|
<dd>
|
|
1053
853
|
|
|
1054
|
-
**id:** `string` — Identifier for a
|
|
854
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
1055
855
|
|
|
1056
856
|
</dd>
|
|
1057
857
|
</dl>
|
|
@@ -1059,7 +859,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1059
859
|
<dl>
|
|
1060
860
|
<dd>
|
|
1061
861
|
|
|
1062
|
-
**request:** `Hume.empathicVoice.
|
|
862
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
1063
863
|
|
|
1064
864
|
</dd>
|
|
1065
865
|
</dl>
|
|
@@ -1067,7 +867,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1067
867
|
<dl>
|
|
1068
868
|
<dd>
|
|
1069
869
|
|
|
1070
|
-
**requestOptions:** `
|
|
870
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
1071
871
|
|
|
1072
872
|
</dd>
|
|
1073
873
|
</dl>
|
|
@@ -1079,7 +879,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1079
879
|
</dl>
|
|
1080
880
|
</details>
|
|
1081
881
|
|
|
1082
|
-
<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>
|
|
1083
883
|
<dl>
|
|
1084
884
|
<dd>
|
|
1085
885
|
|
|
@@ -1091,9 +891,7 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1091
891
|
<dl>
|
|
1092
892
|
<dd>
|
|
1093
893
|
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
894
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
1097
895
|
</dd>
|
|
1098
896
|
</dl>
|
|
1099
897
|
</dd>
|
|
@@ -1108,74 +906,27 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1108
906
|
<dd>
|
|
1109
907
|
|
|
1110
908
|
```typescript
|
|
1111
|
-
await client.empathicVoice.
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
#### ⚙️ Parameters
|
|
1120
|
-
|
|
1121
|
-
<dl>
|
|
1122
|
-
<dd>
|
|
1123
|
-
|
|
1124
|
-
<dl>
|
|
1125
|
-
<dd>
|
|
1126
|
-
|
|
1127
|
-
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1128
|
-
|
|
1129
|
-
</dd>
|
|
1130
|
-
</dl>
|
|
1131
|
-
|
|
1132
|
-
<dl>
|
|
1133
|
-
<dd>
|
|
1134
|
-
|
|
1135
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
1136
|
-
|
|
1137
|
-
</dd>
|
|
1138
|
-
</dl>
|
|
1139
|
-
</dd>
|
|
1140
|
-
</dl>
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
</dd>
|
|
1144
|
-
</dl>
|
|
1145
|
-
</details>
|
|
1146
|
-
|
|
1147
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1148
|
-
<dl>
|
|
1149
|
-
<dd>
|
|
1150
|
-
|
|
1151
|
-
#### 📝 Description
|
|
1152
|
-
|
|
1153
|
-
<dl>
|
|
1154
|
-
<dd>
|
|
1155
|
-
|
|
1156
|
-
<dl>
|
|
1157
|
-
<dd>
|
|
1158
|
-
|
|
1159
|
-
Updates the name of a **Prompt**.
|
|
1160
|
-
|
|
1161
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1162
|
-
</dd>
|
|
1163
|
-
</dl>
|
|
1164
|
-
</dd>
|
|
1165
|
-
</dl>
|
|
1166
|
-
|
|
1167
|
-
#### 🔌 Usage
|
|
1168
|
-
|
|
1169
|
-
<dl>
|
|
1170
|
-
<dd>
|
|
1171
|
-
|
|
1172
|
-
<dl>
|
|
1173
|
-
<dd>
|
|
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
|
+
}
|
|
1174
917
|
|
|
1175
|
-
|
|
1176
|
-
await client.empathicVoice.
|
|
1177
|
-
|
|
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
|
|
1178
923
|
});
|
|
924
|
+
while (page.hasNextPage()) {
|
|
925
|
+
page = page.getNextPage();
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
// You can also access the underlying response
|
|
929
|
+
const response = page.response;
|
|
1179
930
|
|
|
1180
931
|
```
|
|
1181
932
|
</dd>
|
|
@@ -1191,7 +942,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1191
942
|
<dl>
|
|
1192
943
|
<dd>
|
|
1193
944
|
|
|
1194
|
-
**id:** `string` — Identifier for a
|
|
945
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
1195
946
|
|
|
1196
947
|
</dd>
|
|
1197
948
|
</dl>
|
|
@@ -1199,7 +950,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1199
950
|
<dl>
|
|
1200
951
|
<dd>
|
|
1201
952
|
|
|
1202
|
-
**request:** `Hume.empathicVoice.
|
|
953
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
1203
954
|
|
|
1204
955
|
</dd>
|
|
1205
956
|
</dl>
|
|
@@ -1207,7 +958,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1207
958
|
<dl>
|
|
1208
959
|
<dd>
|
|
1209
960
|
|
|
1210
|
-
**requestOptions:** `
|
|
961
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
1211
962
|
|
|
1212
963
|
</dd>
|
|
1213
964
|
</dl>
|
|
@@ -1219,7 +970,8 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1219
970
|
</dl>
|
|
1220
971
|
</details>
|
|
1221
972
|
|
|
1222
|
-
|
|
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>
|
|
1223
975
|
<dl>
|
|
1224
976
|
<dd>
|
|
1225
977
|
|
|
@@ -1231,9 +983,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1231
983
|
<dl>
|
|
1232
984
|
<dd>
|
|
1233
985
|
|
|
1234
|
-
Fetches a
|
|
1235
|
-
|
|
1236
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
986
|
+
Fetches a paginated list of **Chats**.
|
|
1237
987
|
</dd>
|
|
1238
988
|
</dl>
|
|
1239
989
|
</dd>
|
|
@@ -1248,7 +998,27 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1248
998
|
<dd>
|
|
1249
999
|
|
|
1250
1000
|
```typescript
|
|
1251
|
-
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;
|
|
1252
1022
|
|
|
1253
1023
|
```
|
|
1254
1024
|
</dd>
|
|
@@ -1264,21 +1034,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1264
1034
|
<dl>
|
|
1265
1035
|
<dd>
|
|
1266
1036
|
|
|
1267
|
-
**
|
|
1268
|
-
|
|
1269
|
-
</dd>
|
|
1270
|
-
</dl>
|
|
1271
|
-
|
|
1272
|
-
<dl>
|
|
1273
|
-
<dd>
|
|
1274
|
-
|
|
1275
|
-
**version:** `number`
|
|
1276
|
-
|
|
1277
|
-
Version number for a Prompt.
|
|
1278
|
-
|
|
1279
|
-
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.
|
|
1280
|
-
|
|
1281
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1037
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
1282
1038
|
|
|
1283
1039
|
</dd>
|
|
1284
1040
|
</dl>
|
|
@@ -1286,7 +1042,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1286
1042
|
<dl>
|
|
1287
1043
|
<dd>
|
|
1288
1044
|
|
|
1289
|
-
**requestOptions:** `
|
|
1045
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1290
1046
|
|
|
1291
1047
|
</dd>
|
|
1292
1048
|
</dl>
|
|
@@ -1298,7 +1054,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1298
1054
|
</dl>
|
|
1299
1055
|
</details>
|
|
1300
1056
|
|
|
1301
|
-
<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>
|
|
1302
1058
|
<dl>
|
|
1303
1059
|
<dd>
|
|
1304
1060
|
|
|
@@ -1310,9 +1066,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1310
1066
|
<dl>
|
|
1311
1067
|
<dd>
|
|
1312
1068
|
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1069
|
+
Fetches a paginated list of **Chat** events.
|
|
1316
1070
|
</dd>
|
|
1317
1071
|
</dl>
|
|
1318
1072
|
</dd>
|
|
@@ -1327,7 +1081,27 @@ See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for t
|
|
|
1327
1081
|
<dd>
|
|
1328
1082
|
|
|
1329
1083
|
```typescript
|
|
1330
|
-
await client.empathicVoice.
|
|
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
|
|
1098
|
+
});
|
|
1099
|
+
while (page.hasNextPage()) {
|
|
1100
|
+
page = page.getNextPage();
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
// You can also access the underlying response
|
|
1104
|
+
const response = page.response;
|
|
1331
1105
|
|
|
1332
1106
|
```
|
|
1333
1107
|
</dd>
|
|
@@ -1343,7 +1117,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1343
1117
|
<dl>
|
|
1344
1118
|
<dd>
|
|
1345
1119
|
|
|
1346
|
-
**id:** `string` — Identifier for a
|
|
1120
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
1347
1121
|
|
|
1348
1122
|
</dd>
|
|
1349
1123
|
</dl>
|
|
@@ -1351,13 +1125,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1351
1125
|
<dl>
|
|
1352
1126
|
<dd>
|
|
1353
1127
|
|
|
1354
|
-
**
|
|
1355
|
-
|
|
1356
|
-
Version number for a Prompt.
|
|
1357
|
-
|
|
1358
|
-
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.
|
|
1359
|
-
|
|
1360
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1128
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
1361
1129
|
|
|
1362
1130
|
</dd>
|
|
1363
1131
|
</dl>
|
|
@@ -1365,7 +1133,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1365
1133
|
<dl>
|
|
1366
1134
|
<dd>
|
|
1367
1135
|
|
|
1368
|
-
**requestOptions:** `
|
|
1136
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1369
1137
|
|
|
1370
1138
|
</dd>
|
|
1371
1139
|
</dl>
|
|
@@ -1377,7 +1145,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1377
1145
|
</dl>
|
|
1378
1146
|
</details>
|
|
1379
1147
|
|
|
1380
|
-
<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>
|
|
1381
1149
|
<dl>
|
|
1382
1150
|
<dd>
|
|
1383
1151
|
|
|
@@ -1389,34 +1157,13 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1389
1157
|
<dl>
|
|
1390
1158
|
<dd>
|
|
1391
1159
|
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1395
|
-
</dd>
|
|
1396
|
-
</dl>
|
|
1397
|
-
</dd>
|
|
1398
|
-
</dl>
|
|
1399
|
-
|
|
1400
|
-
#### 🔌 Usage
|
|
1401
|
-
|
|
1402
|
-
<dl>
|
|
1403
|
-
<dd>
|
|
1404
|
-
|
|
1405
|
-
<dl>
|
|
1406
|
-
<dd>
|
|
1407
|
-
|
|
1408
|
-
```typescript
|
|
1409
|
-
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1410
|
-
versionDescription: "This is an updated version_description."
|
|
1411
|
-
});
|
|
1412
|
-
|
|
1413
|
-
```
|
|
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).
|
|
1414
1161
|
</dd>
|
|
1415
1162
|
</dl>
|
|
1416
1163
|
</dd>
|
|
1417
1164
|
</dl>
|
|
1418
1165
|
|
|
1419
|
-
####
|
|
1166
|
+
#### 🔌 Usage
|
|
1420
1167
|
|
|
1421
1168
|
<dl>
|
|
1422
1169
|
<dd>
|
|
@@ -1424,29 +1171,24 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1424
1171
|
<dl>
|
|
1425
1172
|
<dd>
|
|
1426
1173
|
|
|
1427
|
-
|
|
1428
|
-
|
|
1174
|
+
```typescript
|
|
1175
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
1176
|
+
|
|
1177
|
+
```
|
|
1178
|
+
</dd>
|
|
1179
|
+
</dl>
|
|
1429
1180
|
</dd>
|
|
1430
1181
|
</dl>
|
|
1431
1182
|
|
|
1183
|
+
#### ⚙️ Parameters
|
|
1184
|
+
|
|
1432
1185
|
<dl>
|
|
1433
1186
|
<dd>
|
|
1434
1187
|
|
|
1435
|
-
**version:** `number`
|
|
1436
|
-
|
|
1437
|
-
Version number for a Prompt.
|
|
1438
|
-
|
|
1439
|
-
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.
|
|
1440
|
-
|
|
1441
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1442
|
-
|
|
1443
|
-
</dd>
|
|
1444
|
-
</dl>
|
|
1445
|
-
|
|
1446
1188
|
<dl>
|
|
1447
1189
|
<dd>
|
|
1448
1190
|
|
|
1449
|
-
**
|
|
1191
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
1450
1192
|
|
|
1451
1193
|
</dd>
|
|
1452
1194
|
</dl>
|
|
@@ -1454,7 +1196,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1454
1196
|
<dl>
|
|
1455
1197
|
<dd>
|
|
1456
1198
|
|
|
1457
|
-
**requestOptions:** `
|
|
1199
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
1458
1200
|
|
|
1459
1201
|
</dd>
|
|
1460
1202
|
</dl>
|
|
@@ -2223,8 +1965,8 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2223
1965
|
</dl>
|
|
2224
1966
|
</details>
|
|
2225
1967
|
|
|
2226
|
-
## EmpathicVoice
|
|
2227
|
-
<details><summary><code>client.empathicVoice.
|
|
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>
|
|
2228
1970
|
<dl>
|
|
2229
1971
|
<dd>
|
|
2230
1972
|
|
|
@@ -2236,7 +1978,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2236
1978
|
<dl>
|
|
2237
1979
|
<dd>
|
|
2238
1980
|
|
|
2239
|
-
Fetches a paginated list of **
|
|
1981
|
+
Fetches a paginated list of **Prompts**.
|
|
1982
|
+
|
|
1983
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2240
1984
|
</dd>
|
|
2241
1985
|
</dl>
|
|
2242
1986
|
</dd>
|
|
@@ -2251,20 +1995,18 @@ Fetches a paginated list of **Chats**.
|
|
|
2251
1995
|
<dd>
|
|
2252
1996
|
|
|
2253
1997
|
```typescript
|
|
2254
|
-
const pageableResponse = await client.empathicVoice.
|
|
1998
|
+
const pageableResponse = await client.empathicVoice.prompts.listPrompts({
|
|
2255
1999
|
pageNumber: 0,
|
|
2256
|
-
pageSize:
|
|
2257
|
-
ascendingOrder: true
|
|
2000
|
+
pageSize: 2
|
|
2258
2001
|
});
|
|
2259
2002
|
for await (const item of pageableResponse) {
|
|
2260
2003
|
console.log(item);
|
|
2261
2004
|
}
|
|
2262
2005
|
|
|
2263
2006
|
// Or you can manually iterate page-by-page
|
|
2264
|
-
let page = await client.empathicVoice.
|
|
2007
|
+
let page = await client.empathicVoice.prompts.listPrompts({
|
|
2265
2008
|
pageNumber: 0,
|
|
2266
|
-
pageSize:
|
|
2267
|
-
ascendingOrder: true
|
|
2009
|
+
pageSize: 2
|
|
2268
2010
|
});
|
|
2269
2011
|
while (page.hasNextPage()) {
|
|
2270
2012
|
page = page.getNextPage();
|
|
@@ -2287,7 +2029,224 @@ const response = page.response;
|
|
|
2287
2029
|
<dl>
|
|
2288
2030
|
<dd>
|
|
2289
2031
|
|
|
2290
|
-
**request:** `Hume.empathicVoice.
|
|
2032
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
2033
|
+
|
|
2034
|
+
</dd>
|
|
2035
|
+
</dl>
|
|
2036
|
+
|
|
2037
|
+
<dl>
|
|
2038
|
+
<dd>
|
|
2039
|
+
|
|
2040
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2041
|
+
|
|
2042
|
+
</dd>
|
|
2043
|
+
</dl>
|
|
2044
|
+
</dd>
|
|
2045
|
+
</dl>
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
</dd>
|
|
2049
|
+
</dl>
|
|
2050
|
+
</details>
|
|
2051
|
+
|
|
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>
|
|
2053
|
+
<dl>
|
|
2054
|
+
<dd>
|
|
2055
|
+
|
|
2056
|
+
#### 📝 Description
|
|
2057
|
+
|
|
2058
|
+
<dl>
|
|
2059
|
+
<dd>
|
|
2060
|
+
|
|
2061
|
+
<dl>
|
|
2062
|
+
<dd>
|
|
2063
|
+
|
|
2064
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
2065
|
+
|
|
2066
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2067
|
+
</dd>
|
|
2068
|
+
</dl>
|
|
2069
|
+
</dd>
|
|
2070
|
+
</dl>
|
|
2071
|
+
|
|
2072
|
+
#### 🔌 Usage
|
|
2073
|
+
|
|
2074
|
+
<dl>
|
|
2075
|
+
<dd>
|
|
2076
|
+
|
|
2077
|
+
<dl>
|
|
2078
|
+
<dd>
|
|
2079
|
+
|
|
2080
|
+
```typescript
|
|
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>"
|
|
2084
|
+
});
|
|
2085
|
+
|
|
2086
|
+
```
|
|
2087
|
+
</dd>
|
|
2088
|
+
</dl>
|
|
2089
|
+
</dd>
|
|
2090
|
+
</dl>
|
|
2091
|
+
|
|
2092
|
+
#### ⚙️ Parameters
|
|
2093
|
+
|
|
2094
|
+
<dl>
|
|
2095
|
+
<dd>
|
|
2096
|
+
|
|
2097
|
+
<dl>
|
|
2098
|
+
<dd>
|
|
2099
|
+
|
|
2100
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
2101
|
+
|
|
2102
|
+
</dd>
|
|
2103
|
+
</dl>
|
|
2104
|
+
|
|
2105
|
+
<dl>
|
|
2106
|
+
<dd>
|
|
2107
|
+
|
|
2108
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2109
|
+
|
|
2110
|
+
</dd>
|
|
2111
|
+
</dl>
|
|
2112
|
+
</dd>
|
|
2113
|
+
</dl>
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
</dd>
|
|
2117
|
+
</dl>
|
|
2118
|
+
</details>
|
|
2119
|
+
|
|
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>
|
|
2121
|
+
<dl>
|
|
2122
|
+
<dd>
|
|
2123
|
+
|
|
2124
|
+
#### 📝 Description
|
|
2125
|
+
|
|
2126
|
+
<dl>
|
|
2127
|
+
<dd>
|
|
2128
|
+
|
|
2129
|
+
<dl>
|
|
2130
|
+
<dd>
|
|
2131
|
+
|
|
2132
|
+
Fetches a list of a **Prompt's** versions.
|
|
2133
|
+
|
|
2134
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2135
|
+
</dd>
|
|
2136
|
+
</dl>
|
|
2137
|
+
</dd>
|
|
2138
|
+
</dl>
|
|
2139
|
+
|
|
2140
|
+
#### 🔌 Usage
|
|
2141
|
+
|
|
2142
|
+
<dl>
|
|
2143
|
+
<dd>
|
|
2144
|
+
|
|
2145
|
+
<dl>
|
|
2146
|
+
<dd>
|
|
2147
|
+
|
|
2148
|
+
```typescript
|
|
2149
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
2150
|
+
|
|
2151
|
+
```
|
|
2152
|
+
</dd>
|
|
2153
|
+
</dl>
|
|
2154
|
+
</dd>
|
|
2155
|
+
</dl>
|
|
2156
|
+
|
|
2157
|
+
#### ⚙️ Parameters
|
|
2158
|
+
|
|
2159
|
+
<dl>
|
|
2160
|
+
<dd>
|
|
2161
|
+
|
|
2162
|
+
<dl>
|
|
2163
|
+
<dd>
|
|
2164
|
+
|
|
2165
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2166
|
+
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
<dl>
|
|
2171
|
+
<dd>
|
|
2172
|
+
|
|
2173
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
2174
|
+
|
|
2175
|
+
</dd>
|
|
2176
|
+
</dl>
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2182
|
+
|
|
2183
|
+
</dd>
|
|
2184
|
+
</dl>
|
|
2185
|
+
</dd>
|
|
2186
|
+
</dl>
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
</dd>
|
|
2190
|
+
</dl>
|
|
2191
|
+
</details>
|
|
2192
|
+
|
|
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>
|
|
2194
|
+
<dl>
|
|
2195
|
+
<dd>
|
|
2196
|
+
|
|
2197
|
+
#### 📝 Description
|
|
2198
|
+
|
|
2199
|
+
<dl>
|
|
2200
|
+
<dd>
|
|
2201
|
+
|
|
2202
|
+
<dl>
|
|
2203
|
+
<dd>
|
|
2204
|
+
|
|
2205
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
2206
|
+
|
|
2207
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2208
|
+
</dd>
|
|
2209
|
+
</dl>
|
|
2210
|
+
</dd>
|
|
2211
|
+
</dl>
|
|
2212
|
+
|
|
2213
|
+
#### 🔌 Usage
|
|
2214
|
+
|
|
2215
|
+
<dl>
|
|
2216
|
+
<dd>
|
|
2217
|
+
|
|
2218
|
+
<dl>
|
|
2219
|
+
<dd>
|
|
2220
|
+
|
|
2221
|
+
```typescript
|
|
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."
|
|
2225
|
+
});
|
|
2226
|
+
|
|
2227
|
+
```
|
|
2228
|
+
</dd>
|
|
2229
|
+
</dl>
|
|
2230
|
+
</dd>
|
|
2231
|
+
</dl>
|
|
2232
|
+
|
|
2233
|
+
#### ⚙️ Parameters
|
|
2234
|
+
|
|
2235
|
+
<dl>
|
|
2236
|
+
<dd>
|
|
2237
|
+
|
|
2238
|
+
<dl>
|
|
2239
|
+
<dd>
|
|
2240
|
+
|
|
2241
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2242
|
+
|
|
2243
|
+
</dd>
|
|
2244
|
+
</dl>
|
|
2245
|
+
|
|
2246
|
+
<dl>
|
|
2247
|
+
<dd>
|
|
2248
|
+
|
|
2249
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
2291
2250
|
|
|
2292
2251
|
</dd>
|
|
2293
2252
|
</dl>
|
|
@@ -2295,7 +2254,7 @@ const response = page.response;
|
|
|
2295
2254
|
<dl>
|
|
2296
2255
|
<dd>
|
|
2297
2256
|
|
|
2298
|
-
**requestOptions:** `
|
|
2257
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2299
2258
|
|
|
2300
2259
|
</dd>
|
|
2301
2260
|
</dl>
|
|
@@ -2307,7 +2266,7 @@ const response = page.response;
|
|
|
2307
2266
|
</dl>
|
|
2308
2267
|
</details>
|
|
2309
2268
|
|
|
2310
|
-
<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>
|
|
2311
2270
|
<dl>
|
|
2312
2271
|
<dd>
|
|
2313
2272
|
|
|
@@ -2319,7 +2278,9 @@ const response = page.response;
|
|
|
2319
2278
|
<dl>
|
|
2320
2279
|
<dd>
|
|
2321
2280
|
|
|
2322
|
-
|
|
2281
|
+
Deletes a **Prompt** and its versions.
|
|
2282
|
+
|
|
2283
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2323
2284
|
</dd>
|
|
2324
2285
|
</dl>
|
|
2325
2286
|
</dd>
|
|
@@ -2334,27 +2295,7 @@ Fetches a paginated list of **Chat** events.
|
|
|
2334
2295
|
<dd>
|
|
2335
2296
|
|
|
2336
2297
|
```typescript
|
|
2337
|
-
|
|
2338
|
-
pageNumber: 0,
|
|
2339
|
-
pageSize: 3,
|
|
2340
|
-
ascendingOrder: true
|
|
2341
|
-
});
|
|
2342
|
-
for await (const item of pageableResponse) {
|
|
2343
|
-
console.log(item);
|
|
2344
|
-
}
|
|
2345
|
-
|
|
2346
|
-
// Or you can manually iterate page-by-page
|
|
2347
|
-
let page = await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2348
|
-
pageNumber: 0,
|
|
2349
|
-
pageSize: 3,
|
|
2350
|
-
ascendingOrder: true
|
|
2351
|
-
});
|
|
2352
|
-
while (page.hasNextPage()) {
|
|
2353
|
-
page = page.getNextPage();
|
|
2354
|
-
}
|
|
2355
|
-
|
|
2356
|
-
// You can also access the underlying response
|
|
2357
|
-
const response = page.response;
|
|
2298
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
2358
2299
|
|
|
2359
2300
|
```
|
|
2360
2301
|
</dd>
|
|
@@ -2370,15 +2311,7 @@ const response = page.response;
|
|
|
2370
2311
|
<dl>
|
|
2371
2312
|
<dd>
|
|
2372
2313
|
|
|
2373
|
-
**id:** `string` — Identifier for a
|
|
2374
|
-
|
|
2375
|
-
</dd>
|
|
2376
|
-
</dl>
|
|
2377
|
-
|
|
2378
|
-
<dl>
|
|
2379
|
-
<dd>
|
|
2380
|
-
|
|
2381
|
-
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
2314
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2382
2315
|
|
|
2383
2316
|
</dd>
|
|
2384
2317
|
</dl>
|
|
@@ -2386,7 +2319,7 @@ const response = page.response;
|
|
|
2386
2319
|
<dl>
|
|
2387
2320
|
<dd>
|
|
2388
2321
|
|
|
2389
|
-
**requestOptions:** `
|
|
2322
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2390
2323
|
|
|
2391
2324
|
</dd>
|
|
2392
2325
|
</dl>
|
|
@@ -2398,7 +2331,7 @@ const response = page.response;
|
|
|
2398
2331
|
</dl>
|
|
2399
2332
|
</details>
|
|
2400
2333
|
|
|
2401
|
-
<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>
|
|
2402
2335
|
<dl>
|
|
2403
2336
|
<dd>
|
|
2404
2337
|
|
|
@@ -2410,7 +2343,9 @@ const response = page.response;
|
|
|
2410
2343
|
<dl>
|
|
2411
2344
|
<dd>
|
|
2412
2345
|
|
|
2413
|
-
|
|
2346
|
+
Updates the name of a **Prompt**.
|
|
2347
|
+
|
|
2348
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2414
2349
|
</dd>
|
|
2415
2350
|
</dl>
|
|
2416
2351
|
</dd>
|
|
@@ -2425,7 +2360,9 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
|
|
|
2425
2360
|
<dd>
|
|
2426
2361
|
|
|
2427
2362
|
```typescript
|
|
2428
|
-
await client.empathicVoice.
|
|
2363
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
2364
|
+
name: "Updated Weather Assistant Prompt Name"
|
|
2365
|
+
});
|
|
2429
2366
|
|
|
2430
2367
|
```
|
|
2431
2368
|
</dd>
|
|
@@ -2441,7 +2378,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2441
2378
|
<dl>
|
|
2442
2379
|
<dd>
|
|
2443
2380
|
|
|
2444
|
-
**id:** `string` — Identifier for a
|
|
2381
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2445
2382
|
|
|
2446
2383
|
</dd>
|
|
2447
2384
|
</dl>
|
|
@@ -2449,7 +2386,15 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2449
2386
|
<dl>
|
|
2450
2387
|
<dd>
|
|
2451
2388
|
|
|
2452
|
-
**
|
|
2389
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
2390
|
+
|
|
2391
|
+
</dd>
|
|
2392
|
+
</dl>
|
|
2393
|
+
|
|
2394
|
+
<dl>
|
|
2395
|
+
<dd>
|
|
2396
|
+
|
|
2397
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2453
2398
|
|
|
2454
2399
|
</dd>
|
|
2455
2400
|
</dl>
|
|
@@ -2461,8 +2406,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2461
2406
|
</dl>
|
|
2462
2407
|
</details>
|
|
2463
2408
|
|
|
2464
|
-
|
|
2465
|
-
<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>
|
|
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>
|
|
2466
2410
|
<dl>
|
|
2467
2411
|
<dd>
|
|
2468
2412
|
|
|
@@ -2474,7 +2418,9 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
2474
2418
|
<dl>
|
|
2475
2419
|
<dd>
|
|
2476
2420
|
|
|
2477
|
-
Fetches a
|
|
2421
|
+
Fetches a specified version of a **Prompt**.
|
|
2422
|
+
|
|
2423
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2478
2424
|
</dd>
|
|
2479
2425
|
</dl>
|
|
2480
2426
|
</dd>
|
|
@@ -2489,29 +2435,7 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
2489
2435
|
<dd>
|
|
2490
2436
|
|
|
2491
2437
|
```typescript
|
|
2492
|
-
|
|
2493
|
-
pageNumber: 0,
|
|
2494
|
-
pageSize: 1,
|
|
2495
|
-
ascendingOrder: true,
|
|
2496
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
2497
|
-
});
|
|
2498
|
-
for await (const item of pageableResponse) {
|
|
2499
|
-
console.log(item);
|
|
2500
|
-
}
|
|
2501
|
-
|
|
2502
|
-
// Or you can manually iterate page-by-page
|
|
2503
|
-
let page = await client.empathicVoice.chatGroups.listChatGroups({
|
|
2504
|
-
pageNumber: 0,
|
|
2505
|
-
pageSize: 1,
|
|
2506
|
-
ascendingOrder: true,
|
|
2507
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3"
|
|
2508
|
-
});
|
|
2509
|
-
while (page.hasNextPage()) {
|
|
2510
|
-
page = page.getNextPage();
|
|
2511
|
-
}
|
|
2512
|
-
|
|
2513
|
-
// You can also access the underlying response
|
|
2514
|
-
const response = page.response;
|
|
2438
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
2515
2439
|
|
|
2516
2440
|
```
|
|
2517
2441
|
</dd>
|
|
@@ -2527,7 +2451,7 @@ const response = page.response;
|
|
|
2527
2451
|
<dl>
|
|
2528
2452
|
<dd>
|
|
2529
2453
|
|
|
2530
|
-
**
|
|
2454
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2531
2455
|
|
|
2532
2456
|
</dd>
|
|
2533
2457
|
</dl>
|
|
@@ -2535,7 +2459,21 @@ const response = page.response;
|
|
|
2535
2459
|
<dl>
|
|
2536
2460
|
<dd>
|
|
2537
2461
|
|
|
2538
|
-
**
|
|
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`
|
|
2539
2477
|
|
|
2540
2478
|
</dd>
|
|
2541
2479
|
</dl>
|
|
@@ -2547,7 +2485,7 @@ const response = page.response;
|
|
|
2547
2485
|
</dl>
|
|
2548
2486
|
</details>
|
|
2549
2487
|
|
|
2550
|
-
<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>
|
|
2551
2489
|
<dl>
|
|
2552
2490
|
<dd>
|
|
2553
2491
|
|
|
@@ -2559,7 +2497,9 @@ const response = page.response;
|
|
|
2559
2497
|
<dl>
|
|
2560
2498
|
<dd>
|
|
2561
2499
|
|
|
2562
|
-
|
|
2500
|
+
Deletes a specified version of a **Prompt**.
|
|
2501
|
+
|
|
2502
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2563
2503
|
</dd>
|
|
2564
2504
|
</dl>
|
|
2565
2505
|
</dd>
|
|
@@ -2574,11 +2514,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
2574
2514
|
<dd>
|
|
2575
2515
|
|
|
2576
2516
|
```typescript
|
|
2577
|
-
await client.empathicVoice.
|
|
2578
|
-
pageNumber: 0,
|
|
2579
|
-
pageSize: 1,
|
|
2580
|
-
ascendingOrder: true
|
|
2581
|
-
});
|
|
2517
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
2582
2518
|
|
|
2583
2519
|
```
|
|
2584
2520
|
</dd>
|
|
@@ -2594,7 +2530,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2594
2530
|
<dl>
|
|
2595
2531
|
<dd>
|
|
2596
2532
|
|
|
2597
|
-
**id:** `string` — Identifier for a
|
|
2533
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2598
2534
|
|
|
2599
2535
|
</dd>
|
|
2600
2536
|
</dl>
|
|
@@ -2602,7 +2538,13 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2602
2538
|
<dl>
|
|
2603
2539
|
<dd>
|
|
2604
2540
|
|
|
2605
|
-
**
|
|
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.
|
|
2606
2548
|
|
|
2607
2549
|
</dd>
|
|
2608
2550
|
</dl>
|
|
@@ -2610,7 +2552,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2610
2552
|
<dl>
|
|
2611
2553
|
<dd>
|
|
2612
2554
|
|
|
2613
|
-
**requestOptions:** `
|
|
2555
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2614
2556
|
|
|
2615
2557
|
</dd>
|
|
2616
2558
|
</dl>
|
|
@@ -2622,7 +2564,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2622
2564
|
</dl>
|
|
2623
2565
|
</details>
|
|
2624
2566
|
|
|
2625
|
-
<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>
|
|
2626
2568
|
<dl>
|
|
2627
2569
|
<dd>
|
|
2628
2570
|
|
|
@@ -2634,7 +2576,9 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
2634
2576
|
<dl>
|
|
2635
2577
|
<dd>
|
|
2636
2578
|
|
|
2637
|
-
|
|
2579
|
+
Updates the description of a **Prompt**.
|
|
2580
|
+
|
|
2581
|
+
See our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
2638
2582
|
</dd>
|
|
2639
2583
|
</dl>
|
|
2640
2584
|
</dd>
|
|
@@ -2649,27 +2593,9 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
2649
2593
|
<dd>
|
|
2650
2594
|
|
|
2651
2595
|
```typescript
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
pageSize: 3,
|
|
2655
|
-
ascendingOrder: true
|
|
2656
|
-
});
|
|
2657
|
-
for await (const item of pageableResponse) {
|
|
2658
|
-
console.log(item);
|
|
2659
|
-
}
|
|
2660
|
-
|
|
2661
|
-
// Or you can manually iterate page-by-page
|
|
2662
|
-
let page = await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
2663
|
-
pageNumber: 0,
|
|
2664
|
-
pageSize: 3,
|
|
2665
|
-
ascendingOrder: true
|
|
2596
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
2597
|
+
versionDescription: "This is an updated version_description."
|
|
2666
2598
|
});
|
|
2667
|
-
while (page.hasNextPage()) {
|
|
2668
|
-
page = page.getNextPage();
|
|
2669
|
-
}
|
|
2670
|
-
|
|
2671
|
-
// You can also access the underlying response
|
|
2672
|
-
const response = page.response;
|
|
2673
2599
|
|
|
2674
2600
|
```
|
|
2675
2601
|
</dd>
|
|
@@ -2685,7 +2611,7 @@ const response = page.response;
|
|
|
2685
2611
|
<dl>
|
|
2686
2612
|
<dd>
|
|
2687
2613
|
|
|
2688
|
-
**id:** `string` — Identifier for a
|
|
2614
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
2689
2615
|
|
|
2690
2616
|
</dd>
|
|
2691
2617
|
</dl>
|
|
@@ -2693,7 +2619,13 @@ const response = page.response;
|
|
|
2693
2619
|
<dl>
|
|
2694
2620
|
<dd>
|
|
2695
2621
|
|
|
2696
|
-
**
|
|
2622
|
+
**version:** `number`
|
|
2623
|
+
|
|
2624
|
+
Version number for a Prompt.
|
|
2625
|
+
|
|
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.
|
|
2627
|
+
|
|
2628
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
2697
2629
|
|
|
2698
2630
|
</dd>
|
|
2699
2631
|
</dl>
|
|
@@ -2701,7 +2633,15 @@ const response = page.response;
|
|
|
2701
2633
|
<dl>
|
|
2702
2634
|
<dd>
|
|
2703
2635
|
|
|
2704
|
-
**
|
|
2636
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
2637
|
+
|
|
2638
|
+
</dd>
|
|
2639
|
+
</dl>
|
|
2640
|
+
|
|
2641
|
+
<dl>
|
|
2642
|
+
<dd>
|
|
2643
|
+
|
|
2644
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
2705
2645
|
|
|
2706
2646
|
</dd>
|
|
2707
2647
|
</dl>
|
|
@@ -2713,7 +2653,8 @@ const response = page.response;
|
|
|
2713
2653
|
</dl>
|
|
2714
2654
|
</details>
|
|
2715
2655
|
|
|
2716
|
-
|
|
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>
|
|
2717
2658
|
<dl>
|
|
2718
2659
|
<dd>
|
|
2719
2660
|
|
|
@@ -2725,7 +2666,9 @@ const response = page.response;
|
|
|
2725
2666
|
<dl>
|
|
2726
2667
|
<dd>
|
|
2727
2668
|
|
|
2728
|
-
Fetches a paginated list of
|
|
2669
|
+
Fetches a paginated list of **Tools**.
|
|
2670
|
+
|
|
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.
|
|
2729
2672
|
</dd>
|
|
2730
2673
|
</dl>
|
|
2731
2674
|
</dd>
|
|
@@ -2740,11 +2683,25 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
|
|
|
2740
2683
|
<dd>
|
|
2741
2684
|
|
|
2742
2685
|
```typescript
|
|
2743
|
-
await client.empathicVoice.
|
|
2686
|
+
const pageableResponse = await client.empathicVoice.tools.listTools({
|
|
2744
2687
|
pageNumber: 0,
|
|
2745
|
-
pageSize:
|
|
2746
|
-
|
|
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
|
|
2747
2698
|
});
|
|
2699
|
+
while (page.hasNextPage()) {
|
|
2700
|
+
page = page.getNextPage();
|
|
2701
|
+
}
|
|
2702
|
+
|
|
2703
|
+
// You can also access the underlying response
|
|
2704
|
+
const response = page.response;
|
|
2748
2705
|
|
|
2749
2706
|
```
|
|
2750
2707
|
</dd>
|
|
@@ -2760,15 +2717,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2760
2717
|
<dl>
|
|
2761
2718
|
<dd>
|
|
2762
2719
|
|
|
2763
|
-
**
|
|
2764
|
-
|
|
2765
|
-
</dd>
|
|
2766
|
-
</dl>
|
|
2767
|
-
|
|
2768
|
-
<dl>
|
|
2769
|
-
<dd>
|
|
2770
|
-
|
|
2771
|
-
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
2720
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
2772
2721
|
|
|
2773
2722
|
</dd>
|
|
2774
2723
|
</dl>
|
|
@@ -2776,7 +2725,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2776
2725
|
<dl>
|
|
2777
2726
|
<dd>
|
|
2778
2727
|
|
|
2779
|
-
**requestOptions:** `
|
|
2728
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2780
2729
|
|
|
2781
2730
|
</dd>
|
|
2782
2731
|
</dl>
|
|
@@ -2788,8 +2737,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2788
2737
|
</dl>
|
|
2789
2738
|
</details>
|
|
2790
2739
|
|
|
2791
|
-
|
|
2792
|
-
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">synthesizeJson</a>({ ...params }) -> Hume.ReturnTts</code></summary>
|
|
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>
|
|
2793
2741
|
<dl>
|
|
2794
2742
|
<dd>
|
|
2795
2743
|
|
|
@@ -2801,9 +2749,9 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
2801
2749
|
<dl>
|
|
2802
2750
|
<dd>
|
|
2803
2751
|
|
|
2804
|
-
|
|
2752
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).
|
|
2805
2753
|
|
|
2806
|
-
|
|
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.
|
|
2807
2755
|
</dd>
|
|
2808
2756
|
</dl>
|
|
2809
2757
|
</dd>
|
|
@@ -2815,24 +2763,15 @@ The response includes the base64-encoded audio and metadata in JSON format.
|
|
|
2815
2763
|
<dd>
|
|
2816
2764
|
|
|
2817
2765
|
<dl>
|
|
2818
|
-
<dd>
|
|
2819
|
-
|
|
2820
|
-
```typescript
|
|
2821
|
-
await client.
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
},
|
|
2828
|
-
format: {
|
|
2829
|
-
type: "mp3"
|
|
2830
|
-
},
|
|
2831
|
-
numGenerations: 1,
|
|
2832
|
-
utterances: [{
|
|
2833
|
-
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
2834
|
-
description: "Middle-aged masculine voice with a clear, rhythmic Scots lilt, rounded vowels, and a warm, steady tone with an articulate, academic quality."
|
|
2835
|
-
}]
|
|
2766
|
+
<dd>
|
|
2767
|
+
|
|
2768
|
+
```typescript
|
|
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."
|
|
2836
2775
|
});
|
|
2837
2776
|
|
|
2838
2777
|
```
|
|
@@ -2849,7 +2788,7 @@ await client.tts.synthesizeJson({
|
|
|
2849
2788
|
<dl>
|
|
2850
2789
|
<dd>
|
|
2851
2790
|
|
|
2852
|
-
**request:** `Hume.
|
|
2791
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
2853
2792
|
|
|
2854
2793
|
</dd>
|
|
2855
2794
|
</dl>
|
|
@@ -2857,7 +2796,7 @@ await client.tts.synthesizeJson({
|
|
|
2857
2796
|
<dl>
|
|
2858
2797
|
<dd>
|
|
2859
2798
|
|
|
2860
|
-
**requestOptions:** `
|
|
2799
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2861
2800
|
|
|
2862
2801
|
</dd>
|
|
2863
2802
|
</dl>
|
|
@@ -2869,7 +2808,7 @@ await client.tts.synthesizeJson({
|
|
|
2869
2808
|
</dl>
|
|
2870
2809
|
</details>
|
|
2871
2810
|
|
|
2872
|
-
<details><summary><code>client.
|
|
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>
|
|
2873
2812
|
<dl>
|
|
2874
2813
|
<dd>
|
|
2875
2814
|
|
|
@@ -2881,9 +2820,9 @@ await client.tts.synthesizeJson({
|
|
|
2881
2820
|
<dl>
|
|
2882
2821
|
<dd>
|
|
2883
2822
|
|
|
2884
|
-
|
|
2823
|
+
Fetches a list of a **Tool's** versions.
|
|
2885
2824
|
|
|
2886
|
-
|
|
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.
|
|
2887
2826
|
</dd>
|
|
2888
2827
|
</dl>
|
|
2889
2828
|
</dd>
|
|
@@ -2898,19 +2837,19 @@ The response contains the generated audio file in the requested format.
|
|
|
2898
2837
|
<dd>
|
|
2899
2838
|
|
|
2900
2839
|
```typescript
|
|
2901
|
-
await client.
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2840
|
+
const pageableResponse = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
2841
|
+
for await (const item of pageableResponse) {
|
|
2842
|
+
console.log(item);
|
|
2843
|
+
}
|
|
2844
|
+
|
|
2845
|
+
// Or you can manually iterate page-by-page
|
|
2846
|
+
let page = await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
2847
|
+
while (page.hasNextPage()) {
|
|
2848
|
+
page = page.getNextPage();
|
|
2849
|
+
}
|
|
2850
|
+
|
|
2851
|
+
// You can also access the underlying response
|
|
2852
|
+
const response = page.response;
|
|
2914
2853
|
|
|
2915
2854
|
```
|
|
2916
2855
|
</dd>
|
|
@@ -2926,7 +2865,7 @@ await client.tts.synthesizeFile({
|
|
|
2926
2865
|
<dl>
|
|
2927
2866
|
<dd>
|
|
2928
2867
|
|
|
2929
|
-
**
|
|
2868
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
2930
2869
|
|
|
2931
2870
|
</dd>
|
|
2932
2871
|
</dl>
|
|
@@ -2934,7 +2873,15 @@ await client.tts.synthesizeFile({
|
|
|
2934
2873
|
<dl>
|
|
2935
2874
|
<dd>
|
|
2936
2875
|
|
|
2937
|
-
**
|
|
2876
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
2877
|
+
|
|
2878
|
+
</dd>
|
|
2879
|
+
</dl>
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
2938
2885
|
|
|
2939
2886
|
</dd>
|
|
2940
2887
|
</dl>
|
|
@@ -2946,7 +2893,7 @@ await client.tts.synthesizeFile({
|
|
|
2946
2893
|
</dl>
|
|
2947
2894
|
</details>
|
|
2948
2895
|
|
|
2949
|
-
<details><summary><code>client.
|
|
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>
|
|
2950
2897
|
<dl>
|
|
2951
2898
|
<dd>
|
|
2952
2899
|
|
|
@@ -2958,7 +2905,9 @@ await client.tts.synthesizeFile({
|
|
|
2958
2905
|
<dl>
|
|
2959
2906
|
<dd>
|
|
2960
2907
|
|
|
2961
|
-
|
|
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.
|
|
2962
2911
|
</dd>
|
|
2963
2912
|
</dl>
|
|
2964
2913
|
</dd>
|
|
@@ -2973,14 +2922,11 @@ Streams synthesized speech using the specified voice. If no voice is provided, a
|
|
|
2973
2922
|
<dd>
|
|
2974
2923
|
|
|
2975
2924
|
```typescript
|
|
2976
|
-
await client.
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
provider: "HUME_AI"
|
|
2982
|
-
}
|
|
2983
|
-
}]
|
|
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."
|
|
2984
2930
|
});
|
|
2985
2931
|
|
|
2986
2932
|
```
|
|
@@ -2997,7 +2943,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
2997
2943
|
<dl>
|
|
2998
2944
|
<dd>
|
|
2999
2945
|
|
|
3000
|
-
**
|
|
2946
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3001
2947
|
|
|
3002
2948
|
</dd>
|
|
3003
2949
|
</dl>
|
|
@@ -3005,7 +2951,15 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3005
2951
|
<dl>
|
|
3006
2952
|
<dd>
|
|
3007
2953
|
|
|
3008
|
-
**
|
|
2954
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
2955
|
+
|
|
2956
|
+
</dd>
|
|
2957
|
+
</dl>
|
|
2958
|
+
|
|
2959
|
+
<dl>
|
|
2960
|
+
<dd>
|
|
2961
|
+
|
|
2962
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3009
2963
|
|
|
3010
2964
|
</dd>
|
|
3011
2965
|
</dl>
|
|
@@ -3017,7 +2971,7 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3017
2971
|
</dl>
|
|
3018
2972
|
</details>
|
|
3019
2973
|
|
|
3020
|
-
<details><summary><code>client.
|
|
2974
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
3021
2975
|
<dl>
|
|
3022
2976
|
<dd>
|
|
3023
2977
|
|
|
@@ -3029,9 +2983,9 @@ await client.tts.synthesizeFileStreaming({
|
|
|
3029
2983
|
<dl>
|
|
3030
2984
|
<dd>
|
|
3031
2985
|
|
|
3032
|
-
|
|
2986
|
+
Deletes a **Tool** and its versions.
|
|
3033
2987
|
|
|
3034
|
-
|
|
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.
|
|
3035
2989
|
</dd>
|
|
3036
2990
|
</dl>
|
|
3037
2991
|
</dd>
|
|
@@ -3046,18 +3000,7 @@ The response is a stream of JSON objects including audio encoded in base64.
|
|
|
3046
3000
|
<dd>
|
|
3047
3001
|
|
|
3048
3002
|
```typescript
|
|
3049
|
-
|
|
3050
|
-
utterances: [{
|
|
3051
|
-
text: "Beauty is no quality in things themselves: It exists merely in the mind which contemplates them.",
|
|
3052
|
-
voice: {
|
|
3053
|
-
name: "Male English Actor",
|
|
3054
|
-
provider: "HUME_AI"
|
|
3055
|
-
}
|
|
3056
|
-
}]
|
|
3057
|
-
});
|
|
3058
|
-
for await (const item of response) {
|
|
3059
|
-
console.log(item);
|
|
3060
|
-
}
|
|
3003
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
3061
3004
|
|
|
3062
3005
|
```
|
|
3063
3006
|
</dd>
|
|
@@ -3073,7 +3016,7 @@ for await (const item of response) {
|
|
|
3073
3016
|
<dl>
|
|
3074
3017
|
<dd>
|
|
3075
3018
|
|
|
3076
|
-
**
|
|
3019
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3077
3020
|
|
|
3078
3021
|
</dd>
|
|
3079
3022
|
</dl>
|
|
@@ -3081,7 +3024,7 @@ for await (const item of response) {
|
|
|
3081
3024
|
<dl>
|
|
3082
3025
|
<dd>
|
|
3083
3026
|
|
|
3084
|
-
**requestOptions:** `
|
|
3027
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3085
3028
|
|
|
3086
3029
|
</dd>
|
|
3087
3030
|
</dl>
|
|
@@ -3093,10 +3036,26 @@ for await (const item of response) {
|
|
|
3093
3036
|
</dl>
|
|
3094
3037
|
</details>
|
|
3095
3038
|
|
|
3096
|
-
<details><summary><code>client.
|
|
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>
|
|
3040
|
+
<dl>
|
|
3041
|
+
<dd>
|
|
3042
|
+
|
|
3043
|
+
#### 📝 Description
|
|
3044
|
+
|
|
3045
|
+
<dl>
|
|
3046
|
+
<dd>
|
|
3047
|
+
|
|
3097
3048
|
<dl>
|
|
3098
3049
|
<dd>
|
|
3099
3050
|
|
|
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.
|
|
3054
|
+
</dd>
|
|
3055
|
+
</dl>
|
|
3056
|
+
</dd>
|
|
3057
|
+
</dl>
|
|
3058
|
+
|
|
3100
3059
|
#### 🔌 Usage
|
|
3101
3060
|
|
|
3102
3061
|
<dl>
|
|
@@ -3106,10 +3065,9 @@ for await (const item of response) {
|
|
|
3106
3065
|
<dd>
|
|
3107
3066
|
|
|
3108
3067
|
```typescript
|
|
3109
|
-
|
|
3110
|
-
|
|
3111
|
-
|
|
3112
|
-
}
|
|
3068
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
3069
|
+
name: "get_current_temperature"
|
|
3070
|
+
});
|
|
3113
3071
|
|
|
3114
3072
|
```
|
|
3115
3073
|
</dd>
|
|
@@ -3125,7 +3083,7 @@ for await (const item of response) {
|
|
|
3125
3083
|
<dl>
|
|
3126
3084
|
<dd>
|
|
3127
3085
|
|
|
3128
|
-
**
|
|
3086
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3129
3087
|
|
|
3130
3088
|
</dd>
|
|
3131
3089
|
</dl>
|
|
@@ -3133,7 +3091,15 @@ for await (const item of response) {
|
|
|
3133
3091
|
<dl>
|
|
3134
3092
|
<dd>
|
|
3135
3093
|
|
|
3136
|
-
**
|
|
3094
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
3095
|
+
|
|
3096
|
+
</dd>
|
|
3097
|
+
</dl>
|
|
3098
|
+
|
|
3099
|
+
<dl>
|
|
3100
|
+
<dd>
|
|
3101
|
+
|
|
3102
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3137
3103
|
|
|
3138
3104
|
</dd>
|
|
3139
3105
|
</dl>
|
|
@@ -3145,8 +3111,7 @@ for await (const item of response) {
|
|
|
3145
3111
|
</dl>
|
|
3146
3112
|
</details>
|
|
3147
3113
|
|
|
3148
|
-
|
|
3149
|
-
<details><summary><code>client.tts.voices.<a href="/src/api/resources/tts/resources/voices/client/Client.ts">list</a>({ ...params }) -> core.Page<Hume.ReturnVoice, Hume.ReturnPagedVoices></code></summary>
|
|
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>
|
|
3150
3115
|
<dl>
|
|
3151
3116
|
<dd>
|
|
3152
3117
|
|
|
@@ -3158,7 +3123,9 @@ for await (const item of response) {
|
|
|
3158
3123
|
<dl>
|
|
3159
3124
|
<dd>
|
|
3160
3125
|
|
|
3161
|
-
|
|
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.
|
|
3162
3129
|
</dd>
|
|
3163
3130
|
</dl>
|
|
3164
3131
|
</dd>
|
|
@@ -3173,23 +3140,7 @@ Lists voices you have saved in your account, or voices from the [Voice Library](
|
|
|
3173
3140
|
<dd>
|
|
3174
3141
|
|
|
3175
3142
|
```typescript
|
|
3176
|
-
|
|
3177
|
-
provider: "CUSTOM_VOICE"
|
|
3178
|
-
});
|
|
3179
|
-
for await (const item of pageableResponse) {
|
|
3180
|
-
console.log(item);
|
|
3181
|
-
}
|
|
3182
|
-
|
|
3183
|
-
// Or you can manually iterate page-by-page
|
|
3184
|
-
let page = await client.tts.voices.list({
|
|
3185
|
-
provider: "CUSTOM_VOICE"
|
|
3186
|
-
});
|
|
3187
|
-
while (page.hasNextPage()) {
|
|
3188
|
-
page = page.getNextPage();
|
|
3189
|
-
}
|
|
3190
|
-
|
|
3191
|
-
// You can also access the underlying response
|
|
3192
|
-
const response = page.response;
|
|
3143
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
3193
3144
|
|
|
3194
3145
|
```
|
|
3195
3146
|
</dd>
|
|
@@ -3205,7 +3156,7 @@ const response = page.response;
|
|
|
3205
3156
|
<dl>
|
|
3206
3157
|
<dd>
|
|
3207
3158
|
|
|
3208
|
-
**
|
|
3159
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3209
3160
|
|
|
3210
3161
|
</dd>
|
|
3211
3162
|
</dl>
|
|
@@ -3213,7 +3164,21 @@ const response = page.response;
|
|
|
3213
3164
|
<dl>
|
|
3214
3165
|
<dd>
|
|
3215
3166
|
|
|
3216
|
-
**
|
|
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.
|
|
3174
|
+
|
|
3175
|
+
</dd>
|
|
3176
|
+
</dl>
|
|
3177
|
+
|
|
3178
|
+
<dl>
|
|
3179
|
+
<dd>
|
|
3180
|
+
|
|
3181
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3217
3182
|
|
|
3218
3183
|
</dd>
|
|
3219
3184
|
</dl>
|
|
@@ -3225,7 +3190,7 @@ const response = page.response;
|
|
|
3225
3190
|
</dl>
|
|
3226
3191
|
</details>
|
|
3227
3192
|
|
|
3228
|
-
<details><summary><code>client.
|
|
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>
|
|
3229
3194
|
<dl>
|
|
3230
3195
|
<dd>
|
|
3231
3196
|
|
|
@@ -3237,9 +3202,9 @@ const response = page.response;
|
|
|
3237
3202
|
<dl>
|
|
3238
3203
|
<dd>
|
|
3239
3204
|
|
|
3240
|
-
|
|
3205
|
+
Deletes a specified version of a **Tool**.
|
|
3241
3206
|
|
|
3242
|
-
|
|
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.
|
|
3243
3208
|
</dd>
|
|
3244
3209
|
</dl>
|
|
3245
3210
|
</dd>
|
|
@@ -3254,10 +3219,7 @@ Once saved, this voice can be reused in subsequent TTS requests, ensuring consis
|
|
|
3254
3219
|
<dd>
|
|
3255
3220
|
|
|
3256
3221
|
```typescript
|
|
3257
|
-
await client.
|
|
3258
|
-
generationId: "795c949a-1510-4a80-9646-7d0863b023ab",
|
|
3259
|
-
name: "David Hume"
|
|
3260
|
-
});
|
|
3222
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
3261
3223
|
|
|
3262
3224
|
```
|
|
3263
3225
|
</dd>
|
|
@@ -3273,7 +3235,7 @@ await client.tts.voices.create({
|
|
|
3273
3235
|
<dl>
|
|
3274
3236
|
<dd>
|
|
3275
3237
|
|
|
3276
|
-
**
|
|
3238
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3277
3239
|
|
|
3278
3240
|
</dd>
|
|
3279
3241
|
</dl>
|
|
@@ -3281,7 +3243,21 @@ await client.tts.voices.create({
|
|
|
3281
3243
|
<dl>
|
|
3282
3244
|
<dd>
|
|
3283
3245
|
|
|
3284
|
-
**
|
|
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.
|
|
3253
|
+
|
|
3254
|
+
</dd>
|
|
3255
|
+
</dl>
|
|
3256
|
+
|
|
3257
|
+
<dl>
|
|
3258
|
+
<dd>
|
|
3259
|
+
|
|
3260
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
3285
3261
|
|
|
3286
3262
|
</dd>
|
|
3287
3263
|
</dl>
|
|
@@ -3293,7 +3269,7 @@ await client.tts.voices.create({
|
|
|
3293
3269
|
</dl>
|
|
3294
3270
|
</details>
|
|
3295
3271
|
|
|
3296
|
-
<details><summary><code>client.
|
|
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>
|
|
3297
3273
|
<dl>
|
|
3298
3274
|
<dd>
|
|
3299
3275
|
|
|
@@ -3305,7 +3281,9 @@ await client.tts.voices.create({
|
|
|
3305
3281
|
<dl>
|
|
3306
3282
|
<dd>
|
|
3307
3283
|
|
|
3308
|
-
|
|
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.
|
|
3309
3287
|
</dd>
|
|
3310
3288
|
</dl>
|
|
3311
3289
|
</dd>
|
|
@@ -3320,8 +3298,8 @@ Deletes a previously generated custom voice.
|
|
|
3320
3298
|
<dd>
|
|
3321
3299
|
|
|
3322
3300
|
```typescript
|
|
3323
|
-
await client.
|
|
3324
|
-
|
|
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."
|
|
3325
3303
|
});
|
|
3326
3304
|
|
|
3327
3305
|
```
|
|
@@ -3338,7 +3316,7 @@ await client.tts.voices.delete({
|
|
|
3338
3316
|
<dl>
|
|
3339
3317
|
<dd>
|
|
3340
3318
|
|
|
3341
|
-
**
|
|
3319
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
3342
3320
|
|
|
3343
3321
|
</dd>
|
|
3344
3322
|
</dl>
|
|
@@ -3346,7 +3324,29 @@ await client.tts.voices.delete({
|
|
|
3346
3324
|
<dl>
|
|
3347
3325
|
<dd>
|
|
3348
3326
|
|
|
3349
|
-
**
|
|
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.
|
|
3334
|
+
|
|
3335
|
+
</dd>
|
|
3336
|
+
</dl>
|
|
3337
|
+
|
|
3338
|
+
<dl>
|
|
3339
|
+
<dd>
|
|
3340
|
+
|
|
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>
|