hume 0.15.3 → 0.15.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/empathicVoice/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/empathicVoice/client/Client.js +8 -8
- package/dist/cjs/api/resources/empathicVoice/resources/chat/client/Client.js +1 -1
- package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/empathicVoice/resources/chatGroups/client/Client.js +92 -92
- package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +18 -18
- package/dist/cjs/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +16 -16
- package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/controlPlane/client/Client.js +9 -4
- package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.ts +24 -1
- package/dist/cjs/api/resources/empathicVoice/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/empathicVoice/types/JsonMessage.d.ts +31 -1
- package/dist/cjs/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedConfigPromptSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedTimeoutSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.d.ts +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookEventType.js +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/PostedWebhookSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChat.d.ts +11 -11
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +10 -10
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +16 -16
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +6 -6
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +8 -8
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +27 -27
- package/dist/cjs/api/resources/empathicVoice/types/ReturnConfig.d.ts +20 -41
- package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +4 -4
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnPrompt.d.ts +12 -23
- package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +20 -20
- package/dist/cjs/api/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.d.ts +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.js +1 -0
- package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +2 -2
- package/dist/cjs/api/resources/empathicVoice/types/SubscribeEvent.d.ts +34 -1
- package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tts/resources/streamInput/client/Client.js +7 -2
- package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tts/resources/voices/client/Client.js +7 -2
- package/dist/cjs/api/resources/tts/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/PostedTts.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/Snippet.d.ts +1 -1
- package/dist/cjs/api/resources/tts/types/Timestamp.d.ts +2 -0
- package/dist/cjs/core/websocket/ws.js +3 -2
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ErrorResponse.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedBuiltinTool.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedTimeoutSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedTimeoutSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookEventType.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/PostedWebhookSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnBuiltinTool.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChat.d.ts +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChat.js +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatEvent.js +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroup.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroup.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +3 -3
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.ts +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.js +4 -4
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +5 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnConfig.d.ts +12 -12
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnConfig.js +12 -12
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChats.d.ts +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedChats.js +2 -2
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedConfigs.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedPrompts.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +4 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnPrompt.js +4 -5
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.js +8 -8
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnVoice.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookEventType.js +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookSpec.d.ts +1 -1
- package/dist/cjs/serialization/resources/empathicVoice/types/ReturnWebhookSpec.js +1 -1
- package/dist/cjs/serialization/resources/tts/types/ErrorResponse.d.ts +1 -1
- package/dist/cjs/serialization/resources/tts/types/ErrorResponse.js +1 -1
- package/dist/cjs/serialization/resources/tts/types/ReturnVoice.d.ts +1 -1
- package/dist/cjs/serialization/resources/tts/types/ReturnVoice.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/empathicVoice/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/empathicVoice/client/Client.mjs +8 -8
- package/dist/esm/api/resources/empathicVoice/resources/chat/client/Client.mjs +1 -1
- package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/empathicVoice/resources/chatGroups/client/Client.mjs +92 -92
- package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +18 -18
- package/dist/esm/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +16 -16
- package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/controlPlane/client/Client.mjs +9 -4
- package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ControlPlanePublishEvent.d.mts +24 -1
- package/dist/esm/api/resources/empathicVoice/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/api/resources/empathicVoice/types/JsonMessage.d.mts +31 -1
- package/dist/esm/api/resources/empathicVoice/types/PostedBuiltinTool.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedConfigPromptSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedTimeoutSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.d.mts +1 -0
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookEventType.mjs +1 -0
- package/dist/esm/api/resources/empathicVoice/types/PostedWebhookSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnChat.d.mts +11 -11
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.mts +10 -10
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatEvent.d.mts +16 -16
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroup.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +6 -6
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +8 -8
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +27 -27
- package/dist/esm/api/resources/empathicVoice/types/ReturnConfig.d.mts +20 -41
- package/dist/esm/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedChats.d.mts +4 -4
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnPrompt.d.mts +12 -23
- package/dist/esm/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +20 -20
- package/dist/esm/api/resources/empathicVoice/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.d.mts +1 -0
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookEventType.mjs +1 -0
- package/dist/esm/api/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +2 -2
- package/dist/esm/api/resources/empathicVoice/types/SubscribeEvent.d.mts +34 -1
- package/dist/esm/api/resources/tts/resources/streamInput/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tts/resources/streamInput/client/Client.mjs +7 -2
- package/dist/esm/api/resources/tts/resources/voices/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tts/resources/voices/client/Client.mjs +7 -2
- package/dist/esm/api/resources/tts/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/PostedTts.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/Snippet.d.mts +1 -1
- package/dist/esm/api/resources/tts/types/Timestamp.d.mts +2 -0
- package/dist/esm/core/websocket/ws.mjs +3 -2
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfig.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ErrorResponse.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedBuiltinTool.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedBuiltinTool.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedConfigPromptSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedTimeoutSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedTimeoutSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookEventType.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/PostedWebhookSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnBuiltinTool.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChat.d.mts +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChat.mjs +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatEvent.d.mts +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatEvent.mjs +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroup.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroup.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.mts +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.mjs +3 -3
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.d.mts +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedChats.mjs +4 -4
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.mts +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.mjs +5 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnConfig.d.mts +12 -12
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnConfig.mjs +12 -12
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChats.d.mts +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedChats.mjs +2 -2
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedConfigs.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedConfigs.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedPrompts.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedPrompts.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPagedUserDefinedTools.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPrompt.d.mts +4 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnPrompt.mjs +4 -5
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnTimeoutSpec.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.mts +8 -8
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.mjs +8 -8
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnVoice.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookEventType.mjs +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookSpec.d.mts +1 -1
- package/dist/esm/serialization/resources/empathicVoice/types/ReturnWebhookSpec.mjs +1 -1
- package/dist/esm/serialization/resources/tts/types/ErrorResponse.d.mts +1 -1
- package/dist/esm/serialization/resources/tts/types/ErrorResponse.mjs +1 -1
- package/dist/esm/serialization/resources/tts/types/ReturnVoice.d.mts +1 -1
- package/dist/esm/serialization/resources/tts/types/ReturnVoice.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +576 -576
|
@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A configuration of a built-in tool to be posted to the server
|
|
4
4
|
*/
|
|
5
5
|
export interface PostedBuiltinTool {
|
|
6
|
+
/** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
|
|
7
|
+
fallbackContent?: string;
|
|
6
8
|
/**
|
|
7
9
|
* Name of the built-in tool to use. Hume supports the following built-in tools:
|
|
8
10
|
*
|
|
@@ -12,6 +14,4 @@ export interface PostedBuiltinTool {
|
|
|
12
14
|
* For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
|
|
13
15
|
*/
|
|
14
16
|
name: Hume.empathicVoice.PostedBuiltinToolName;
|
|
15
|
-
/** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
|
|
16
|
-
fallbackContent?: string;
|
|
17
17
|
}
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
export interface PostedConfigPromptSpec {
|
|
5
5
|
/** Identifier for a Prompt. Formatted as a UUID. */
|
|
6
6
|
id?: string;
|
|
7
|
-
/** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
|
|
8
|
-
version?: number;
|
|
9
7
|
/** Text used to create a new prompt for a particular config. */
|
|
10
8
|
text?: string;
|
|
9
|
+
/** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
|
|
10
|
+
version?: number;
|
|
11
11
|
}
|
|
@@ -5,8 +5,6 @@ import type * as Hume from "../../../index.js";
|
|
|
5
5
|
* Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
|
|
6
6
|
*/
|
|
7
7
|
export interface PostedEventMessageSpecs {
|
|
8
|
-
/** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
|
|
9
|
-
onNewChat?: Hume.empathicVoice.PostedEventMessageSpec;
|
|
10
8
|
/**
|
|
11
9
|
* Specifies the message EVI provides when the chat is about to be disconnected due to a user inactivity timeout, such as a message mentioning a lack of user input for a period of time.
|
|
12
10
|
*
|
|
@@ -19,4 +17,6 @@ export interface PostedEventMessageSpecs {
|
|
|
19
17
|
onInactivityTimeout?: Hume.empathicVoice.PostedEventMessageSpec;
|
|
20
18
|
/** Specifies the message EVI provides when the chat is disconnected due to reaching the maximum chat duration, such as a message mentioning the time limit for the chat has been reached. */
|
|
21
19
|
onMaxDurationTimeout?: Hume.empathicVoice.PostedEventMessageSpec;
|
|
20
|
+
/** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
|
|
21
|
+
onNewChat?: Hume.empathicVoice.PostedEventMessageSpec;
|
|
22
22
|
}
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* Settings for a specific timeout to be posted to the server
|
|
3
3
|
*/
|
|
4
4
|
export interface PostedTimeoutSpec {
|
|
5
|
-
/** Boolean indicating if this event message is enabled. */
|
|
6
|
-
enabled: boolean;
|
|
7
5
|
/** Duration in seconds for the timeout. */
|
|
8
6
|
durationSecs?: number;
|
|
7
|
+
/** Boolean indicating if this event message is enabled. */
|
|
8
|
+
enabled: boolean;
|
|
9
9
|
}
|
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
export declare const PostedWebhookEventType: {
|
|
3
3
|
readonly ChatStarted: "chat_started";
|
|
4
4
|
readonly ChatEnded: "chat_ended";
|
|
5
|
+
readonly ToolCall: "tool_call";
|
|
5
6
|
};
|
|
6
7
|
export type PostedWebhookEventType = (typeof PostedWebhookEventType)[keyof typeof PostedWebhookEventType];
|
|
@@ -3,12 +3,12 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* URL and settings for a specific webhook to be posted to the server
|
|
4
4
|
*/
|
|
5
5
|
export interface PostedWebhookSpec {
|
|
6
|
-
/** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
|
|
7
|
-
url: string;
|
|
8
6
|
/**
|
|
9
7
|
* The list of events the specified URL is subscribed to.
|
|
10
8
|
*
|
|
11
9
|
* See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
|
|
12
10
|
*/
|
|
13
11
|
events: Hume.empathicVoice.PostedWebhookEventType[];
|
|
12
|
+
/** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
|
|
13
|
+
url: string;
|
|
14
14
|
}
|
|
@@ -3,10 +3,10 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A specific builtin tool version returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnBuiltinTool {
|
|
6
|
-
/** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
|
|
7
|
-
toolType: Hume.empathicVoice.ReturnBuiltinToolToolType;
|
|
8
|
-
/** Name applied to all versions of a particular Tool. */
|
|
9
|
-
name: string;
|
|
10
6
|
/** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
|
|
11
7
|
fallbackContent?: string;
|
|
8
|
+
/** Name applied to all versions of a particular Tool. */
|
|
9
|
+
name: string;
|
|
10
|
+
/** Type of Tool. Either `BUILTIN` for natively implemented tools, like web search, or `FUNCTION` for user-defined tools. */
|
|
11
|
+
toolType: Hume.empathicVoice.ReturnBuiltinToolToolType;
|
|
12
12
|
}
|
|
@@ -3,10 +3,19 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A description of chat and its status
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChat {
|
|
6
|
-
/** Identifier for a Chat. Formatted as a UUID. */
|
|
7
|
-
id: string;
|
|
8
6
|
/** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
|
|
9
7
|
chatGroupId: string;
|
|
8
|
+
config?: Hume.empathicVoice.ReturnConfigSpec;
|
|
9
|
+
/** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
|
|
10
|
+
endTimestamp?: number;
|
|
11
|
+
/** The total number of events currently in this chat. */
|
|
12
|
+
eventCount?: number;
|
|
13
|
+
/** Identifier for a Chat. Formatted as a UUID. */
|
|
14
|
+
id: string;
|
|
15
|
+
/** Stringified JSON with additional metadata about the chat. */
|
|
16
|
+
metadata?: string;
|
|
17
|
+
/** Time at which the Chat started. Measured in seconds since the Unix epoch. */
|
|
18
|
+
startTimestamp: number;
|
|
10
19
|
/**
|
|
11
20
|
* Indicates the current state of the chat. There are six possible statuses:
|
|
12
21
|
*
|
|
@@ -23,13 +32,4 @@ export interface ReturnChat {
|
|
|
23
32
|
* - `ERROR`: The chat ended unexpectedly due to an error.
|
|
24
33
|
*/
|
|
25
34
|
status: Hume.empathicVoice.ReturnChatStatus;
|
|
26
|
-
/** Time at which the Chat started. Measured in seconds since the Unix epoch. */
|
|
27
|
-
startTimestamp: number;
|
|
28
|
-
/** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
|
|
29
|
-
endTimestamp?: number;
|
|
30
|
-
/** The total number of events currently in this chat. */
|
|
31
|
-
eventCount?: number;
|
|
32
|
-
/** Stringified JSON with additional metadata about the chat. */
|
|
33
|
-
metadata?: string;
|
|
34
|
-
config?: Hume.empathicVoice.ReturnConfigSpec;
|
|
35
35
|
}
|
|
@@ -3,10 +3,16 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* List of chat audio reconstructions returned for the specified page number and page size.
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatAudioReconstruction {
|
|
6
|
+
/** Name of the chat audio reconstruction file. */
|
|
7
|
+
filename?: string;
|
|
6
8
|
/** Identifier for the chat. Formatted as a UUID. */
|
|
7
9
|
id: string;
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
+
/** The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch. */
|
|
11
|
+
modifiedAt?: number;
|
|
12
|
+
/** Signed URL used to download the chat audio reconstruction file. */
|
|
13
|
+
signedAudioUrl?: string;
|
|
14
|
+
/** The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds. */
|
|
15
|
+
signedUrlExpirationTimestampMillis?: number;
|
|
10
16
|
/**
|
|
11
17
|
* Indicates the current state of the audio reconstruction job. There are five possible statuses:
|
|
12
18
|
*
|
|
@@ -21,12 +27,6 @@ export interface ReturnChatAudioReconstruction {
|
|
|
21
27
|
* - `CANCELED`: The reconstruction job has been canceled.
|
|
22
28
|
*/
|
|
23
29
|
status: Hume.empathicVoice.ReturnChatAudioReconstructionStatus;
|
|
24
|
-
/**
|
|
25
|
-
|
|
26
|
-
/** The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch. */
|
|
27
|
-
modifiedAt?: number;
|
|
28
|
-
/** Signed URL used to download the chat audio reconstruction file. */
|
|
29
|
-
signedAudioUrl?: string;
|
|
30
|
-
/** The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds. */
|
|
31
|
-
signedUrlExpirationTimestampMillis?: number;
|
|
30
|
+
/** Identifier for the user that owns this chat. Formatted as a UUID. */
|
|
31
|
+
userId: string;
|
|
32
32
|
}
|
|
@@ -3,12 +3,22 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A description of a single event in a chat returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatEvent {
|
|
6
|
-
/** Identifier for a Chat Event. Formatted as a UUID. */
|
|
7
|
-
id: string;
|
|
8
6
|
/** Identifier for the Chat this event occurred in. Formatted as a UUID. */
|
|
9
7
|
chatId: string;
|
|
10
|
-
/**
|
|
11
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Stringified JSON containing the prosody model inference results.
|
|
10
|
+
*
|
|
11
|
+
* EVI uses the prosody model to measure 48 expressions related to speech and vocal characteristics. These results contain a detailed emotional and tonal analysis of the audio. Scores typically range from 0 to 1, with higher values indicating a stronger confidence level in the measured attribute.
|
|
12
|
+
*/
|
|
13
|
+
emotionFeatures?: string;
|
|
14
|
+
/** Identifier for a Chat Event. Formatted as a UUID. */
|
|
15
|
+
id: string;
|
|
16
|
+
/** The text of the Chat Event. This field contains the message content for each event type listed in the `type` field. */
|
|
17
|
+
messageText?: string;
|
|
18
|
+
/** Stringified JSON with additional metadata about the chat event. */
|
|
19
|
+
metadata?: string;
|
|
20
|
+
/** Identifier for a related chat event. Currently only seen on ASSISTANT_PROSODY events, to point back to the ASSISTANT_MESSAGE that generated these prosody scores */
|
|
21
|
+
relatedEventId?: string;
|
|
12
22
|
/**
|
|
13
23
|
* The role of the entity which generated the Chat Event. There are four possible values:
|
|
14
24
|
* - `USER`: The user, capable of sending user messages and interruptions.
|
|
@@ -17,6 +27,8 @@ export interface ReturnChatEvent {
|
|
|
17
27
|
* - `TOOL`: The function calling mechanism.
|
|
18
28
|
*/
|
|
19
29
|
role: Hume.empathicVoice.ReturnChatEventRole;
|
|
30
|
+
/** Time at which the Chat Event occurred. Measured in seconds since the Unix epoch. */
|
|
31
|
+
timestamp: number;
|
|
20
32
|
/**
|
|
21
33
|
* Type of Chat Event. There are eleven Chat Event types:
|
|
22
34
|
* - `SYSTEM_PROMPT`: The system prompt used to initialize the session.
|
|
@@ -32,16 +44,4 @@ export interface ReturnChatEvent {
|
|
|
32
44
|
* - `CHAT_END_MESSAGE`: Indicates the end of the chat session.
|
|
33
45
|
*/
|
|
34
46
|
type: Hume.empathicVoice.ReturnChatEventType;
|
|
35
|
-
/** The text of the Chat Event. This field contains the message content for each event type listed in the `type` field. */
|
|
36
|
-
messageText?: string;
|
|
37
|
-
/**
|
|
38
|
-
* Stringified JSON containing the prosody model inference results.
|
|
39
|
-
*
|
|
40
|
-
* EVI uses the prosody model to measure 48 expressions related to speech and vocal characteristics. These results contain a detailed emotional and tonal analysis of the audio. Scores typically range from 0 to 1, with higher values indicating a stronger confidence level in the measured attribute.
|
|
41
|
-
*/
|
|
42
|
-
emotionFeatures?: string;
|
|
43
|
-
/** Stringified JSON with additional metadata about the chat event. */
|
|
44
|
-
metadata?: string;
|
|
45
|
-
/** Identifier for a related chat event. Currently only seen on ASSISTANT_PROSODY events, to point back to the ASSISTANT_MESSAGE that generated these prosody scores */
|
|
46
|
-
relatedEventId?: string;
|
|
47
47
|
}
|
|
@@ -3,17 +3,17 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A description of chat_group and its status
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatGroup {
|
|
6
|
-
/**
|
|
7
|
-
|
|
6
|
+
/** Denotes whether there is an active Chat associated with this Chat Group. */
|
|
7
|
+
active?: boolean;
|
|
8
8
|
/** Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
|
|
9
9
|
firstStartTimestamp: number;
|
|
10
|
-
/**
|
|
11
|
-
|
|
10
|
+
/** Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same `chat_group_id`. Formatted as a UUID. */
|
|
11
|
+
id: string;
|
|
12
12
|
/** The `chat_id` of the most recent Chat in this Chat Group. Formatted as a UUID. */
|
|
13
13
|
mostRecentChatId?: string;
|
|
14
14
|
mostRecentConfig?: Hume.empathicVoice.ReturnConfigSpec;
|
|
15
|
+
/** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
|
|
16
|
+
mostRecentStartTimestamp: number;
|
|
15
17
|
/** The total number of Chats in this Chat Group. */
|
|
16
18
|
numChats: number;
|
|
17
|
-
/** Denotes whether there is an active Chat associated with this Chat Group. */
|
|
18
|
-
active?: boolean;
|
|
19
19
|
}
|
package/dist/cjs/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts
CHANGED
|
@@ -3,10 +3,10 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A paginated list of chat reconstructions for a particular chatgroup
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatGroupPagedAudioReconstructions {
|
|
6
|
+
/** List of chat audio reconstructions returned for the specified page number and page size. */
|
|
7
|
+
audioReconstructionsPage: Hume.empathicVoice.ReturnChatAudioReconstruction[];
|
|
6
8
|
/** Identifier for the chat group. Formatted as a UUID. */
|
|
7
9
|
id: string;
|
|
8
|
-
/** Identifier for the user that owns this chat. Formatted as a UUID. */
|
|
9
|
-
userId: string;
|
|
10
10
|
/** Total number of chats in this chatgroup */
|
|
11
11
|
numChats: number;
|
|
12
12
|
/**
|
|
@@ -21,14 +21,14 @@ export interface ReturnChatGroupPagedAudioReconstructions {
|
|
|
21
21
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
22
22
|
*/
|
|
23
23
|
pageSize: number;
|
|
24
|
-
/** The total number of pages in the collection. */
|
|
25
|
-
totalPages: number;
|
|
26
24
|
/**
|
|
27
25
|
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
28
26
|
*
|
|
29
27
|
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
30
28
|
*/
|
|
31
29
|
paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructionsPaginationDirection;
|
|
32
|
-
/**
|
|
33
|
-
|
|
30
|
+
/** The total number of pages in the collection. */
|
|
31
|
+
totalPages: number;
|
|
32
|
+
/** Identifier for the user that owns this chat. Formatted as a UUID. */
|
|
33
|
+
userId: string;
|
|
34
34
|
}
|
|
@@ -3,10 +3,14 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A description of chat_group and its status with a paginated list of each chat in the chat_group
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatGroupPagedChats {
|
|
6
|
-
/**
|
|
7
|
-
|
|
6
|
+
/** Denotes whether there is an active Chat associated with this Chat Group. */
|
|
7
|
+
active?: boolean;
|
|
8
|
+
/** List of Chats for the specified `page_number` and `page_size`. */
|
|
9
|
+
chatsPage: Hume.empathicVoice.ReturnChat[];
|
|
8
10
|
/** Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
|
|
9
11
|
firstStartTimestamp: number;
|
|
12
|
+
/** Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same `chat_group_id`. Formatted as a UUID. */
|
|
13
|
+
id: string;
|
|
10
14
|
/** Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch. */
|
|
11
15
|
mostRecentStartTimestamp: number;
|
|
12
16
|
/** The total number of Chats associated with this Chat Group. */
|
|
@@ -23,16 +27,12 @@ export interface ReturnChatGroupPagedChats {
|
|
|
23
27
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
24
28
|
*/
|
|
25
29
|
pageSize: number;
|
|
26
|
-
/** The total number of pages in the collection. */
|
|
27
|
-
totalPages: number;
|
|
28
30
|
/**
|
|
29
31
|
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
30
32
|
*
|
|
31
33
|
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
32
34
|
*/
|
|
33
35
|
paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedChatsPaginationDirection;
|
|
34
|
-
/**
|
|
35
|
-
|
|
36
|
-
/** Denotes whether there is an active Chat associated with this Chat Group. */
|
|
37
|
-
active?: boolean;
|
|
36
|
+
/** The total number of pages in the collection. */
|
|
37
|
+
totalPages: number;
|
|
38
38
|
}
|
|
@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A paginated list of chat events that occurred across chats in this chat_group from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatGroupPagedEvents {
|
|
6
|
+
/** List of Chat Events for the specified `page_number` and `page_size`. */
|
|
7
|
+
eventsPage: Hume.empathicVoice.ReturnChatEvent[];
|
|
6
8
|
/** Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same `chat_group_id`. Formatted as a UUID. */
|
|
7
9
|
id: string;
|
|
8
10
|
/**
|
|
@@ -17,14 +19,12 @@ export interface ReturnChatGroupPagedEvents {
|
|
|
17
19
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
18
20
|
*/
|
|
19
21
|
pageSize: number;
|
|
20
|
-
/** The total number of pages in the collection. */
|
|
21
|
-
totalPages: number;
|
|
22
22
|
/**
|
|
23
23
|
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
24
24
|
*
|
|
25
25
|
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
26
26
|
*/
|
|
27
27
|
paginationDirection: Hume.empathicVoice.ReturnChatGroupPagedEventsPaginationDirection;
|
|
28
|
-
/**
|
|
29
|
-
|
|
28
|
+
/** The total number of pages in the collection. */
|
|
29
|
+
totalPages: number;
|
|
30
30
|
}
|
|
@@ -3,38 +3,15 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A description of chat status with a paginated list of chat events returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnChatPagedEvents {
|
|
6
|
-
/** Identifier for a Chat. Formatted as a UUID. */
|
|
7
|
-
id: string;
|
|
8
6
|
/** Identifier for the Chat Group. Any chat resumed from this Chat will have the same `chat_group_id`. Formatted as a UUID. */
|
|
9
7
|
chatGroupId: string;
|
|
10
|
-
|
|
11
|
-
* Indicates the current state of the chat. There are six possible statuses:
|
|
12
|
-
*
|
|
13
|
-
* - `ACTIVE`: The chat is currently active and ongoing.
|
|
14
|
-
*
|
|
15
|
-
* - `USER_ENDED`: The chat was manually ended by the user.
|
|
16
|
-
*
|
|
17
|
-
* - `USER_TIMEOUT`: The chat ended due to a user-defined timeout.
|
|
18
|
-
*
|
|
19
|
-
* - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum allowed duration.
|
|
20
|
-
*
|
|
21
|
-
* - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout.
|
|
22
|
-
*
|
|
23
|
-
* - `ERROR`: The chat ended unexpectedly due to an error.
|
|
24
|
-
*/
|
|
25
|
-
status: Hume.empathicVoice.ReturnChatPagedEventsStatus;
|
|
26
|
-
/** Time at which the Chat started. Measured in seconds since the Unix epoch. */
|
|
27
|
-
startTimestamp: number;
|
|
8
|
+
config?: Hume.empathicVoice.ReturnConfigSpec;
|
|
28
9
|
/** Time at which the Chat ended. Measured in seconds since the Unix epoch. */
|
|
29
10
|
endTimestamp?: number;
|
|
30
|
-
/**
|
|
31
|
-
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
32
|
-
*
|
|
33
|
-
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
34
|
-
*/
|
|
35
|
-
paginationDirection: Hume.empathicVoice.ReturnChatPagedEventsPaginationDirection;
|
|
36
11
|
/** List of Chat Events for the specified `page_number` and `page_size`. */
|
|
37
12
|
eventsPage: Hume.empathicVoice.ReturnChatEvent[];
|
|
13
|
+
/** Identifier for a Chat. Formatted as a UUID. */
|
|
14
|
+
id: string;
|
|
38
15
|
/** Stringified JSON with additional metadata about the chat. */
|
|
39
16
|
metadata?: string;
|
|
40
17
|
/**
|
|
@@ -49,7 +26,30 @@ export interface ReturnChatPagedEvents {
|
|
|
49
26
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
50
27
|
*/
|
|
51
28
|
pageSize: number;
|
|
29
|
+
/**
|
|
30
|
+
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
31
|
+
*
|
|
32
|
+
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
33
|
+
*/
|
|
34
|
+
paginationDirection: Hume.empathicVoice.ReturnChatPagedEventsPaginationDirection;
|
|
35
|
+
/** Time at which the Chat started. Measured in seconds since the Unix epoch. */
|
|
36
|
+
startTimestamp: number;
|
|
37
|
+
/**
|
|
38
|
+
* Indicates the current state of the chat. There are six possible statuses:
|
|
39
|
+
*
|
|
40
|
+
* - `ACTIVE`: The chat is currently active and ongoing.
|
|
41
|
+
*
|
|
42
|
+
* - `USER_ENDED`: The chat was manually ended by the user.
|
|
43
|
+
*
|
|
44
|
+
* - `USER_TIMEOUT`: The chat ended due to a user-defined timeout.
|
|
45
|
+
*
|
|
46
|
+
* - `MAX_DURATION_TIMEOUT`: The chat ended because it reached the maximum allowed duration.
|
|
47
|
+
*
|
|
48
|
+
* - `INACTIVITY_TIMEOUT`: The chat ended due to an inactivity timeout.
|
|
49
|
+
*
|
|
50
|
+
* - `ERROR`: The chat ended unexpectedly due to an error.
|
|
51
|
+
*/
|
|
52
|
+
status: Hume.empathicVoice.ReturnChatPagedEventsStatus;
|
|
52
53
|
/** The total number of pages in the collection. */
|
|
53
54
|
totalPages: number;
|
|
54
|
-
config?: Hume.empathicVoice.ReturnConfigSpec;
|
|
55
55
|
}
|
|
@@ -3,52 +3,31 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A specific config version returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnConfig {
|
|
6
|
-
/**
|
|
7
|
-
|
|
6
|
+
/** List of built-in tools associated with this config */
|
|
7
|
+
builtinTools?: (Hume.empathicVoice.ReturnBuiltinTool | undefined)[];
|
|
8
|
+
/** The timestamp when the first version of this config was created. */
|
|
9
|
+
createdOn?: number;
|
|
10
|
+
ellmModel?: Hume.empathicVoice.ReturnEllmModel;
|
|
11
|
+
eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
|
|
12
|
+
/** The version of the EVI used with this config. */
|
|
13
|
+
eviVersion?: string;
|
|
8
14
|
/** Identifier for a Config. Formatted as a UUID. */
|
|
9
15
|
id?: string;
|
|
10
|
-
/**
|
|
11
|
-
* Version number for a Config.
|
|
12
|
-
*
|
|
13
|
-
* Configs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
14
|
-
*
|
|
15
|
-
* Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
16
|
-
*/
|
|
17
|
-
version?: number;
|
|
18
|
-
/**
|
|
19
|
-
* The supplemental language model associated with this Config.
|
|
20
|
-
*
|
|
21
|
-
* This model is used to generate longer, more detailed responses from EVI. Choosing an appropriate supplemental language model for your use case is crucial for generating fast, high-quality responses from EVI.
|
|
22
|
-
*/
|
|
23
16
|
languageModel?: Hume.empathicVoice.ReturnLanguageModel;
|
|
24
|
-
/**
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
|
|
28
|
-
*
|
|
29
|
-
* **We're officially sunsetting EVI versions 1 and 2 on August 30, 2025**. To keep things running smoothly, be sure to [migrate to EVI 3](/docs/speech-to-speech-evi/configuration/evi-version#migrating-to-evi-3) before then.
|
|
30
|
-
*/
|
|
31
|
-
eviVersion?: string;
|
|
32
|
-
timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
|
|
17
|
+
/** The timestamp when this version of the config was created. */
|
|
18
|
+
modifiedOn?: number;
|
|
19
|
+
/** Name applied to all versions of a particular Config. */
|
|
20
|
+
name?: string;
|
|
33
21
|
nudges?: Hume.empathicVoice.ReturnNudgeSpec;
|
|
34
|
-
eventMessages?: Hume.empathicVoice.ReturnEventMessageSpecs;
|
|
35
|
-
/**
|
|
36
|
-
* The eLLM setup associated with this Config.
|
|
37
|
-
*
|
|
38
|
-
* Hume's eLLM (empathic Large Language Model) is a multimodal language model that takes into account both expression measures and language. The eLLM generates short, empathic language responses and guides text-to-speech (TTS) prosody.
|
|
39
|
-
*/
|
|
40
|
-
ellmModel?: Hume.empathicVoice.ReturnEllmModel;
|
|
41
|
-
/** A voice specification associated with this Config. */
|
|
42
|
-
voice?: Hume.empathicVoice.ReturnVoice;
|
|
43
22
|
prompt?: Hume.empathicVoice.ReturnPrompt;
|
|
23
|
+
timeouts?: Hume.empathicVoice.ReturnTimeoutSpecs;
|
|
24
|
+
/** List of user-defined tools associated with this config. */
|
|
25
|
+
tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
|
|
26
|
+
/** Version number for a Config. Version numbers should be integers. The combination of configId and version number is unique. */
|
|
27
|
+
version?: number;
|
|
28
|
+
/** Description that is appended to a specific version of a Config. */
|
|
29
|
+
versionDescription?: string;
|
|
30
|
+
voice?: Hume.empathicVoice.ReturnVoice;
|
|
44
31
|
/** Map of webhooks associated with this config. */
|
|
45
32
|
webhooks?: (Hume.empathicVoice.ReturnWebhookSpec | undefined)[];
|
|
46
|
-
/** Time at which the Config was created. Measured in seconds since the Unix epoch. */
|
|
47
|
-
createdOn?: number;
|
|
48
|
-
/** Time at which the Config was last modified. Measured in seconds since the Unix epoch. */
|
|
49
|
-
modifiedOn?: number;
|
|
50
|
-
/** An optional description of the Config version. */
|
|
51
|
-
versionDescription?: string;
|
|
52
|
-
/** List of user-defined tools associated with this Config. */
|
|
53
|
-
tools?: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
|
|
54
33
|
}
|
|
@@ -5,8 +5,6 @@ import type * as Hume from "../../../index.js";
|
|
|
5
5
|
* Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
|
|
6
6
|
*/
|
|
7
7
|
export interface ReturnEventMessageSpecs {
|
|
8
|
-
/** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
|
|
9
|
-
onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
|
|
10
8
|
/**
|
|
11
9
|
* Specifies the message EVI provides when the chat is about to be disconnected due to a user inactivity timeout, such as a message mentioning a lack of user input for a period of time.
|
|
12
10
|
*
|
|
@@ -19,4 +17,6 @@ export interface ReturnEventMessageSpecs {
|
|
|
19
17
|
onInactivityTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;
|
|
20
18
|
/** Specifies the message EVI provides when the chat is disconnected due to reaching the maximum chat duration, such as a message mentioning the time limit for the chat has been reached. */
|
|
21
19
|
onMaxDurationTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;
|
|
20
|
+
/** Specifies the initial message EVI provides when a new chat is started, such as a greeting or welcome message. */
|
|
21
|
+
onNewChat?: Hume.empathicVoice.ReturnEventMessageSpec;
|
|
22
22
|
}
|
|
@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A paginated list of chat_groups returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnPagedChatGroups {
|
|
6
|
+
/** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
|
|
7
|
+
chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
|
|
6
8
|
/**
|
|
7
9
|
* The page number of the returned list.
|
|
8
10
|
*
|
|
@@ -15,14 +17,12 @@ export interface ReturnPagedChatGroups {
|
|
|
15
17
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
16
18
|
*/
|
|
17
19
|
pageSize: number;
|
|
18
|
-
/** The total number of pages in the collection. */
|
|
19
|
-
totalPages: number;
|
|
20
20
|
/**
|
|
21
21
|
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
22
22
|
*
|
|
23
23
|
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
24
24
|
*/
|
|
25
25
|
paginationDirection: Hume.empathicVoice.ReturnPagedChatGroupsPaginationDirection;
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** The total number of pages in the collection. */
|
|
27
|
+
totalPages: number;
|
|
28
28
|
}
|
|
@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A paginated list of chats returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnPagedChats {
|
|
6
|
+
/** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
|
|
7
|
+
chatsPage: Hume.empathicVoice.ReturnChat[];
|
|
6
8
|
/**
|
|
7
9
|
* The page number of the returned list.
|
|
8
10
|
*
|
|
@@ -15,14 +17,12 @@ export interface ReturnPagedChats {
|
|
|
15
17
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
16
18
|
*/
|
|
17
19
|
pageSize: number;
|
|
18
|
-
/** The total number of pages in the collection. */
|
|
19
|
-
totalPages: number;
|
|
20
20
|
/**
|
|
21
21
|
* Indicates the order in which the paginated results are presented, based on their creation date.
|
|
22
22
|
*
|
|
23
23
|
* It shows `ASC` for ascending order (chronological, with the oldest records first) or `DESC` for descending order (reverse-chronological, with the newest records first). This value corresponds to the `ascending_order` query parameter used in the request.
|
|
24
24
|
*/
|
|
25
25
|
paginationDirection: Hume.empathicVoice.ReturnPagedChatsPaginationDirection;
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** The total number of pages in the collection. */
|
|
27
|
+
totalPages: number;
|
|
28
28
|
}
|
|
@@ -3,6 +3,8 @@ import type * as Hume from "../../../index.js";
|
|
|
3
3
|
* A paginated list of config versions returned from the server
|
|
4
4
|
*/
|
|
5
5
|
export interface ReturnPagedConfigs {
|
|
6
|
+
/** List of configs returned for the specified `page_number` and `page_size`. */
|
|
7
|
+
configsPage?: Hume.empathicVoice.ReturnConfig[];
|
|
6
8
|
/**
|
|
7
9
|
* The page number of the returned list.
|
|
8
10
|
*
|
|
@@ -17,6 +19,4 @@ export interface ReturnPagedConfigs {
|
|
|
17
19
|
pageSize?: number;
|
|
18
20
|
/** The total number of pages in the collection. */
|
|
19
21
|
totalPages: number;
|
|
20
|
-
/** List of configs returned for the specified `page_number` and `page_size`. */
|
|
21
|
-
configsPage?: Hume.empathicVoice.ReturnConfig[];
|
|
22
22
|
}
|
|
@@ -15,8 +15,8 @@ export interface ReturnPagedPrompts {
|
|
|
15
15
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
16
16
|
*/
|
|
17
17
|
pageSize: number;
|
|
18
|
-
/** The total number of pages in the collection. */
|
|
19
|
-
totalPages: number;
|
|
20
18
|
/** List of prompts returned for the specified `page_number` and `page_size`. */
|
|
21
19
|
promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
|
|
20
|
+
/** The total number of pages in the collection. */
|
|
21
|
+
totalPages: number;
|
|
22
22
|
}
|
|
@@ -15,8 +15,8 @@ export interface ReturnPagedUserDefinedTools {
|
|
|
15
15
|
* This value corresponds to the `page_size` parameter specified in the request.
|
|
16
16
|
*/
|
|
17
17
|
pageSize: number;
|
|
18
|
-
/** The total number of pages in the collection. */
|
|
19
|
-
totalPages: number;
|
|
20
18
|
/** List of tools returned for the specified `page_number` and `page_size`. */
|
|
21
19
|
toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
|
|
20
|
+
/** The total number of pages in the collection. */
|
|
21
|
+
totalPages: number;
|
|
22
22
|
}
|