hume 0.9.12 → 0.9.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/empathic-voice/chat.yml +1 -0
- package/.mock/definition/expression-measurement/batch/__package__.yml +76 -61
- package/.mock/definition/expression-measurement/{v0StreamModels.yml → stream/stream.yml} +15 -14
- package/.mock/definition/tts/__package__.yml +36 -21
- package/.mock/definition/tts/voices.yml +3 -3
- package/.mock/fern.config.json +1 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/api/resources/expressionMeasurement/resources/batch/client/requests/BatchListJobsRequest.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/batch/types/Transcription.d.ts +0 -1
- package/api/resources/expressionMeasurement/resources/stream/index.d.ts +1 -0
- package/api/resources/expressionMeasurement/resources/stream/index.js +1 -0
- package/api/resources/expressionMeasurement/resources/stream/resources/index.d.ts +2 -0
- package/api/resources/expressionMeasurement/resources/stream/resources/index.js +31 -0
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/index.d.ts +1 -0
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/index.js +17 -0
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/Config.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictions.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsBurst.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsBurstPredictionsItem.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemesh.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemeshPredictionsItem.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguage.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsProsodyPredictionsItem.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelsEndpointPayload.d.ts +1 -1
- package/{dist/api/resources/expressionMeasurement → api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessage.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.d.ts +1 -1
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +21 -0
- package/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +37 -0
- package/api/resources/expressionMeasurement/resources/stream/types/index.d.ts +0 -21
- package/api/resources/expressionMeasurement/resources/stream/types/index.js +0 -21
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/api/resources/tts/client/Client.js +2 -2
- package/api/resources/tts/resources/voices/client/Client.js +1 -1
- package/api/resources/tts/resources/voices/client/requests/PostedVoice.d.ts +1 -1
- package/api/resources/tts/types/PostedUtterance.d.ts +4 -0
- package/api/resources/tts/types/Snippet.d.ts +6 -0
- package/api/resources/tts/types/index.d.ts +0 -1
- package/api/resources/tts/types/index.js +0 -1
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +4 -4
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +3 -3
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
- package/dist/api/resources/expressionMeasurement/resources/batch/client/requests/BatchListJobsRequest.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/batch/types/Transcription.d.ts +0 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/index.d.ts +1 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/index.js +1 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/index.d.ts +2 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/index.js +31 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/index.d.ts +1 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/index.js +17 -0
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/Config.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictions.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsBurst.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsBurstPredictionsItem.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemesh.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemeshPredictionsItem.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguage.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsProsodyPredictionsItem.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelsEndpointPayload.d.ts +1 -1
- package/{api/resources/expressionMeasurement → dist/api/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessage.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +21 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +37 -0
- package/dist/api/resources/expressionMeasurement/resources/stream/types/index.d.ts +0 -21
- package/dist/api/resources/expressionMeasurement/resources/stream/types/index.js +0 -21
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/api/resources/tts/client/Client.js +2 -2
- package/dist/api/resources/tts/resources/voices/client/Client.js +1 -1
- package/dist/api/resources/tts/resources/voices/client/requests/PostedVoice.d.ts +1 -1
- package/dist/api/resources/tts/types/PostedUtterance.d.ts +4 -0
- package/dist/api/resources/tts/types/Snippet.d.ts +6 -0
- package/dist/api/resources/tts/types/index.d.ts +0 -1
- package/dist/api/resources/tts/types/index.js +0 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/index.d.ts +1 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/index.js +1 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/index.d.ts +2 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/index.js +31 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/index.d.ts +1 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/index.js +17 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/JobDetails.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/JobDetails.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamErrorMessage.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamFace.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamFace.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamLanguage.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictions.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictions.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.d.ts +5 -5
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.js +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.d.ts +5 -5
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.js +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemeshPredictionsItem.d.ts +4 -4
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemeshPredictionsItem.js +2 -2
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsJobDetails.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.d.ts +7 -7
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.js +5 -5
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsodyPredictionsItem.d.ts +5 -5
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsProsodyPredictionsItem.js +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelsEndpointPayload.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelsEndpointPayload.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessage.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessage.js +1 -1
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessageJobDetails.d.ts +3 -3
- package/{serialization/resources/expressionMeasurement → dist/serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessageJobDetails.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.d.ts +3 -3
- package/dist/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.js +1 -1
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +21 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +37 -0
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/index.d.ts +0 -21
- package/dist/serialization/resources/expressionMeasurement/resources/stream/types/index.js +0 -21
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/dist/serialization/resources/tts/types/PostedUtterance.d.ts +2 -0
- package/dist/serialization/resources/tts/types/PostedUtterance.js +2 -0
- package/dist/serialization/resources/tts/types/Snippet.d.ts +3 -0
- package/dist/serialization/resources/tts/types/Snippet.js +3 -0
- package/dist/serialization/resources/tts/types/index.d.ts +0 -1
- package/dist/serialization/resources/tts/types/index.js +0 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +552 -552
- package/serialization/resources/expressionMeasurement/resources/stream/index.d.ts +1 -0
- package/serialization/resources/expressionMeasurement/resources/stream/index.js +1 -0
- package/serialization/resources/expressionMeasurement/resources/stream/resources/index.d.ts +2 -0
- package/serialization/resources/expressionMeasurement/resources/stream/resources/index.js +31 -0
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/index.d.ts +1 -0
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/index.js +17 -0
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/JobDetails.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/JobDetails.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamErrorMessage.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamFace.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamFace.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamLanguage.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictions.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictions.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.d.ts +5 -5
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.js +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.d.ts +5 -5
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacePredictionsItem.js +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemeshPredictionsItem.d.ts +4 -4
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsFacemeshPredictionsItem.js +2 -2
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsJobDetails.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.d.ts +7 -7
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsLanguagePredictionsItem.js +5 -5
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsodyPredictionsItem.d.ts +5 -5
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelPredictionsProsodyPredictionsItem.js +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelsEndpointPayload.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamModelsEndpointPayload.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessage.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessage.js +1 -1
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessageJobDetails.d.ts +3 -3
- package/{dist/serialization/resources/expressionMeasurement → serialization/resources/expressionMeasurement/resources/stream}/resources/stream/types/StreamWarningMessageJobDetails.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.d.ts +3 -3
- package/serialization/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.js +1 -1
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.d.ts +21 -0
- package/serialization/resources/expressionMeasurement/resources/stream/resources/stream/types/index.js +37 -0
- package/serialization/resources/expressionMeasurement/resources/stream/types/index.d.ts +0 -21
- package/serialization/resources/expressionMeasurement/resources/stream/types/index.js +0 -21
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/serialization/resources/tts/types/PostedUtterance.d.ts +2 -0
- package/serialization/resources/tts/types/PostedUtterance.js +2 -0
- package/serialization/resources/tts/types/Snippet.d.ts +3 -0
- package/serialization/resources/tts/types/Snippet.js +3 -0
- package/serialization/resources/tts/types/index.d.ts +0 -1
- package/serialization/resources/tts/types/index.js +0 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/tts/types/PostedTtsRecord.d.ts +0 -11
- package/api/resources/tts/types/PostedTtsRecord.js +0 -5
- package/dist/api/resources/tts/types/PostedTtsRecord.d.ts +0 -11
- package/dist/api/resources/tts/types/PostedTtsRecord.js +0 -5
- package/dist/serialization/resources/tts/types/PostedTtsRecord.d.ts +0 -17
- package/dist/serialization/resources/tts/types/PostedTtsRecord.js +0 -38
- package/serialization/resources/tts/types/PostedTtsRecord.d.ts +0 -17
- package/serialization/resources/tts/types/PostedTtsRecord.js +0 -38
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/JobDetails.d.ts +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/JobDetails.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamFace.d.ts +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamFace.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.d.ts +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictions.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacePredictionsItem.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemeshPredictionsItem.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.d.ts +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguagePredictionsItem.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsodyPredictionsItem.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelsEndpointPayload.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessage.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessageJobDetails.d.ts +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessageJobDetails.js +0 -0
- /package/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/Config.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/JobDetails.d.ts +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/JobDetails.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamErrorMessage.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamFace.d.ts +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamFace.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.d.ts +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamLanguage.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictions.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurst.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsBurstPredictionsItem.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFace.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacePredictionsItem.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemesh.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsFacemeshPredictionsItem.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.d.ts +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsJobDetails.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguage.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsLanguagePredictionsItem.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsody.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelPredictionsProsodyPredictionsItem.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamModelsEndpointPayload.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessage.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessageJobDetails.d.ts +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/StreamWarningMessageJobDetails.js +0 -0
- /package/dist/api/resources/expressionMeasurement/resources/stream/{types → resources/stream/types}/SubscribeEvent.js +0 -0
package/reference.md
CHANGED
|
@@ -236,9 +236,9 @@ await client.tts.voices.create({
|
|
|
236
236
|
</dl>
|
|
237
237
|
</details>
|
|
238
238
|
|
|
239
|
-
##
|
|
239
|
+
## EmpathicVoice Tools
|
|
240
240
|
|
|
241
|
-
<details><summary><code>client.
|
|
241
|
+
<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></code></summary>
|
|
242
242
|
<dl>
|
|
243
243
|
<dd>
|
|
244
244
|
|
|
@@ -250,7 +250,9 @@ await client.tts.voices.create({
|
|
|
250
250
|
<dl>
|
|
251
251
|
<dd>
|
|
252
252
|
|
|
253
|
-
|
|
253
|
+
Fetches a paginated list of **Tools**.
|
|
254
|
+
|
|
255
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
254
256
|
|
|
255
257
|
</dd>
|
|
256
258
|
</dl>
|
|
@@ -266,7 +268,10 @@ Sort and filter jobs.
|
|
|
266
268
|
<dd>
|
|
267
269
|
|
|
268
270
|
```typescript
|
|
269
|
-
await client.
|
|
271
|
+
await client.empathicVoice.tools.listTools({
|
|
272
|
+
pageNumber: 0,
|
|
273
|
+
pageSize: 2,
|
|
274
|
+
});
|
|
270
275
|
```
|
|
271
276
|
|
|
272
277
|
</dd>
|
|
@@ -282,7 +287,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
282
287
|
<dl>
|
|
283
288
|
<dd>
|
|
284
289
|
|
|
285
|
-
**request:** `Hume.
|
|
290
|
+
**request:** `Hume.empathicVoice.ToolsListToolsRequest`
|
|
286
291
|
|
|
287
292
|
</dd>
|
|
288
293
|
</dl>
|
|
@@ -290,7 +295,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
290
295
|
<dl>
|
|
291
296
|
<dd>
|
|
292
297
|
|
|
293
|
-
**requestOptions:** `
|
|
298
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
294
299
|
|
|
295
300
|
</dd>
|
|
296
301
|
</dl>
|
|
@@ -301,7 +306,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
301
306
|
</dl>
|
|
302
307
|
</details>
|
|
303
308
|
|
|
304
|
-
<details><summary><code>client.
|
|
309
|
+
<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>
|
|
305
310
|
<dl>
|
|
306
311
|
<dd>
|
|
307
312
|
|
|
@@ -313,7 +318,9 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
313
318
|
<dl>
|
|
314
319
|
<dd>
|
|
315
320
|
|
|
316
|
-
|
|
321
|
+
Creates a **Tool** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
322
|
+
|
|
323
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
317
324
|
|
|
318
325
|
</dd>
|
|
319
326
|
</dl>
|
|
@@ -329,9 +336,13 @@ Start a new measurement inference job.
|
|
|
329
336
|
<dd>
|
|
330
337
|
|
|
331
338
|
```typescript
|
|
332
|
-
await client.
|
|
333
|
-
|
|
334
|
-
|
|
339
|
+
await client.empathicVoice.tools.createTool({
|
|
340
|
+
name: "get_current_weather",
|
|
341
|
+
parameters:
|
|
342
|
+
'{ "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"] }',
|
|
343
|
+
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
344
|
+
description: "This tool is for getting the current weather.",
|
|
345
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
335
346
|
});
|
|
336
347
|
```
|
|
337
348
|
|
|
@@ -348,7 +359,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
348
359
|
<dl>
|
|
349
360
|
<dd>
|
|
350
361
|
|
|
351
|
-
**request:** `Hume.
|
|
362
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedTool`
|
|
352
363
|
|
|
353
364
|
</dd>
|
|
354
365
|
</dl>
|
|
@@ -356,7 +367,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
356
367
|
<dl>
|
|
357
368
|
<dd>
|
|
358
369
|
|
|
359
|
-
**requestOptions:** `
|
|
370
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
360
371
|
|
|
361
372
|
</dd>
|
|
362
373
|
</dl>
|
|
@@ -367,7 +378,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
367
378
|
</dl>
|
|
368
379
|
</details>
|
|
369
380
|
|
|
370
|
-
<details><summary><code>client.
|
|
381
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">listToolVersions</a>(id, { ...params }) -> Hume.ReturnPagedUserDefinedTools</code></summary>
|
|
371
382
|
<dl>
|
|
372
383
|
<dd>
|
|
373
384
|
|
|
@@ -379,7 +390,9 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
379
390
|
<dl>
|
|
380
391
|
<dd>
|
|
381
392
|
|
|
382
|
-
|
|
393
|
+
Fetches a list of a **Tool's** versions.
|
|
394
|
+
|
|
395
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
383
396
|
|
|
384
397
|
</dd>
|
|
385
398
|
</dl>
|
|
@@ -395,7 +408,7 @@ Get the request details and state of a given job.
|
|
|
395
408
|
<dd>
|
|
396
409
|
|
|
397
410
|
```typescript
|
|
398
|
-
await client.
|
|
411
|
+
await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
399
412
|
```
|
|
400
413
|
|
|
401
414
|
</dd>
|
|
@@ -411,7 +424,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
411
424
|
<dl>
|
|
412
425
|
<dd>
|
|
413
426
|
|
|
414
|
-
**id:** `string` —
|
|
427
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
415
428
|
|
|
416
429
|
</dd>
|
|
417
430
|
</dl>
|
|
@@ -419,7 +432,15 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
419
432
|
<dl>
|
|
420
433
|
<dd>
|
|
421
434
|
|
|
422
|
-
**
|
|
435
|
+
**request:** `Hume.empathicVoice.ToolsListToolVersionsRequest`
|
|
436
|
+
|
|
437
|
+
</dd>
|
|
438
|
+
</dl>
|
|
439
|
+
|
|
440
|
+
<dl>
|
|
441
|
+
<dd>
|
|
442
|
+
|
|
443
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
423
444
|
|
|
424
445
|
</dd>
|
|
425
446
|
</dl>
|
|
@@ -430,7 +451,7 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
430
451
|
</dl>
|
|
431
452
|
</details>
|
|
432
453
|
|
|
433
|
-
<details><summary><code>client.
|
|
454
|
+
<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>
|
|
434
455
|
<dl>
|
|
435
456
|
<dd>
|
|
436
457
|
|
|
@@ -442,7 +463,9 @@ await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
|
442
463
|
<dl>
|
|
443
464
|
<dd>
|
|
444
465
|
|
|
445
|
-
|
|
466
|
+
Updates a **Tool** by creating a new version of the **Tool**.
|
|
467
|
+
|
|
468
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
446
469
|
|
|
447
470
|
</dd>
|
|
448
471
|
</dl>
|
|
@@ -458,7 +481,13 @@ Get the JSON predictions of a completed inference job.
|
|
|
458
481
|
<dd>
|
|
459
482
|
|
|
460
483
|
```typescript
|
|
461
|
-
await client.
|
|
484
|
+
await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
485
|
+
parameters:
|
|
486
|
+
'{ "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"] }',
|
|
487
|
+
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
488
|
+
fallbackContent: "Unable to fetch current weather.",
|
|
489
|
+
description: "This tool is for getting the current weather.",
|
|
490
|
+
});
|
|
462
491
|
```
|
|
463
492
|
|
|
464
493
|
</dd>
|
|
@@ -474,7 +503,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
474
503
|
<dl>
|
|
475
504
|
<dd>
|
|
476
505
|
|
|
477
|
-
**id:** `string` —
|
|
506
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
478
507
|
|
|
479
508
|
</dd>
|
|
480
509
|
</dl>
|
|
@@ -482,7 +511,15 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
482
511
|
<dl>
|
|
483
512
|
<dd>
|
|
484
513
|
|
|
485
|
-
**
|
|
514
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersion`
|
|
515
|
+
|
|
516
|
+
</dd>
|
|
517
|
+
</dl>
|
|
518
|
+
|
|
519
|
+
<dl>
|
|
520
|
+
<dd>
|
|
521
|
+
|
|
522
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
486
523
|
|
|
487
524
|
</dd>
|
|
488
525
|
</dl>
|
|
@@ -493,7 +530,7 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
493
530
|
</dl>
|
|
494
531
|
</details>
|
|
495
532
|
|
|
496
|
-
<details><summary><code>client.
|
|
533
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code></summary>
|
|
497
534
|
<dl>
|
|
498
535
|
<dd>
|
|
499
536
|
|
|
@@ -505,7 +542,9 @@ await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
|
505
542
|
<dl>
|
|
506
543
|
<dd>
|
|
507
544
|
|
|
508
|
-
|
|
545
|
+
Deletes a **Tool** and its versions.
|
|
546
|
+
|
|
547
|
+
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
509
548
|
|
|
510
549
|
</dd>
|
|
511
550
|
</dl>
|
|
@@ -521,10 +560,7 @@ Start a new batch inference job.
|
|
|
521
560
|
<dd>
|
|
522
561
|
|
|
523
562
|
```typescript
|
|
524
|
-
await client.
|
|
525
|
-
[fs.createReadStream("/path/to/your/file")],
|
|
526
|
-
{}
|
|
527
|
-
);
|
|
563
|
+
await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268bea");
|
|
528
564
|
```
|
|
529
565
|
|
|
530
566
|
</dd>
|
|
@@ -540,15 +576,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
540
576
|
<dl>
|
|
541
577
|
<dd>
|
|
542
578
|
|
|
543
|
-
**
|
|
544
|
-
|
|
545
|
-
</dd>
|
|
546
|
-
</dl>
|
|
547
|
-
|
|
548
|
-
<dl>
|
|
549
|
-
<dd>
|
|
550
|
-
|
|
551
|
-
**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
|
|
579
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
552
580
|
|
|
553
581
|
</dd>
|
|
554
582
|
</dl>
|
|
@@ -556,7 +584,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
556
584
|
<dl>
|
|
557
585
|
<dd>
|
|
558
586
|
|
|
559
|
-
**requestOptions:** `
|
|
587
|
+
**requestOptions:** `Tools.RequestOptions`
|
|
560
588
|
|
|
561
589
|
</dd>
|
|
562
590
|
</dl>
|
|
@@ -567,9 +595,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
567
595
|
</dl>
|
|
568
596
|
</details>
|
|
569
597
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
<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></code></summary>
|
|
598
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code></summary>
|
|
573
599
|
<dl>
|
|
574
600
|
<dd>
|
|
575
601
|
|
|
@@ -581,7 +607,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
581
607
|
<dl>
|
|
582
608
|
<dd>
|
|
583
609
|
|
|
584
|
-
|
|
610
|
+
Updates the name of a **Tool**.
|
|
585
611
|
|
|
586
612
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
587
613
|
|
|
@@ -599,9 +625,8 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
599
625
|
<dd>
|
|
600
626
|
|
|
601
627
|
```typescript
|
|
602
|
-
await client.empathicVoice.tools.
|
|
603
|
-
|
|
604
|
-
pageSize: 2,
|
|
628
|
+
await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-609864268bea", {
|
|
629
|
+
name: "get_current_temperature",
|
|
605
630
|
});
|
|
606
631
|
```
|
|
607
632
|
|
|
@@ -618,7 +643,15 @@ await client.empathicVoice.tools.listTools({
|
|
|
618
643
|
<dl>
|
|
619
644
|
<dd>
|
|
620
645
|
|
|
621
|
-
**
|
|
646
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
647
|
+
|
|
648
|
+
</dd>
|
|
649
|
+
</dl>
|
|
650
|
+
|
|
651
|
+
<dl>
|
|
652
|
+
<dd>
|
|
653
|
+
|
|
654
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
622
655
|
|
|
623
656
|
</dd>
|
|
624
657
|
</dl>
|
|
@@ -637,7 +670,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
637
670
|
</dl>
|
|
638
671
|
</details>
|
|
639
672
|
|
|
640
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
673
|
+
<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>
|
|
641
674
|
<dl>
|
|
642
675
|
<dd>
|
|
643
676
|
|
|
@@ -649,7 +682,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
649
682
|
<dl>
|
|
650
683
|
<dd>
|
|
651
684
|
|
|
652
|
-
|
|
685
|
+
Fetches a specified version of a **Tool**.
|
|
653
686
|
|
|
654
687
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
655
688
|
|
|
@@ -667,14 +700,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
667
700
|
<dd>
|
|
668
701
|
|
|
669
702
|
```typescript
|
|
670
|
-
await client.empathicVoice.tools.
|
|
671
|
-
name: "get_current_weather",
|
|
672
|
-
parameters:
|
|
673
|
-
'{ "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"] }',
|
|
674
|
-
versionDescription: "Fetches current weather and uses celsius or fahrenheit based on location of user.",
|
|
675
|
-
description: "This tool is for getting the current weather.",
|
|
676
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
677
|
-
});
|
|
703
|
+
await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
678
704
|
```
|
|
679
705
|
|
|
680
706
|
</dd>
|
|
@@ -690,7 +716,21 @@ await client.empathicVoice.tools.createTool({
|
|
|
690
716
|
<dl>
|
|
691
717
|
<dd>
|
|
692
718
|
|
|
693
|
-
**
|
|
719
|
+
**id:** `string` — Identifier for a Tool. Formatted as a UUID.
|
|
720
|
+
|
|
721
|
+
</dd>
|
|
722
|
+
</dl>
|
|
723
|
+
|
|
724
|
+
<dl>
|
|
725
|
+
<dd>
|
|
726
|
+
|
|
727
|
+
**version:** `number`
|
|
728
|
+
|
|
729
|
+
Version number for a Tool.
|
|
730
|
+
|
|
731
|
+
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.
|
|
732
|
+
|
|
733
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
694
734
|
|
|
695
735
|
</dd>
|
|
696
736
|
</dl>
|
|
@@ -709,7 +749,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
709
749
|
</dl>
|
|
710
750
|
</details>
|
|
711
751
|
|
|
712
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
752
|
+
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code></summary>
|
|
713
753
|
<dl>
|
|
714
754
|
<dd>
|
|
715
755
|
|
|
@@ -721,7 +761,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
721
761
|
<dl>
|
|
722
762
|
<dd>
|
|
723
763
|
|
|
724
|
-
|
|
764
|
+
Deletes a specified version of a **Tool**.
|
|
725
765
|
|
|
726
766
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
727
767
|
|
|
@@ -739,7 +779,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
739
779
|
<dd>
|
|
740
780
|
|
|
741
781
|
```typescript
|
|
742
|
-
await client.empathicVoice.tools.
|
|
782
|
+
await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-609864268bea", 1);
|
|
743
783
|
```
|
|
744
784
|
|
|
745
785
|
</dd>
|
|
@@ -763,7 +803,13 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
763
803
|
<dl>
|
|
764
804
|
<dd>
|
|
765
805
|
|
|
766
|
-
**
|
|
806
|
+
**version:** `number`
|
|
807
|
+
|
|
808
|
+
Version number for a Tool.
|
|
809
|
+
|
|
810
|
+
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.
|
|
811
|
+
|
|
812
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
767
813
|
|
|
768
814
|
</dd>
|
|
769
815
|
</dl>
|
|
@@ -782,7 +828,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
782
828
|
</dl>
|
|
783
829
|
</details>
|
|
784
830
|
|
|
785
|
-
<details><summary><code>client.empathicVoice.tools.<a href="/src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
831
|
+
<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>
|
|
786
832
|
<dl>
|
|
787
833
|
<dd>
|
|
788
834
|
|
|
@@ -794,7 +840,7 @@ await client.empathicVoice.tools.listToolVersions("00183a3f-79ba-413d-9f3b-60986
|
|
|
794
840
|
<dl>
|
|
795
841
|
<dd>
|
|
796
842
|
|
|
797
|
-
Updates
|
|
843
|
+
Updates the description of a specified **Tool** version.
|
|
798
844
|
|
|
799
845
|
Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI.
|
|
800
846
|
|
|
@@ -812,12 +858,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
812
858
|
<dd>
|
|
813
859
|
|
|
814
860
|
```typescript
|
|
815
|
-
await client.empathicVoice.tools.
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
versionDescription: "Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.",
|
|
819
|
-
fallbackContent: "Unable to fetch current weather.",
|
|
820
|
-
description: "This tool is for getting the current weather.",
|
|
861
|
+
await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-609864268bea", 1, {
|
|
862
|
+
versionDescription:
|
|
863
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
821
864
|
});
|
|
822
865
|
```
|
|
823
866
|
|
|
@@ -842,7 +885,21 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
842
885
|
<dl>
|
|
843
886
|
<dd>
|
|
844
887
|
|
|
845
|
-
**
|
|
888
|
+
**version:** `number`
|
|
889
|
+
|
|
890
|
+
Version number for a Tool.
|
|
891
|
+
|
|
892
|
+
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.
|
|
893
|
+
|
|
894
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
895
|
+
|
|
896
|
+
</dd>
|
|
897
|
+
</dl>
|
|
898
|
+
|
|
899
|
+
<dl>
|
|
900
|
+
<dd>
|
|
901
|
+
|
|
902
|
+
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
846
903
|
|
|
847
904
|
</dd>
|
|
848
905
|
</dl>
|
|
@@ -861,7 +918,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
861
918
|
</dl>
|
|
862
919
|
</details>
|
|
863
920
|
|
|
864
|
-
|
|
921
|
+
## EmpathicVoice Prompts
|
|
922
|
+
|
|
923
|
+
<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></code></summary>
|
|
865
924
|
<dl>
|
|
866
925
|
<dd>
|
|
867
926
|
|
|
@@ -873,9 +932,9 @@ await client.empathicVoice.tools.createToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
873
932
|
<dl>
|
|
874
933
|
<dd>
|
|
875
934
|
|
|
876
|
-
|
|
935
|
+
Fetches a paginated list of **Prompts**.
|
|
877
936
|
|
|
878
|
-
|
|
937
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
879
938
|
|
|
880
939
|
</dd>
|
|
881
940
|
</dl>
|
|
@@ -891,7 +950,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
891
950
|
<dd>
|
|
892
951
|
|
|
893
952
|
```typescript
|
|
894
|
-
await client.empathicVoice.
|
|
953
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
954
|
+
pageNumber: 0,
|
|
955
|
+
pageSize: 2,
|
|
956
|
+
});
|
|
895
957
|
```
|
|
896
958
|
|
|
897
959
|
</dd>
|
|
@@ -907,7 +969,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
907
969
|
<dl>
|
|
908
970
|
<dd>
|
|
909
971
|
|
|
910
|
-
**
|
|
972
|
+
**request:** `Hume.empathicVoice.PromptsListPromptsRequest`
|
|
911
973
|
|
|
912
974
|
</dd>
|
|
913
975
|
</dl>
|
|
@@ -915,7 +977,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
915
977
|
<dl>
|
|
916
978
|
<dd>
|
|
917
979
|
|
|
918
|
-
**requestOptions:** `
|
|
980
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
919
981
|
|
|
920
982
|
</dd>
|
|
921
983
|
</dl>
|
|
@@ -926,7 +988,7 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
926
988
|
</dl>
|
|
927
989
|
</details>
|
|
928
990
|
|
|
929
|
-
<details><summary><code>client.empathicVoice.
|
|
991
|
+
<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>
|
|
930
992
|
<dl>
|
|
931
993
|
<dd>
|
|
932
994
|
|
|
@@ -938,9 +1000,9 @@ await client.empathicVoice.tools.deleteTool("00183a3f-79ba-413d-9f3b-609864268be
|
|
|
938
1000
|
<dl>
|
|
939
1001
|
<dd>
|
|
940
1002
|
|
|
941
|
-
|
|
1003
|
+
Creates a **Prompt** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
942
1004
|
|
|
943
|
-
|
|
1005
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
944
1006
|
|
|
945
1007
|
</dd>
|
|
946
1008
|
</dl>
|
|
@@ -956,8 +1018,9 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
956
1018
|
<dd>
|
|
957
1019
|
|
|
958
1020
|
```typescript
|
|
959
|
-
await client.empathicVoice.
|
|
960
|
-
name: "
|
|
1021
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1022
|
+
name: "Weather Assistant Prompt",
|
|
1023
|
+
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>",
|
|
961
1024
|
});
|
|
962
1025
|
```
|
|
963
1026
|
|
|
@@ -974,15 +1037,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
974
1037
|
<dl>
|
|
975
1038
|
<dd>
|
|
976
1039
|
|
|
977
|
-
**
|
|
978
|
-
|
|
979
|
-
</dd>
|
|
980
|
-
</dl>
|
|
981
|
-
|
|
982
|
-
<dl>
|
|
983
|
-
<dd>
|
|
984
|
-
|
|
985
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolName`
|
|
1040
|
+
**request:** `Hume.empathicVoice.PostedPrompt`
|
|
986
1041
|
|
|
987
1042
|
</dd>
|
|
988
1043
|
</dl>
|
|
@@ -990,7 +1045,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
990
1045
|
<dl>
|
|
991
1046
|
<dd>
|
|
992
1047
|
|
|
993
|
-
**requestOptions:** `
|
|
1048
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
994
1049
|
|
|
995
1050
|
</dd>
|
|
996
1051
|
</dl>
|
|
@@ -1001,7 +1056,7 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1001
1056
|
</dl>
|
|
1002
1057
|
</details>
|
|
1003
1058
|
|
|
1004
|
-
<details><summary><code>client.empathicVoice.
|
|
1059
|
+
<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>
|
|
1005
1060
|
<dl>
|
|
1006
1061
|
<dd>
|
|
1007
1062
|
|
|
@@ -1013,9 +1068,9 @@ await client.empathicVoice.tools.updateToolName("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1013
1068
|
<dl>
|
|
1014
1069
|
<dd>
|
|
1015
1070
|
|
|
1016
|
-
Fetches a
|
|
1071
|
+
Fetches a list of a **Prompt's** versions.
|
|
1017
1072
|
|
|
1018
|
-
|
|
1073
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1019
1074
|
|
|
1020
1075
|
</dd>
|
|
1021
1076
|
</dl>
|
|
@@ -1031,7 +1086,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
1031
1086
|
<dd>
|
|
1032
1087
|
|
|
1033
1088
|
```typescript
|
|
1034
|
-
await client.empathicVoice.
|
|
1089
|
+
await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1035
1090
|
```
|
|
1036
1091
|
|
|
1037
1092
|
</dd>
|
|
@@ -1047,7 +1102,7 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1047
1102
|
<dl>
|
|
1048
1103
|
<dd>
|
|
1049
1104
|
|
|
1050
|
-
**id:** `string` — Identifier for a
|
|
1105
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1051
1106
|
|
|
1052
1107
|
</dd>
|
|
1053
1108
|
</dl>
|
|
@@ -1055,21 +1110,15 @@ await client.empathicVoice.tools.getToolVersion("00183a3f-79ba-413d-9f3b-6098642
|
|
|
1055
1110
|
<dl>
|
|
1056
1111
|
<dd>
|
|
1057
1112
|
|
|
1058
|
-
**
|
|
1059
|
-
|
|
1060
|
-
Version number for a Tool.
|
|
1113
|
+
**request:** `Hume.empathicVoice.PromptsListPromptVersionsRequest`
|
|
1061
1114
|
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1065
|
-
|
|
1066
|
-
</dd>
|
|
1067
|
-
</dl>
|
|
1115
|
+
</dd>
|
|
1116
|
+
</dl>
|
|
1068
1117
|
|
|
1069
1118
|
<dl>
|
|
1070
1119
|
<dd>
|
|
1071
1120
|
|
|
1072
|
-
**requestOptions:** `
|
|
1121
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1073
1122
|
|
|
1074
1123
|
</dd>
|
|
1075
1124
|
</dl>
|
|
@@ -1080,7 +1129,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1080
1129
|
</dl>
|
|
1081
1130
|
</details>
|
|
1082
1131
|
|
|
1083
|
-
<details><summary><code>client.empathicVoice.
|
|
1132
|
+
<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>
|
|
1084
1133
|
<dl>
|
|
1085
1134
|
<dd>
|
|
1086
1135
|
|
|
@@ -1092,9 +1141,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1092
1141
|
<dl>
|
|
1093
1142
|
<dd>
|
|
1094
1143
|
|
|
1095
|
-
|
|
1144
|
+
Updates a **Prompt** by creating a new version of the **Prompt**.
|
|
1096
1145
|
|
|
1097
|
-
|
|
1146
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1098
1147
|
|
|
1099
1148
|
</dd>
|
|
1100
1149
|
</dl>
|
|
@@ -1110,7 +1159,10 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
1110
1159
|
<dd>
|
|
1111
1160
|
|
|
1112
1161
|
```typescript
|
|
1113
|
-
await client.empathicVoice.
|
|
1162
|
+
await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1163
|
+
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>",
|
|
1164
|
+
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1165
|
+
});
|
|
1114
1166
|
```
|
|
1115
1167
|
|
|
1116
1168
|
</dd>
|
|
@@ -1126,7 +1178,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
1126
1178
|
<dl>
|
|
1127
1179
|
<dd>
|
|
1128
1180
|
|
|
1129
|
-
**id:** `string` — Identifier for a
|
|
1181
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1130
1182
|
|
|
1131
1183
|
</dd>
|
|
1132
1184
|
</dl>
|
|
@@ -1134,13 +1186,7 @@ await client.empathicVoice.tools.deleteToolVersion("00183a3f-79ba-413d-9f3b-6098
|
|
|
1134
1186
|
<dl>
|
|
1135
1187
|
<dd>
|
|
1136
1188
|
|
|
1137
|
-
**
|
|
1138
|
-
|
|
1139
|
-
Version number for a Tool.
|
|
1140
|
-
|
|
1141
|
-
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.
|
|
1142
|
-
|
|
1143
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1189
|
+
**request:** `Hume.empathicVoice.PostedPromptVersion`
|
|
1144
1190
|
|
|
1145
1191
|
</dd>
|
|
1146
1192
|
</dl>
|
|
@@ -1148,7 +1194,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1148
1194
|
<dl>
|
|
1149
1195
|
<dd>
|
|
1150
1196
|
|
|
1151
|
-
**requestOptions:** `
|
|
1197
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1152
1198
|
|
|
1153
1199
|
</dd>
|
|
1154
1200
|
</dl>
|
|
@@ -1159,7 +1205,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1159
1205
|
</dl>
|
|
1160
1206
|
</details>
|
|
1161
1207
|
|
|
1162
|
-
<details><summary><code>client.empathicVoice.
|
|
1208
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code></summary>
|
|
1163
1209
|
<dl>
|
|
1164
1210
|
<dd>
|
|
1165
1211
|
|
|
@@ -1171,9 +1217,9 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1171
1217
|
<dl>
|
|
1172
1218
|
<dd>
|
|
1173
1219
|
|
|
1174
|
-
|
|
1220
|
+
Deletes a **Prompt** and its versions.
|
|
1175
1221
|
|
|
1176
|
-
|
|
1222
|
+
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1177
1223
|
|
|
1178
1224
|
</dd>
|
|
1179
1225
|
</dl>
|
|
@@ -1189,10 +1235,7 @@ Refer to our [tool use](/docs/empathic-voice-interface-evi/features/tool-use#fun
|
|
|
1189
1235
|
<dd>
|
|
1190
1236
|
|
|
1191
1237
|
```typescript
|
|
1192
|
-
await client.empathicVoice.
|
|
1193
|
-
versionDescription:
|
|
1194
|
-
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1195
|
-
});
|
|
1238
|
+
await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da3bac5");
|
|
1196
1239
|
```
|
|
1197
1240
|
|
|
1198
1241
|
</dd>
|
|
@@ -1208,29 +1251,7 @@ await client.empathicVoice.tools.updateToolDescription("00183a3f-79ba-413d-9f3b-
|
|
|
1208
1251
|
<dl>
|
|
1209
1252
|
<dd>
|
|
1210
1253
|
|
|
1211
|
-
**id:** `string` — Identifier for a
|
|
1212
|
-
|
|
1213
|
-
</dd>
|
|
1214
|
-
</dl>
|
|
1215
|
-
|
|
1216
|
-
<dl>
|
|
1217
|
-
<dd>
|
|
1218
|
-
|
|
1219
|
-
**version:** `number`
|
|
1220
|
-
|
|
1221
|
-
Version number for a Tool.
|
|
1222
|
-
|
|
1223
|
-
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.
|
|
1224
|
-
|
|
1225
|
-
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1226
|
-
|
|
1227
|
-
</dd>
|
|
1228
|
-
</dl>
|
|
1229
|
-
|
|
1230
|
-
<dl>
|
|
1231
|
-
<dd>
|
|
1232
|
-
|
|
1233
|
-
**request:** `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`
|
|
1254
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1234
1255
|
|
|
1235
1256
|
</dd>
|
|
1236
1257
|
</dl>
|
|
@@ -1238,7 +1259,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1238
1259
|
<dl>
|
|
1239
1260
|
<dd>
|
|
1240
1261
|
|
|
1241
|
-
**requestOptions:** `
|
|
1262
|
+
**requestOptions:** `Prompts.RequestOptions`
|
|
1242
1263
|
|
|
1243
1264
|
</dd>
|
|
1244
1265
|
</dl>
|
|
@@ -1249,9 +1270,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1249
1270
|
</dl>
|
|
1250
1271
|
</details>
|
|
1251
1272
|
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
<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></code></summary>
|
|
1273
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code></summary>
|
|
1255
1274
|
<dl>
|
|
1256
1275
|
<dd>
|
|
1257
1276
|
|
|
@@ -1263,7 +1282,7 @@ Version numbers are integer values representing different iterations of the Tool
|
|
|
1263
1282
|
<dl>
|
|
1264
1283
|
<dd>
|
|
1265
1284
|
|
|
1266
|
-
|
|
1285
|
+
Updates the name of a **Prompt**.
|
|
1267
1286
|
|
|
1268
1287
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1269
1288
|
|
|
@@ -1281,9 +1300,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1281
1300
|
<dd>
|
|
1282
1301
|
|
|
1283
1302
|
```typescript
|
|
1284
|
-
await client.empathicVoice.prompts.
|
|
1285
|
-
|
|
1286
|
-
pageSize: 2,
|
|
1303
|
+
await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9e5da3bac5", {
|
|
1304
|
+
name: "Updated Weather Assistant Prompt Name",
|
|
1287
1305
|
});
|
|
1288
1306
|
```
|
|
1289
1307
|
|
|
@@ -1300,7 +1318,15 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
1300
1318
|
<dl>
|
|
1301
1319
|
<dd>
|
|
1302
1320
|
|
|
1303
|
-
**
|
|
1321
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1322
|
+
|
|
1323
|
+
</dd>
|
|
1324
|
+
</dl>
|
|
1325
|
+
|
|
1326
|
+
<dl>
|
|
1327
|
+
<dd>
|
|
1328
|
+
|
|
1329
|
+
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1304
1330
|
|
|
1305
1331
|
</dd>
|
|
1306
1332
|
</dl>
|
|
@@ -1319,7 +1345,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
1319
1345
|
</dl>
|
|
1320
1346
|
</details>
|
|
1321
1347
|
|
|
1322
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1348
|
+
<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>
|
|
1323
1349
|
<dl>
|
|
1324
1350
|
<dd>
|
|
1325
1351
|
|
|
@@ -1331,7 +1357,7 @@ await client.empathicVoice.prompts.listPrompts({
|
|
|
1331
1357
|
<dl>
|
|
1332
1358
|
<dd>
|
|
1333
1359
|
|
|
1334
|
-
|
|
1360
|
+
Fetches a specified version of a **Prompt**.
|
|
1335
1361
|
|
|
1336
1362
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1337
1363
|
|
|
@@ -1349,10 +1375,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1349
1375
|
<dd>
|
|
1350
1376
|
|
|
1351
1377
|
```typescript
|
|
1352
|
-
await client.empathicVoice.prompts.
|
|
1353
|
-
name: "Weather Assistant Prompt",
|
|
1354
|
-
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>",
|
|
1355
|
-
});
|
|
1378
|
+
await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 0);
|
|
1356
1379
|
```
|
|
1357
1380
|
|
|
1358
1381
|
</dd>
|
|
@@ -1368,7 +1391,21 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1368
1391
|
<dl>
|
|
1369
1392
|
<dd>
|
|
1370
1393
|
|
|
1371
|
-
**
|
|
1394
|
+
**id:** `string` — Identifier for a Prompt. Formatted as a UUID.
|
|
1395
|
+
|
|
1396
|
+
</dd>
|
|
1397
|
+
</dl>
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
**version:** `number`
|
|
1403
|
+
|
|
1404
|
+
Version number for a Prompt.
|
|
1405
|
+
|
|
1406
|
+
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.
|
|
1407
|
+
|
|
1408
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1372
1409
|
|
|
1373
1410
|
</dd>
|
|
1374
1411
|
</dl>
|
|
@@ -1387,7 +1424,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1387
1424
|
</dl>
|
|
1388
1425
|
</details>
|
|
1389
1426
|
|
|
1390
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1427
|
+
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code></summary>
|
|
1391
1428
|
<dl>
|
|
1392
1429
|
<dd>
|
|
1393
1430
|
|
|
@@ -1399,7 +1436,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
1399
1436
|
<dl>
|
|
1400
1437
|
<dd>
|
|
1401
1438
|
|
|
1402
|
-
|
|
1439
|
+
Deletes a specified version of a **Prompt**.
|
|
1403
1440
|
|
|
1404
1441
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1405
1442
|
|
|
@@ -1417,7 +1454,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1417
1454
|
<dd>
|
|
1418
1455
|
|
|
1419
1456
|
```typescript
|
|
1420
|
-
await client.empathicVoice.prompts.
|
|
1457
|
+
await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-af9e5da3bac5", 1);
|
|
1421
1458
|
```
|
|
1422
1459
|
|
|
1423
1460
|
</dd>
|
|
@@ -1441,7 +1478,13 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1441
1478
|
<dl>
|
|
1442
1479
|
<dd>
|
|
1443
1480
|
|
|
1444
|
-
**
|
|
1481
|
+
**version:** `number`
|
|
1482
|
+
|
|
1483
|
+
Version number for a Prompt.
|
|
1484
|
+
|
|
1485
|
+
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.
|
|
1486
|
+
|
|
1487
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1445
1488
|
|
|
1446
1489
|
</dd>
|
|
1447
1490
|
</dl>
|
|
@@ -1460,7 +1503,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1460
1503
|
</dl>
|
|
1461
1504
|
</details>
|
|
1462
1505
|
|
|
1463
|
-
<details><summary><code>client.empathicVoice.prompts.<a href="/src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1506
|
+
<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>
|
|
1464
1507
|
<dl>
|
|
1465
1508
|
<dd>
|
|
1466
1509
|
|
|
@@ -1472,7 +1515,7 @@ await client.empathicVoice.prompts.listPromptVersions("af699d45-2985-42cc-91b9-a
|
|
|
1472
1515
|
<dl>
|
|
1473
1516
|
<dd>
|
|
1474
1517
|
|
|
1475
|
-
Updates
|
|
1518
|
+
Updates the description of a **Prompt**.
|
|
1476
1519
|
|
|
1477
1520
|
See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-calling) for tips on crafting your system prompt.
|
|
1478
1521
|
|
|
@@ -1490,9 +1533,8 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1490
1533
|
<dd>
|
|
1491
1534
|
|
|
1492
1535
|
```typescript
|
|
1493
|
-
await client.empathicVoice.prompts.
|
|
1494
|
-
|
|
1495
|
-
versionDescription: "This is an updated version of the Weather Assistant Prompt.",
|
|
1536
|
+
await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-91b9-af9e5da3bac5", 1, {
|
|
1537
|
+
versionDescription: "This is an updated version_description.",
|
|
1496
1538
|
});
|
|
1497
1539
|
```
|
|
1498
1540
|
|
|
@@ -1517,7 +1559,21 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1517
1559
|
<dl>
|
|
1518
1560
|
<dd>
|
|
1519
1561
|
|
|
1520
|
-
**
|
|
1562
|
+
**version:** `number`
|
|
1563
|
+
|
|
1564
|
+
Version number for a Prompt.
|
|
1565
|
+
|
|
1566
|
+
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.
|
|
1567
|
+
|
|
1568
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1569
|
+
|
|
1570
|
+
</dd>
|
|
1571
|
+
</dl>
|
|
1572
|
+
|
|
1573
|
+
<dl>
|
|
1574
|
+
<dd>
|
|
1575
|
+
|
|
1576
|
+
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1521
1577
|
|
|
1522
1578
|
</dd>
|
|
1523
1579
|
</dl>
|
|
@@ -1536,7 +1592,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1536
1592
|
</dl>
|
|
1537
1593
|
</details>
|
|
1538
1594
|
|
|
1539
|
-
|
|
1595
|
+
## EmpathicVoice CustomVoices
|
|
1596
|
+
|
|
1597
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1540
1598
|
<dl>
|
|
1541
1599
|
<dd>
|
|
1542
1600
|
|
|
@@ -1548,9 +1606,9 @@ await client.empathicVoice.prompts.createPromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1548
1606
|
<dl>
|
|
1549
1607
|
<dd>
|
|
1550
1608
|
|
|
1551
|
-
|
|
1609
|
+
Fetches a paginated list of **Custom Voices**.
|
|
1552
1610
|
|
|
1553
|
-
|
|
1611
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1554
1612
|
|
|
1555
1613
|
</dd>
|
|
1556
1614
|
</dl>
|
|
@@ -1566,7 +1624,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1566
1624
|
<dd>
|
|
1567
1625
|
|
|
1568
1626
|
```typescript
|
|
1569
|
-
await client.empathicVoice.
|
|
1627
|
+
await client.empathicVoice.customVoices.listCustomVoices();
|
|
1570
1628
|
```
|
|
1571
1629
|
|
|
1572
1630
|
</dd>
|
|
@@ -1582,7 +1640,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1582
1640
|
<dl>
|
|
1583
1641
|
<dd>
|
|
1584
1642
|
|
|
1585
|
-
**
|
|
1643
|
+
**request:** `Hume.empathicVoice.CustomVoicesListCustomVoicesRequest`
|
|
1586
1644
|
|
|
1587
1645
|
</dd>
|
|
1588
1646
|
</dl>
|
|
@@ -1590,7 +1648,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1590
1648
|
<dl>
|
|
1591
1649
|
<dd>
|
|
1592
1650
|
|
|
1593
|
-
**requestOptions:** `
|
|
1651
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1594
1652
|
|
|
1595
1653
|
</dd>
|
|
1596
1654
|
</dl>
|
|
@@ -1601,7 +1659,7 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1601
1659
|
</dl>
|
|
1602
1660
|
</details>
|
|
1603
1661
|
|
|
1604
|
-
<details><summary><code>client.empathicVoice.
|
|
1662
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoice</a>({ ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
1605
1663
|
<dl>
|
|
1606
1664
|
<dd>
|
|
1607
1665
|
|
|
@@ -1613,9 +1671,9 @@ await client.empathicVoice.prompts.deletePrompt("af699d45-2985-42cc-91b9-af9e5da
|
|
|
1613
1671
|
<dl>
|
|
1614
1672
|
<dd>
|
|
1615
1673
|
|
|
1616
|
-
|
|
1674
|
+
Creates a **Custom Voice** that can be added to an [EVI configuration](/reference/empathic-voice-interface-evi/configs/create-config).
|
|
1617
1675
|
|
|
1618
|
-
|
|
1676
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1619
1677
|
|
|
1620
1678
|
</dd>
|
|
1621
1679
|
</dl>
|
|
@@ -1631,8 +1689,10 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1631
1689
|
<dd>
|
|
1632
1690
|
|
|
1633
1691
|
```typescript
|
|
1634
|
-
await client.empathicVoice.
|
|
1635
|
-
name: "
|
|
1692
|
+
await client.empathicVoice.customVoices.createCustomVoice({
|
|
1693
|
+
name: "name",
|
|
1694
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1695
|
+
parameterModel: "20241004-11parameter",
|
|
1636
1696
|
});
|
|
1637
1697
|
```
|
|
1638
1698
|
|
|
@@ -1649,15 +1709,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1649
1709
|
<dl>
|
|
1650
1710
|
<dd>
|
|
1651
1711
|
|
|
1652
|
-
**
|
|
1653
|
-
|
|
1654
|
-
</dd>
|
|
1655
|
-
</dl>
|
|
1656
|
-
|
|
1657
|
-
<dl>
|
|
1658
|
-
<dd>
|
|
1659
|
-
|
|
1660
|
-
**request:** `Hume.empathicVoice.PostedPromptName`
|
|
1712
|
+
**request:** `Hume.PostedCustomVoice`
|
|
1661
1713
|
|
|
1662
1714
|
</dd>
|
|
1663
1715
|
</dl>
|
|
@@ -1665,7 +1717,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1665
1717
|
<dl>
|
|
1666
1718
|
<dd>
|
|
1667
1719
|
|
|
1668
|
-
**requestOptions:** `
|
|
1720
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1669
1721
|
|
|
1670
1722
|
</dd>
|
|
1671
1723
|
</dl>
|
|
@@ -1676,7 +1728,7 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1676
1728
|
</dl>
|
|
1677
1729
|
</details>
|
|
1678
1730
|
|
|
1679
|
-
<details><summary><code>client.empathicVoice.
|
|
1731
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">getCustomVoice</a>(id) -> Hume.ReturnCustomVoice</code></summary>
|
|
1680
1732
|
<dl>
|
|
1681
1733
|
<dd>
|
|
1682
1734
|
|
|
@@ -1688,9 +1740,9 @@ await client.empathicVoice.prompts.updatePromptName("af699d45-2985-42cc-91b9-af9
|
|
|
1688
1740
|
<dl>
|
|
1689
1741
|
<dd>
|
|
1690
1742
|
|
|
1691
|
-
Fetches a
|
|
1743
|
+
Fetches a specific **Custom Voice** by ID.
|
|
1692
1744
|
|
|
1693
|
-
|
|
1745
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1694
1746
|
|
|
1695
1747
|
</dd>
|
|
1696
1748
|
</dl>
|
|
@@ -1706,7 +1758,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1706
1758
|
<dd>
|
|
1707
1759
|
|
|
1708
1760
|
```typescript
|
|
1709
|
-
await client.empathicVoice.
|
|
1761
|
+
await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
1710
1762
|
```
|
|
1711
1763
|
|
|
1712
1764
|
</dd>
|
|
@@ -1722,21 +1774,7 @@ await client.empathicVoice.prompts.getPromptVersion("af699d45-2985-42cc-91b9-af9
|
|
|
1722
1774
|
<dl>
|
|
1723
1775
|
<dd>
|
|
1724
1776
|
|
|
1725
|
-
**id:** `string` — Identifier for a
|
|
1726
|
-
|
|
1727
|
-
</dd>
|
|
1728
|
-
</dl>
|
|
1729
|
-
|
|
1730
|
-
<dl>
|
|
1731
|
-
<dd>
|
|
1732
|
-
|
|
1733
|
-
**version:** `number`
|
|
1734
|
-
|
|
1735
|
-
Version number for a Prompt.
|
|
1736
|
-
|
|
1737
|
-
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.
|
|
1738
|
-
|
|
1739
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1777
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1740
1778
|
|
|
1741
1779
|
</dd>
|
|
1742
1780
|
</dl>
|
|
@@ -1744,7 +1782,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1744
1782
|
<dl>
|
|
1745
1783
|
<dd>
|
|
1746
1784
|
|
|
1747
|
-
**requestOptions:** `
|
|
1785
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1748
1786
|
|
|
1749
1787
|
</dd>
|
|
1750
1788
|
</dl>
|
|
@@ -1755,7 +1793,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1755
1793
|
</dl>
|
|
1756
1794
|
</details>
|
|
1757
1795
|
|
|
1758
|
-
<details><summary><code>client.empathicVoice.
|
|
1796
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">createCustomVoiceVersion</a>(id, { ...params }) -> Hume.ReturnCustomVoice</code></summary>
|
|
1759
1797
|
<dl>
|
|
1760
1798
|
<dd>
|
|
1761
1799
|
|
|
@@ -1767,9 +1805,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1767
1805
|
<dl>
|
|
1768
1806
|
<dd>
|
|
1769
1807
|
|
|
1770
|
-
|
|
1808
|
+
Updates a **Custom Voice** by creating a new version of the **Custom Voice**.
|
|
1771
1809
|
|
|
1772
|
-
|
|
1810
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1773
1811
|
|
|
1774
1812
|
</dd>
|
|
1775
1813
|
</dl>
|
|
@@ -1785,7 +1823,11 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1785
1823
|
<dd>
|
|
1786
1824
|
|
|
1787
1825
|
```typescript
|
|
1788
|
-
await client.empathicVoice.
|
|
1826
|
+
await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
1827
|
+
name: "name",
|
|
1828
|
+
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
1829
|
+
parameterModel: "20241004-11parameter",
|
|
1830
|
+
});
|
|
1789
1831
|
```
|
|
1790
1832
|
|
|
1791
1833
|
</dd>
|
|
@@ -1801,7 +1843,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1801
1843
|
<dl>
|
|
1802
1844
|
<dd>
|
|
1803
1845
|
|
|
1804
|
-
**id:** `string` — Identifier for a
|
|
1846
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1805
1847
|
|
|
1806
1848
|
</dd>
|
|
1807
1849
|
</dl>
|
|
@@ -1809,13 +1851,7 @@ await client.empathicVoice.prompts.deletePromptVersion("af699d45-2985-42cc-91b9-
|
|
|
1809
1851
|
<dl>
|
|
1810
1852
|
<dd>
|
|
1811
1853
|
|
|
1812
|
-
**
|
|
1813
|
-
|
|
1814
|
-
Version number for a Prompt.
|
|
1815
|
-
|
|
1816
|
-
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.
|
|
1817
|
-
|
|
1818
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1854
|
+
**request:** `Hume.PostedCustomVoice`
|
|
1819
1855
|
|
|
1820
1856
|
</dd>
|
|
1821
1857
|
</dl>
|
|
@@ -1823,7 +1859,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1823
1859
|
<dl>
|
|
1824
1860
|
<dd>
|
|
1825
1861
|
|
|
1826
|
-
**requestOptions:** `
|
|
1862
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1827
1863
|
|
|
1828
1864
|
</dd>
|
|
1829
1865
|
</dl>
|
|
@@ -1834,7 +1870,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1834
1870
|
</dl>
|
|
1835
1871
|
</details>
|
|
1836
1872
|
|
|
1837
|
-
<details><summary><code>client.empathicVoice.
|
|
1873
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">deleteCustomVoice</a>(id) -> void</code></summary>
|
|
1838
1874
|
<dl>
|
|
1839
1875
|
<dd>
|
|
1840
1876
|
|
|
@@ -1846,9 +1882,9 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1846
1882
|
<dl>
|
|
1847
1883
|
<dd>
|
|
1848
1884
|
|
|
1849
|
-
|
|
1885
|
+
Deletes a **Custom Voice** and its versions.
|
|
1850
1886
|
|
|
1851
|
-
|
|
1887
|
+
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1852
1888
|
|
|
1853
1889
|
</dd>
|
|
1854
1890
|
</dl>
|
|
@@ -1864,9 +1900,7 @@ See our [prompting guide](/docs/empathic-voice-interface-evi/guides/phone-callin
|
|
|
1864
1900
|
<dd>
|
|
1865
1901
|
|
|
1866
1902
|
```typescript
|
|
1867
|
-
await client.empathicVoice.
|
|
1868
|
-
versionDescription: "This is an updated version_description.",
|
|
1869
|
-
});
|
|
1903
|
+
await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
1870
1904
|
```
|
|
1871
1905
|
|
|
1872
1906
|
</dd>
|
|
@@ -1882,7 +1916,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1882
1916
|
<dl>
|
|
1883
1917
|
<dd>
|
|
1884
1918
|
|
|
1885
|
-
**id:** `string` — Identifier for a
|
|
1919
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1886
1920
|
|
|
1887
1921
|
</dd>
|
|
1888
1922
|
</dl>
|
|
@@ -1890,29 +1924,7 @@ await client.empathicVoice.prompts.updatePromptDescription("af699d45-2985-42cc-9
|
|
|
1890
1924
|
<dl>
|
|
1891
1925
|
<dd>
|
|
1892
1926
|
|
|
1893
|
-
**
|
|
1894
|
-
|
|
1895
|
-
Version number for a Prompt.
|
|
1896
|
-
|
|
1897
|
-
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.
|
|
1898
|
-
|
|
1899
|
-
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1900
|
-
|
|
1901
|
-
</dd>
|
|
1902
|
-
</dl>
|
|
1903
|
-
|
|
1904
|
-
<dl>
|
|
1905
|
-
<dd>
|
|
1906
|
-
|
|
1907
|
-
**request:** `Hume.empathicVoice.PostedPromptVersionDescription`
|
|
1908
|
-
|
|
1909
|
-
</dd>
|
|
1910
|
-
</dl>
|
|
1911
|
-
|
|
1912
|
-
<dl>
|
|
1913
|
-
<dd>
|
|
1914
|
-
|
|
1915
|
-
**requestOptions:** `Prompts.RequestOptions`
|
|
1927
|
+
**requestOptions:** `CustomVoices.RequestOptions`
|
|
1916
1928
|
|
|
1917
1929
|
</dd>
|
|
1918
1930
|
</dl>
|
|
@@ -1923,9 +1935,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1923
1935
|
</dl>
|
|
1924
1936
|
</details>
|
|
1925
1937
|
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">listCustomVoices</a>({ ...params }) -> Hume.ReturnPagedCustomVoices</code></summary>
|
|
1938
|
+
<details><summary><code>client.empathicVoice.customVoices.<a href="/src/api/resources/empathicVoice/resources/customVoices/client/Client.ts">updateCustomVoiceName</a>(id, { ...params }) -> string</code></summary>
|
|
1929
1939
|
<dl>
|
|
1930
1940
|
<dd>
|
|
1931
1941
|
|
|
@@ -1937,7 +1947,7 @@ Version numbers are integer values representing different iterations of the Prom
|
|
|
1937
1947
|
<dl>
|
|
1938
1948
|
<dd>
|
|
1939
1949
|
|
|
1940
|
-
|
|
1950
|
+
Updates the name of a **Custom Voice**.
|
|
1941
1951
|
|
|
1942
1952
|
Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voices) for details on creating a custom voice.
|
|
1943
1953
|
|
|
@@ -1955,7 +1965,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
1955
1965
|
<dd>
|
|
1956
1966
|
|
|
1957
1967
|
```typescript
|
|
1958
|
-
await client.empathicVoice.customVoices.
|
|
1968
|
+
await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
1969
|
+
name: "name",
|
|
1970
|
+
});
|
|
1959
1971
|
```
|
|
1960
1972
|
|
|
1961
1973
|
</dd>
|
|
@@ -1971,7 +1983,15 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1971
1983
|
<dl>
|
|
1972
1984
|
<dd>
|
|
1973
1985
|
|
|
1974
|
-
**
|
|
1986
|
+
**id:** `string` — Identifier for a Custom Voice. Formatted as a UUID.
|
|
1987
|
+
|
|
1988
|
+
</dd>
|
|
1989
|
+
</dl>
|
|
1990
|
+
|
|
1991
|
+
<dl>
|
|
1992
|
+
<dd>
|
|
1993
|
+
|
|
1994
|
+
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
1975
1995
|
|
|
1976
1996
|
</dd>
|
|
1977
1997
|
</dl>
|
|
@@ -1990,7 +2010,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
1990
2010
|
</dl>
|
|
1991
2011
|
</details>
|
|
1992
2012
|
|
|
1993
|
-
|
|
2013
|
+
## EmpathicVoice Configs
|
|
2014
|
+
|
|
2015
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
1994
2016
|
<dl>
|
|
1995
2017
|
<dd>
|
|
1996
2018
|
|
|
@@ -2002,9 +2024,9 @@ await client.empathicVoice.customVoices.listCustomVoices();
|
|
|
2002
2024
|
<dl>
|
|
2003
2025
|
<dd>
|
|
2004
2026
|
|
|
2005
|
-
|
|
2027
|
+
Fetches a paginated list of **Configs**.
|
|
2006
2028
|
|
|
2007
|
-
|
|
2029
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2008
2030
|
|
|
2009
2031
|
</dd>
|
|
2010
2032
|
</dl>
|
|
@@ -2020,10 +2042,9 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
2020
2042
|
<dd>
|
|
2021
2043
|
|
|
2022
2044
|
```typescript
|
|
2023
|
-
await client.empathicVoice.
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
parameterModel: "20241004-11parameter",
|
|
2045
|
+
await client.empathicVoice.configs.listConfigs({
|
|
2046
|
+
pageNumber: 0,
|
|
2047
|
+
pageSize: 1,
|
|
2027
2048
|
});
|
|
2028
2049
|
```
|
|
2029
2050
|
|
|
@@ -2040,7 +2061,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
2040
2061
|
<dl>
|
|
2041
2062
|
<dd>
|
|
2042
2063
|
|
|
2043
|
-
**request:** `Hume.
|
|
2064
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigsRequest`
|
|
2044
2065
|
|
|
2045
2066
|
</dd>
|
|
2046
2067
|
</dl>
|
|
@@ -2048,7 +2069,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
2048
2069
|
<dl>
|
|
2049
2070
|
<dd>
|
|
2050
2071
|
|
|
2051
|
-
**requestOptions:** `
|
|
2072
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2052
2073
|
|
|
2053
2074
|
</dd>
|
|
2054
2075
|
</dl>
|
|
@@ -2059,7 +2080,7 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
2059
2080
|
</dl>
|
|
2060
2081
|
</details>
|
|
2061
2082
|
|
|
2062
|
-
<details><summary><code>client.empathicVoice.
|
|
2083
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2063
2084
|
<dl>
|
|
2064
2085
|
<dd>
|
|
2065
2086
|
|
|
@@ -2071,9 +2092,9 @@ await client.empathicVoice.customVoices.createCustomVoice({
|
|
|
2071
2092
|
<dl>
|
|
2072
2093
|
<dd>
|
|
2073
2094
|
|
|
2074
|
-
|
|
2095
|
+
Creates a **Config** which can be applied to EVI.
|
|
2075
2096
|
|
|
2076
|
-
|
|
2097
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2077
2098
|
|
|
2078
2099
|
</dd>
|
|
2079
2100
|
</dl>
|
|
@@ -2089,7 +2110,37 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
2089
2110
|
<dd>
|
|
2090
2111
|
|
|
2091
2112
|
```typescript
|
|
2092
|
-
await client.empathicVoice.
|
|
2113
|
+
await client.empathicVoice.configs.createConfig({
|
|
2114
|
+
name: "Weather Assistant Config",
|
|
2115
|
+
prompt: {
|
|
2116
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2117
|
+
version: 0,
|
|
2118
|
+
},
|
|
2119
|
+
eviVersion: "2",
|
|
2120
|
+
voice: {
|
|
2121
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2122
|
+
name: "SAMPLE VOICE",
|
|
2123
|
+
},
|
|
2124
|
+
languageModel: {
|
|
2125
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2126
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2127
|
+
temperature: 1,
|
|
2128
|
+
},
|
|
2129
|
+
eventMessages: {
|
|
2130
|
+
onNewChat: {
|
|
2131
|
+
enabled: false,
|
|
2132
|
+
text: "",
|
|
2133
|
+
},
|
|
2134
|
+
onInactivityTimeout: {
|
|
2135
|
+
enabled: false,
|
|
2136
|
+
text: "",
|
|
2137
|
+
},
|
|
2138
|
+
onMaxDurationTimeout: {
|
|
2139
|
+
enabled: false,
|
|
2140
|
+
text: "",
|
|
2141
|
+
},
|
|
2142
|
+
},
|
|
2143
|
+
});
|
|
2093
2144
|
```
|
|
2094
2145
|
|
|
2095
2146
|
</dd>
|
|
@@ -2105,7 +2156,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
2105
2156
|
<dl>
|
|
2106
2157
|
<dd>
|
|
2107
2158
|
|
|
2108
|
-
**
|
|
2159
|
+
**request:** `Hume.empathicVoice.PostedConfig`
|
|
2109
2160
|
|
|
2110
2161
|
</dd>
|
|
2111
2162
|
</dl>
|
|
@@ -2113,7 +2164,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
2113
2164
|
<dl>
|
|
2114
2165
|
<dd>
|
|
2115
2166
|
|
|
2116
|
-
**requestOptions:** `
|
|
2167
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2117
2168
|
|
|
2118
2169
|
</dd>
|
|
2119
2170
|
</dl>
|
|
@@ -2124,7 +2175,7 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
2124
2175
|
</dl>
|
|
2125
2176
|
</details>
|
|
2126
2177
|
|
|
2127
|
-
<details><summary><code>client.empathicVoice.
|
|
2178
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigVersions</a>(id, { ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2128
2179
|
<dl>
|
|
2129
2180
|
<dd>
|
|
2130
2181
|
|
|
@@ -2136,9 +2187,9 @@ await client.empathicVoice.customVoices.getCustomVoice("id");
|
|
|
2136
2187
|
<dl>
|
|
2137
2188
|
<dd>
|
|
2138
2189
|
|
|
2139
|
-
|
|
2190
|
+
Fetches a list of a **Config's** versions.
|
|
2140
2191
|
|
|
2141
|
-
|
|
2192
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2142
2193
|
|
|
2143
2194
|
</dd>
|
|
2144
2195
|
</dl>
|
|
@@ -2154,11 +2205,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
2154
2205
|
<dd>
|
|
2155
2206
|
|
|
2156
2207
|
```typescript
|
|
2157
|
-
await client.empathicVoice.
|
|
2158
|
-
name: "name",
|
|
2159
|
-
baseVoice: Hume.PostedCustomVoiceBaseVoice.Ito,
|
|
2160
|
-
parameterModel: "20241004-11parameter",
|
|
2161
|
-
});
|
|
2208
|
+
await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2162
2209
|
```
|
|
2163
2210
|
|
|
2164
2211
|
</dd>
|
|
@@ -2174,7 +2221,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
2174
2221
|
<dl>
|
|
2175
2222
|
<dd>
|
|
2176
2223
|
|
|
2177
|
-
**id:** `string` — Identifier for a
|
|
2224
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2178
2225
|
|
|
2179
2226
|
</dd>
|
|
2180
2227
|
</dl>
|
|
@@ -2182,7 +2229,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
2182
2229
|
<dl>
|
|
2183
2230
|
<dd>
|
|
2184
2231
|
|
|
2185
|
-
**request:** `Hume.
|
|
2232
|
+
**request:** `Hume.empathicVoice.ConfigsListConfigVersionsRequest`
|
|
2186
2233
|
|
|
2187
2234
|
</dd>
|
|
2188
2235
|
</dl>
|
|
@@ -2190,7 +2237,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
2190
2237
|
<dl>
|
|
2191
2238
|
<dd>
|
|
2192
2239
|
|
|
2193
|
-
**requestOptions:** `
|
|
2240
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2194
2241
|
|
|
2195
2242
|
</dd>
|
|
2196
2243
|
</dl>
|
|
@@ -2201,7 +2248,7 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
2201
2248
|
</dl>
|
|
2202
2249
|
</details>
|
|
2203
2250
|
|
|
2204
|
-
<details><summary><code>client.empathicVoice.
|
|
2251
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfigVersion</a>(id, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2205
2252
|
<dl>
|
|
2206
2253
|
<dd>
|
|
2207
2254
|
|
|
@@ -2213,9 +2260,9 @@ await client.empathicVoice.customVoices.createCustomVoiceVersion("id", {
|
|
|
2213
2260
|
<dl>
|
|
2214
2261
|
<dd>
|
|
2215
2262
|
|
|
2216
|
-
|
|
2263
|
+
Updates a **Config** by creating a new version of the **Config**.
|
|
2217
2264
|
|
|
2218
|
-
|
|
2265
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2219
2266
|
|
|
2220
2267
|
</dd>
|
|
2221
2268
|
</dl>
|
|
@@ -2231,7 +2278,40 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
2231
2278
|
<dd>
|
|
2232
2279
|
|
|
2233
2280
|
```typescript
|
|
2234
|
-
await client.empathicVoice.
|
|
2281
|
+
await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2282
|
+
versionDescription: "This is an updated version of the Weather Assistant Config.",
|
|
2283
|
+
eviVersion: "2",
|
|
2284
|
+
prompt: {
|
|
2285
|
+
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2286
|
+
version: 0,
|
|
2287
|
+
},
|
|
2288
|
+
voice: {
|
|
2289
|
+
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2290
|
+
name: "ITO",
|
|
2291
|
+
},
|
|
2292
|
+
languageModel: {
|
|
2293
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2294
|
+
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2295
|
+
temperature: 1,
|
|
2296
|
+
},
|
|
2297
|
+
ellmModel: {
|
|
2298
|
+
allowShortResponses: true,
|
|
2299
|
+
},
|
|
2300
|
+
eventMessages: {
|
|
2301
|
+
onNewChat: {
|
|
2302
|
+
enabled: false,
|
|
2303
|
+
text: "",
|
|
2304
|
+
},
|
|
2305
|
+
onInactivityTimeout: {
|
|
2306
|
+
enabled: false,
|
|
2307
|
+
text: "",
|
|
2308
|
+
},
|
|
2309
|
+
onMaxDurationTimeout: {
|
|
2310
|
+
enabled: false,
|
|
2311
|
+
text: "",
|
|
2312
|
+
},
|
|
2313
|
+
},
|
|
2314
|
+
});
|
|
2235
2315
|
```
|
|
2236
2316
|
|
|
2237
2317
|
</dd>
|
|
@@ -2247,7 +2327,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
2247
2327
|
<dl>
|
|
2248
2328
|
<dd>
|
|
2249
2329
|
|
|
2250
|
-
**id:** `string` — Identifier for a
|
|
2330
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2251
2331
|
|
|
2252
2332
|
</dd>
|
|
2253
2333
|
</dl>
|
|
@@ -2255,7 +2335,15 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
2255
2335
|
<dl>
|
|
2256
2336
|
<dd>
|
|
2257
2337
|
|
|
2258
|
-
**
|
|
2338
|
+
**request:** `Hume.empathicVoice.PostedConfigVersion`
|
|
2339
|
+
|
|
2340
|
+
</dd>
|
|
2341
|
+
</dl>
|
|
2342
|
+
|
|
2343
|
+
<dl>
|
|
2344
|
+
<dd>
|
|
2345
|
+
|
|
2346
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2259
2347
|
|
|
2260
2348
|
</dd>
|
|
2261
2349
|
</dl>
|
|
@@ -2266,7 +2354,7 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
2266
2354
|
</dl>
|
|
2267
2355
|
</details>
|
|
2268
2356
|
|
|
2269
|
-
<details><summary><code>client.empathicVoice.
|
|
2357
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code></summary>
|
|
2270
2358
|
<dl>
|
|
2271
2359
|
<dd>
|
|
2272
2360
|
|
|
@@ -2278,9 +2366,9 @@ await client.empathicVoice.customVoices.deleteCustomVoice("id");
|
|
|
2278
2366
|
<dl>
|
|
2279
2367
|
<dd>
|
|
2280
2368
|
|
|
2281
|
-
|
|
2369
|
+
Deletes a **Config** and its versions.
|
|
2282
2370
|
|
|
2283
|
-
|
|
2371
|
+
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2284
2372
|
|
|
2285
2373
|
</dd>
|
|
2286
2374
|
</dl>
|
|
@@ -2296,9 +2384,7 @@ Refer to our [voices guide](/docs/empathic-voice-interface-evi/configuration/voi
|
|
|
2296
2384
|
<dd>
|
|
2297
2385
|
|
|
2298
2386
|
```typescript
|
|
2299
|
-
await client.empathicVoice.
|
|
2300
|
-
name: "name",
|
|
2301
|
-
});
|
|
2387
|
+
await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354db3f3");
|
|
2302
2388
|
```
|
|
2303
2389
|
|
|
2304
2390
|
</dd>
|
|
@@ -2314,15 +2400,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2314
2400
|
<dl>
|
|
2315
2401
|
<dd>
|
|
2316
2402
|
|
|
2317
|
-
**id:** `string` — Identifier for a
|
|
2318
|
-
|
|
2319
|
-
</dd>
|
|
2320
|
-
</dl>
|
|
2321
|
-
|
|
2322
|
-
<dl>
|
|
2323
|
-
<dd>
|
|
2324
|
-
|
|
2325
|
-
**request:** `Hume.empathicVoice.PostedCustomVoiceName`
|
|
2403
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2326
2404
|
|
|
2327
2405
|
</dd>
|
|
2328
2406
|
</dl>
|
|
@@ -2330,7 +2408,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2330
2408
|
<dl>
|
|
2331
2409
|
<dd>
|
|
2332
2410
|
|
|
2333
|
-
**requestOptions:** `
|
|
2411
|
+
**requestOptions:** `Configs.RequestOptions`
|
|
2334
2412
|
|
|
2335
2413
|
</dd>
|
|
2336
2414
|
</dl>
|
|
@@ -2341,9 +2419,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2341
2419
|
</dl>
|
|
2342
2420
|
</details>
|
|
2343
2421
|
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code></summary>
|
|
2422
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code></summary>
|
|
2347
2423
|
<dl>
|
|
2348
2424
|
<dd>
|
|
2349
2425
|
|
|
@@ -2355,7 +2431,7 @@ await client.empathicVoice.customVoices.updateCustomVoiceName("id", {
|
|
|
2355
2431
|
<dl>
|
|
2356
2432
|
<dd>
|
|
2357
2433
|
|
|
2358
|
-
|
|
2434
|
+
Updates the name of a **Config**.
|
|
2359
2435
|
|
|
2360
2436
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2361
2437
|
|
|
@@ -2373,9 +2449,8 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2373
2449
|
<dd>
|
|
2374
2450
|
|
|
2375
2451
|
```typescript
|
|
2376
|
-
await client.empathicVoice.configs.
|
|
2377
|
-
|
|
2378
|
-
pageSize: 1,
|
|
2452
|
+
await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189d354db3f3", {
|
|
2453
|
+
name: "Updated Weather Assistant Config Name",
|
|
2379
2454
|
});
|
|
2380
2455
|
```
|
|
2381
2456
|
|
|
@@ -2392,7 +2467,15 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2392
2467
|
<dl>
|
|
2393
2468
|
<dd>
|
|
2394
2469
|
|
|
2395
|
-
**
|
|
2470
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2471
|
+
|
|
2472
|
+
</dd>
|
|
2473
|
+
</dl>
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
**request:** `Hume.empathicVoice.PostedConfigName`
|
|
2396
2479
|
|
|
2397
2480
|
</dd>
|
|
2398
2481
|
</dl>
|
|
@@ -2411,7 +2494,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2411
2494
|
</dl>
|
|
2412
2495
|
</details>
|
|
2413
2496
|
|
|
2414
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2497
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">getConfigVersion</a>(id, version) -> Hume.ReturnConfig</code></summary>
|
|
2415
2498
|
<dl>
|
|
2416
2499
|
<dd>
|
|
2417
2500
|
|
|
@@ -2423,7 +2506,7 @@ await client.empathicVoice.configs.listConfigs({
|
|
|
2423
2506
|
<dl>
|
|
2424
2507
|
<dd>
|
|
2425
2508
|
|
|
2426
|
-
|
|
2509
|
+
Fetches a specified version of a **Config**.
|
|
2427
2510
|
|
|
2428
2511
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2429
2512
|
|
|
@@ -2441,37 +2524,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2441
2524
|
<dd>
|
|
2442
2525
|
|
|
2443
2526
|
```typescript
|
|
2444
|
-
await client.empathicVoice.configs.
|
|
2445
|
-
name: "Weather Assistant Config",
|
|
2446
|
-
prompt: {
|
|
2447
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2448
|
-
version: 0,
|
|
2449
|
-
},
|
|
2450
|
-
eviVersion: "2",
|
|
2451
|
-
voice: {
|
|
2452
|
-
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2453
|
-
name: "SAMPLE VOICE",
|
|
2454
|
-
},
|
|
2455
|
-
languageModel: {
|
|
2456
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2457
|
-
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2458
|
-
temperature: 1,
|
|
2459
|
-
},
|
|
2460
|
-
eventMessages: {
|
|
2461
|
-
onNewChat: {
|
|
2462
|
-
enabled: false,
|
|
2463
|
-
text: "",
|
|
2464
|
-
},
|
|
2465
|
-
onInactivityTimeout: {
|
|
2466
|
-
enabled: false,
|
|
2467
|
-
text: "",
|
|
2468
|
-
},
|
|
2469
|
-
onMaxDurationTimeout: {
|
|
2470
|
-
enabled: false,
|
|
2471
|
-
text: "",
|
|
2472
|
-
},
|
|
2473
|
-
},
|
|
2474
|
-
});
|
|
2527
|
+
await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2475
2528
|
```
|
|
2476
2529
|
|
|
2477
2530
|
</dd>
|
|
@@ -2487,7 +2540,21 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2487
2540
|
<dl>
|
|
2488
2541
|
<dd>
|
|
2489
2542
|
|
|
2490
|
-
**
|
|
2543
|
+
**id:** `string` — Identifier for a Config. Formatted as a UUID.
|
|
2544
|
+
|
|
2545
|
+
</dd>
|
|
2546
|
+
</dl>
|
|
2547
|
+
|
|
2548
|
+
<dl>
|
|
2549
|
+
<dd>
|
|
2550
|
+
|
|
2551
|
+
**version:** `number`
|
|
2552
|
+
|
|
2553
|
+
Version number for a Config.
|
|
2554
|
+
|
|
2555
|
+
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.
|
|
2556
|
+
|
|
2557
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2491
2558
|
|
|
2492
2559
|
</dd>
|
|
2493
2560
|
</dl>
|
|
@@ -2506,7 +2573,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2506
2573
|
</dl>
|
|
2507
2574
|
</details>
|
|
2508
2575
|
|
|
2509
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2576
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code></summary>
|
|
2510
2577
|
<dl>
|
|
2511
2578
|
<dd>
|
|
2512
2579
|
|
|
@@ -2518,7 +2585,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
2518
2585
|
<dl>
|
|
2519
2586
|
<dd>
|
|
2520
2587
|
|
|
2521
|
-
|
|
2588
|
+
Deletes a specified version of a **Config**.
|
|
2522
2589
|
|
|
2523
2590
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2524
2591
|
|
|
@@ -2536,7 +2603,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2536
2603
|
<dd>
|
|
2537
2604
|
|
|
2538
2605
|
```typescript
|
|
2539
|
-
await client.empathicVoice.configs.
|
|
2606
|
+
await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1);
|
|
2540
2607
|
```
|
|
2541
2608
|
|
|
2542
2609
|
</dd>
|
|
@@ -2560,7 +2627,13 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2560
2627
|
<dl>
|
|
2561
2628
|
<dd>
|
|
2562
2629
|
|
|
2563
|
-
**
|
|
2630
|
+
**version:** `number`
|
|
2631
|
+
|
|
2632
|
+
Version number for a Config.
|
|
2633
|
+
|
|
2634
|
+
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.
|
|
2635
|
+
|
|
2636
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2564
2637
|
|
|
2565
2638
|
</dd>
|
|
2566
2639
|
</dl>
|
|
@@ -2579,7 +2652,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2579
2652
|
</dl>
|
|
2580
2653
|
</details>
|
|
2581
2654
|
|
|
2582
|
-
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
2655
|
+
<details><summary><code>client.empathicVoice.configs.<a href="/src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigDescription</a>(id, version, { ...params }) -> Hume.ReturnConfig</code></summary>
|
|
2583
2656
|
<dl>
|
|
2584
2657
|
<dd>
|
|
2585
2658
|
|
|
@@ -2591,7 +2664,7 @@ await client.empathicVoice.configs.listConfigVersions("1b60e1a0-cc59-424a-8d2c-1
|
|
|
2591
2664
|
<dl>
|
|
2592
2665
|
<dd>
|
|
2593
2666
|
|
|
2594
|
-
Updates
|
|
2667
|
+
Updates the description of a **Config**.
|
|
2595
2668
|
|
|
2596
2669
|
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2597
2670
|
|
|
@@ -2609,39 +2682,8 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2609
2682
|
<dd>
|
|
2610
2683
|
|
|
2611
2684
|
```typescript
|
|
2612
|
-
await client.empathicVoice.configs.
|
|
2613
|
-
versionDescription: "This is an updated
|
|
2614
|
-
eviVersion: "2",
|
|
2615
|
-
prompt: {
|
|
2616
|
-
id: "af699d45-2985-42cc-91b9-af9e5da3bac5",
|
|
2617
|
-
version: 0,
|
|
2618
|
-
},
|
|
2619
|
-
voice: {
|
|
2620
|
-
provider: Hume.PostedVoiceProvider.HumeAi,
|
|
2621
|
-
name: "ITO",
|
|
2622
|
-
},
|
|
2623
|
-
languageModel: {
|
|
2624
|
-
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2625
|
-
modelResource: Hume.PostedLanguageModelModelResource.Claude35Sonnet20240620,
|
|
2626
|
-
temperature: 1,
|
|
2627
|
-
},
|
|
2628
|
-
ellmModel: {
|
|
2629
|
-
allowShortResponses: true,
|
|
2630
|
-
},
|
|
2631
|
-
eventMessages: {
|
|
2632
|
-
onNewChat: {
|
|
2633
|
-
enabled: false,
|
|
2634
|
-
text: "",
|
|
2635
|
-
},
|
|
2636
|
-
onInactivityTimeout: {
|
|
2637
|
-
enabled: false,
|
|
2638
|
-
text: "",
|
|
2639
|
-
},
|
|
2640
|
-
onMaxDurationTimeout: {
|
|
2641
|
-
enabled: false,
|
|
2642
|
-
text: "",
|
|
2643
|
-
},
|
|
2644
|
-
},
|
|
2685
|
+
await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8d2c-189d354db3f3", 1, {
|
|
2686
|
+
versionDescription: "This is an updated version_description.",
|
|
2645
2687
|
});
|
|
2646
2688
|
```
|
|
2647
2689
|
|
|
@@ -2666,7 +2708,21 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2666
2708
|
<dl>
|
|
2667
2709
|
<dd>
|
|
2668
2710
|
|
|
2669
|
-
**
|
|
2711
|
+
**version:** `number`
|
|
2712
|
+
|
|
2713
|
+
Version number for a Config.
|
|
2714
|
+
|
|
2715
|
+
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.
|
|
2716
|
+
|
|
2717
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2718
|
+
|
|
2719
|
+
</dd>
|
|
2720
|
+
</dl>
|
|
2721
|
+
|
|
2722
|
+
<dl>
|
|
2723
|
+
<dd>
|
|
2724
|
+
|
|
2725
|
+
**request:** `Hume.empathicVoice.PostedConfigVersionDescription`
|
|
2670
2726
|
|
|
2671
2727
|
</dd>
|
|
2672
2728
|
</dl>
|
|
@@ -2685,7 +2741,9 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2685
2741
|
</dl>
|
|
2686
2742
|
</details>
|
|
2687
2743
|
|
|
2688
|
-
|
|
2744
|
+
## EmpathicVoice Chats
|
|
2745
|
+
|
|
2746
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
2689
2747
|
<dl>
|
|
2690
2748
|
<dd>
|
|
2691
2749
|
|
|
@@ -2697,9 +2755,7 @@ await client.empathicVoice.configs.createConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2697
2755
|
<dl>
|
|
2698
2756
|
<dd>
|
|
2699
2757
|
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2758
|
+
Fetches a paginated list of **Chats**.
|
|
2703
2759
|
|
|
2704
2760
|
</dd>
|
|
2705
2761
|
</dl>
|
|
@@ -2715,7 +2771,11 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2715
2771
|
<dd>
|
|
2716
2772
|
|
|
2717
2773
|
```typescript
|
|
2718
|
-
await client.empathicVoice.
|
|
2774
|
+
await client.empathicVoice.chats.listChats({
|
|
2775
|
+
pageNumber: 0,
|
|
2776
|
+
pageSize: 1,
|
|
2777
|
+
ascendingOrder: true,
|
|
2778
|
+
});
|
|
2719
2779
|
```
|
|
2720
2780
|
|
|
2721
2781
|
</dd>
|
|
@@ -2731,7 +2791,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2731
2791
|
<dl>
|
|
2732
2792
|
<dd>
|
|
2733
2793
|
|
|
2734
|
-
**
|
|
2794
|
+
**request:** `Hume.empathicVoice.ChatsListChatsRequest`
|
|
2735
2795
|
|
|
2736
2796
|
</dd>
|
|
2737
2797
|
</dl>
|
|
@@ -2739,7 +2799,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2739
2799
|
<dl>
|
|
2740
2800
|
<dd>
|
|
2741
2801
|
|
|
2742
|
-
**requestOptions:** `
|
|
2802
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2743
2803
|
|
|
2744
2804
|
</dd>
|
|
2745
2805
|
</dl>
|
|
@@ -2750,7 +2810,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2750
2810
|
</dl>
|
|
2751
2811
|
</details>
|
|
2752
2812
|
|
|
2753
|
-
<details><summary><code>client.empathicVoice.
|
|
2813
|
+
<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></code></summary>
|
|
2754
2814
|
<dl>
|
|
2755
2815
|
<dd>
|
|
2756
2816
|
|
|
@@ -2762,9 +2822,7 @@ await client.empathicVoice.configs.deleteConfig("1b60e1a0-cc59-424a-8d2c-189d354
|
|
|
2762
2822
|
<dl>
|
|
2763
2823
|
<dd>
|
|
2764
2824
|
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2825
|
+
Fetches a paginated list of **Chat** events.
|
|
2768
2826
|
|
|
2769
2827
|
</dd>
|
|
2770
2828
|
</dl>
|
|
@@ -2780,8 +2838,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2780
2838
|
<dd>
|
|
2781
2839
|
|
|
2782
2840
|
```typescript
|
|
2783
|
-
await client.empathicVoice.
|
|
2784
|
-
|
|
2841
|
+
await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2d63b0", {
|
|
2842
|
+
pageNumber: 0,
|
|
2843
|
+
pageSize: 3,
|
|
2844
|
+
ascendingOrder: true,
|
|
2785
2845
|
});
|
|
2786
2846
|
```
|
|
2787
2847
|
|
|
@@ -2798,7 +2858,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2798
2858
|
<dl>
|
|
2799
2859
|
<dd>
|
|
2800
2860
|
|
|
2801
|
-
**id:** `string` — Identifier for a
|
|
2861
|
+
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
2802
2862
|
|
|
2803
2863
|
</dd>
|
|
2804
2864
|
</dl>
|
|
@@ -2806,7 +2866,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2806
2866
|
<dl>
|
|
2807
2867
|
<dd>
|
|
2808
2868
|
|
|
2809
|
-
**request:** `Hume.empathicVoice.
|
|
2869
|
+
**request:** `Hume.empathicVoice.ChatsListChatEventsRequest`
|
|
2810
2870
|
|
|
2811
2871
|
</dd>
|
|
2812
2872
|
</dl>
|
|
@@ -2814,7 +2874,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2814
2874
|
<dl>
|
|
2815
2875
|
<dd>
|
|
2816
2876
|
|
|
2817
|
-
**requestOptions:** `
|
|
2877
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2818
2878
|
|
|
2819
2879
|
</dd>
|
|
2820
2880
|
</dl>
|
|
@@ -2825,7 +2885,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2825
2885
|
</dl>
|
|
2826
2886
|
</details>
|
|
2827
2887
|
|
|
2828
|
-
<details><summary><code>client.empathicVoice.
|
|
2888
|
+
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">getAudio</a>(id) -> Hume.ReturnChatAudioReconstruction</code></summary>
|
|
2829
2889
|
<dl>
|
|
2830
2890
|
<dd>
|
|
2831
2891
|
|
|
@@ -2837,9 +2897,7 @@ await client.empathicVoice.configs.updateConfigName("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2837
2897
|
<dl>
|
|
2838
2898
|
<dd>
|
|
2839
2899
|
|
|
2840
|
-
Fetches
|
|
2841
|
-
|
|
2842
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2900
|
+
Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
2843
2901
|
|
|
2844
2902
|
</dd>
|
|
2845
2903
|
</dl>
|
|
@@ -2855,7 +2913,7 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2855
2913
|
<dd>
|
|
2856
2914
|
|
|
2857
2915
|
```typescript
|
|
2858
|
-
await client.empathicVoice.
|
|
2916
|
+
await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0");
|
|
2859
2917
|
```
|
|
2860
2918
|
|
|
2861
2919
|
</dd>
|
|
@@ -2871,21 +2929,7 @@ await client.empathicVoice.configs.getConfigVersion("1b60e1a0-cc59-424a-8d2c-189
|
|
|
2871
2929
|
<dl>
|
|
2872
2930
|
<dd>
|
|
2873
2931
|
|
|
2874
|
-
**id:** `string` — Identifier for a
|
|
2875
|
-
|
|
2876
|
-
</dd>
|
|
2877
|
-
</dl>
|
|
2878
|
-
|
|
2879
|
-
<dl>
|
|
2880
|
-
<dd>
|
|
2881
|
-
|
|
2882
|
-
**version:** `number`
|
|
2883
|
-
|
|
2884
|
-
Version number for a Config.
|
|
2885
|
-
|
|
2886
|
-
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.
|
|
2887
|
-
|
|
2888
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2932
|
+
**id:** `string` — Identifier for a chat. Formatted as a UUID.
|
|
2889
2933
|
|
|
2890
2934
|
</dd>
|
|
2891
2935
|
</dl>
|
|
@@ -2893,7 +2937,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2893
2937
|
<dl>
|
|
2894
2938
|
<dd>
|
|
2895
2939
|
|
|
2896
|
-
**requestOptions:** `
|
|
2940
|
+
**requestOptions:** `Chats.RequestOptions`
|
|
2897
2941
|
|
|
2898
2942
|
</dd>
|
|
2899
2943
|
</dl>
|
|
@@ -2904,7 +2948,9 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2904
2948
|
</dl>
|
|
2905
2949
|
</details>
|
|
2906
2950
|
|
|
2907
|
-
|
|
2951
|
+
## EmpathicVoice ChatGroups
|
|
2952
|
+
|
|
2953
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
2908
2954
|
<dl>
|
|
2909
2955
|
<dd>
|
|
2910
2956
|
|
|
@@ -2916,9 +2962,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2916
2962
|
<dl>
|
|
2917
2963
|
<dd>
|
|
2918
2964
|
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
2965
|
+
Fetches a paginated list of **Chat Groups**.
|
|
2922
2966
|
|
|
2923
2967
|
</dd>
|
|
2924
2968
|
</dl>
|
|
@@ -2934,7 +2978,12 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
2934
2978
|
<dd>
|
|
2935
2979
|
|
|
2936
2980
|
```typescript
|
|
2937
|
-
await client.empathicVoice.
|
|
2981
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
2982
|
+
pageNumber: 0,
|
|
2983
|
+
pageSize: 1,
|
|
2984
|
+
ascendingOrder: true,
|
|
2985
|
+
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
2986
|
+
});
|
|
2938
2987
|
```
|
|
2939
2988
|
|
|
2940
2989
|
</dd>
|
|
@@ -2950,21 +2999,7 @@ await client.empathicVoice.configs.deleteConfigVersion("1b60e1a0-cc59-424a-8d2c-
|
|
|
2950
2999
|
<dl>
|
|
2951
3000
|
<dd>
|
|
2952
3001
|
|
|
2953
|
-
**
|
|
2954
|
-
|
|
2955
|
-
</dd>
|
|
2956
|
-
</dl>
|
|
2957
|
-
|
|
2958
|
-
<dl>
|
|
2959
|
-
<dd>
|
|
2960
|
-
|
|
2961
|
-
**version:** `number`
|
|
2962
|
-
|
|
2963
|
-
Version number for a Config.
|
|
2964
|
-
|
|
2965
|
-
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.
|
|
2966
|
-
|
|
2967
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
3002
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`
|
|
2968
3003
|
|
|
2969
3004
|
</dd>
|
|
2970
3005
|
</dl>
|
|
@@ -2972,7 +3007,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2972
3007
|
<dl>
|
|
2973
3008
|
<dd>
|
|
2974
3009
|
|
|
2975
|
-
**requestOptions:** `
|
|
3010
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
2976
3011
|
|
|
2977
3012
|
</dd>
|
|
2978
3013
|
</dl>
|
|
@@ -2983,7 +3018,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2983
3018
|
</dl>
|
|
2984
3019
|
</details>
|
|
2985
3020
|
|
|
2986
|
-
<details><summary><code>client.empathicVoice.
|
|
3021
|
+
<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>
|
|
2987
3022
|
<dl>
|
|
2988
3023
|
<dd>
|
|
2989
3024
|
|
|
@@ -2995,9 +3030,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
2995
3030
|
<dl>
|
|
2996
3031
|
<dd>
|
|
2997
3032
|
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
For more details on configuration options and how to configure EVI, see our [configuration guide](/docs/empathic-voice-interface-evi/configuration).
|
|
3033
|
+
Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**.
|
|
3001
3034
|
|
|
3002
3035
|
</dd>
|
|
3003
3036
|
</dl>
|
|
@@ -3013,8 +3046,10 @@ For more details on configuration options and how to configure EVI, see our [con
|
|
|
3013
3046
|
<dd>
|
|
3014
3047
|
|
|
3015
3048
|
```typescript
|
|
3016
|
-
await client.empathicVoice.
|
|
3017
|
-
|
|
3049
|
+
await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3050
|
+
pageNumber: 0,
|
|
3051
|
+
pageSize: 1,
|
|
3052
|
+
ascendingOrder: true,
|
|
3018
3053
|
});
|
|
3019
3054
|
```
|
|
3020
3055
|
|
|
@@ -3031,21 +3066,7 @@ await client.empathicVoice.configs.updateConfigDescription("1b60e1a0-cc59-424a-8
|
|
|
3031
3066
|
<dl>
|
|
3032
3067
|
<dd>
|
|
3033
3068
|
|
|
3034
|
-
**id:** `string` — Identifier for a
|
|
3035
|
-
|
|
3036
|
-
</dd>
|
|
3037
|
-
</dl>
|
|
3038
|
-
|
|
3039
|
-
<dl>
|
|
3040
|
-
<dd>
|
|
3041
|
-
|
|
3042
|
-
**version:** `number`
|
|
3043
|
-
|
|
3044
|
-
Version number for a Config.
|
|
3045
|
-
|
|
3046
|
-
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.
|
|
3047
|
-
|
|
3048
|
-
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
3069
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3049
3070
|
|
|
3050
3071
|
</dd>
|
|
3051
3072
|
</dl>
|
|
@@ -3053,7 +3074,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
3053
3074
|
<dl>
|
|
3054
3075
|
<dd>
|
|
3055
3076
|
|
|
3056
|
-
**request:** `Hume.empathicVoice.
|
|
3077
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3057
3078
|
|
|
3058
3079
|
</dd>
|
|
3059
3080
|
</dl>
|
|
@@ -3061,7 +3082,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
3061
3082
|
<dl>
|
|
3062
3083
|
<dd>
|
|
3063
3084
|
|
|
3064
|
-
**requestOptions:** `
|
|
3085
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3065
3086
|
|
|
3066
3087
|
</dd>
|
|
3067
3088
|
</dl>
|
|
@@ -3072,9 +3093,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
3072
3093
|
</dl>
|
|
3073
3094
|
</details>
|
|
3074
3095
|
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
<details><summary><code>client.empathicVoice.chats.<a href="/src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> core.Page<Hume.ReturnChat></code></summary>
|
|
3096
|
+
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroupEvents</a>(id, { ...params }) -> Hume.ReturnChatGroupPagedEvents</code></summary>
|
|
3078
3097
|
<dl>
|
|
3079
3098
|
<dd>
|
|
3080
3099
|
|
|
@@ -3086,7 +3105,7 @@ Version numbers are integer values representing different iterations of the Conf
|
|
|
3086
3105
|
<dl>
|
|
3087
3106
|
<dd>
|
|
3088
3107
|
|
|
3089
|
-
Fetches a paginated list of **
|
|
3108
|
+
Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
3090
3109
|
|
|
3091
3110
|
</dd>
|
|
3092
3111
|
</dl>
|
|
@@ -3102,9 +3121,9 @@ Fetches a paginated list of **Chats**.
|
|
|
3102
3121
|
<dd>
|
|
3103
3122
|
|
|
3104
3123
|
```typescript
|
|
3105
|
-
await client.empathicVoice.
|
|
3124
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9bd8-9c19df79f05f", {
|
|
3106
3125
|
pageNumber: 0,
|
|
3107
|
-
pageSize:
|
|
3126
|
+
pageSize: 3,
|
|
3108
3127
|
ascendingOrder: true,
|
|
3109
3128
|
});
|
|
3110
3129
|
```
|
|
@@ -3122,7 +3141,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
3122
3141
|
<dl>
|
|
3123
3142
|
<dd>
|
|
3124
3143
|
|
|
3125
|
-
**
|
|
3144
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3126
3145
|
|
|
3127
3146
|
</dd>
|
|
3128
3147
|
</dl>
|
|
@@ -3130,7 +3149,15 @@ await client.empathicVoice.chats.listChats({
|
|
|
3130
3149
|
<dl>
|
|
3131
3150
|
<dd>
|
|
3132
3151
|
|
|
3133
|
-
**
|
|
3152
|
+
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3153
|
+
|
|
3154
|
+
</dd>
|
|
3155
|
+
</dl>
|
|
3156
|
+
|
|
3157
|
+
<dl>
|
|
3158
|
+
<dd>
|
|
3159
|
+
|
|
3160
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3134
3161
|
|
|
3135
3162
|
</dd>
|
|
3136
3163
|
</dl>
|
|
@@ -3141,7 +3168,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
3141
3168
|
</dl>
|
|
3142
3169
|
</details>
|
|
3143
3170
|
|
|
3144
|
-
<details><summary><code>client.empathicVoice.
|
|
3171
|
+
<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>
|
|
3145
3172
|
<dl>
|
|
3146
3173
|
<dd>
|
|
3147
3174
|
|
|
@@ -3153,7 +3180,7 @@ await client.empathicVoice.chats.listChats({
|
|
|
3153
3180
|
<dl>
|
|
3154
3181
|
<dd>
|
|
3155
3182
|
|
|
3156
|
-
Fetches a paginated list of **Chat**
|
|
3183
|
+
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/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
|
|
3157
3184
|
|
|
3158
3185
|
</dd>
|
|
3159
3186
|
</dl>
|
|
@@ -3169,9 +3196,9 @@ Fetches a paginated list of **Chat** events.
|
|
|
3169
3196
|
<dd>
|
|
3170
3197
|
|
|
3171
3198
|
```typescript
|
|
3172
|
-
await client.empathicVoice.
|
|
3199
|
+
await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
|
|
3173
3200
|
pageNumber: 0,
|
|
3174
|
-
pageSize:
|
|
3201
|
+
pageSize: 10,
|
|
3175
3202
|
ascendingOrder: true,
|
|
3176
3203
|
});
|
|
3177
3204
|
```
|
|
@@ -3189,7 +3216,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
3189
3216
|
<dl>
|
|
3190
3217
|
<dd>
|
|
3191
3218
|
|
|
3192
|
-
**id:** `string` — Identifier for a Chat. Formatted as a UUID.
|
|
3219
|
+
**id:** `string` — Identifier for a Chat Group. Formatted as a UUID.
|
|
3193
3220
|
|
|
3194
3221
|
</dd>
|
|
3195
3222
|
</dl>
|
|
@@ -3197,7 +3224,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
3197
3224
|
<dl>
|
|
3198
3225
|
<dd>
|
|
3199
3226
|
|
|
3200
|
-
**request:** `Hume.empathicVoice.
|
|
3227
|
+
**request:** `Hume.empathicVoice.ChatGroupsGetAudioRequest`
|
|
3201
3228
|
|
|
3202
3229
|
</dd>
|
|
3203
3230
|
</dl>
|
|
@@ -3205,7 +3232,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
3205
3232
|
<dl>
|
|
3206
3233
|
<dd>
|
|
3207
3234
|
|
|
3208
|
-
**requestOptions:** `
|
|
3235
|
+
**requestOptions:** `ChatGroups.RequestOptions`
|
|
3209
3236
|
|
|
3210
3237
|
</dd>
|
|
3211
3238
|
</dl>
|
|
@@ -3216,7 +3243,9 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
3216
3243
|
</dl>
|
|
3217
3244
|
</details>
|
|
3218
3245
|
|
|
3219
|
-
|
|
3246
|
+
## ExpressionMeasurement Batch
|
|
3247
|
+
|
|
3248
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code></summary>
|
|
3220
3249
|
<dl>
|
|
3221
3250
|
<dd>
|
|
3222
3251
|
|
|
@@ -3228,7 +3257,7 @@ await client.empathicVoice.chats.listChatEvents("470a49f6-1dec-4afe-8b61-035d3b2
|
|
|
3228
3257
|
<dl>
|
|
3229
3258
|
<dd>
|
|
3230
3259
|
|
|
3231
|
-
|
|
3260
|
+
Sort and filter jobs.
|
|
3232
3261
|
|
|
3233
3262
|
</dd>
|
|
3234
3263
|
</dl>
|
|
@@ -3244,7 +3273,7 @@ Fetches the audio of a previous **Chat**. For more details, see our guide on aud
|
|
|
3244
3273
|
<dd>
|
|
3245
3274
|
|
|
3246
3275
|
```typescript
|
|
3247
|
-
await client.
|
|
3276
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
3248
3277
|
```
|
|
3249
3278
|
|
|
3250
3279
|
</dd>
|
|
@@ -3260,7 +3289,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3260
3289
|
<dl>
|
|
3261
3290
|
<dd>
|
|
3262
3291
|
|
|
3263
|
-
**
|
|
3292
|
+
**request:** `Hume.expressionMeasurement.batch.BatchListJobsRequest`
|
|
3264
3293
|
|
|
3265
3294
|
</dd>
|
|
3266
3295
|
</dl>
|
|
@@ -3268,7 +3297,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3268
3297
|
<dl>
|
|
3269
3298
|
<dd>
|
|
3270
3299
|
|
|
3271
|
-
**requestOptions:** `
|
|
3300
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
3272
3301
|
|
|
3273
3302
|
</dd>
|
|
3274
3303
|
</dl>
|
|
@@ -3279,9 +3308,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3279
3308
|
</dl>
|
|
3280
3309
|
</details>
|
|
3281
3310
|
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
<details><summary><code>client.empathicVoice.chatGroups.<a href="/src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code></summary>
|
|
3311
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code></summary>
|
|
3285
3312
|
<dl>
|
|
3286
3313
|
<dd>
|
|
3287
3314
|
|
|
@@ -3293,7 +3320,7 @@ await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0"
|
|
|
3293
3320
|
<dl>
|
|
3294
3321
|
<dd>
|
|
3295
3322
|
|
|
3296
|
-
|
|
3323
|
+
Start a new measurement inference job.
|
|
3297
3324
|
|
|
3298
3325
|
</dd>
|
|
3299
3326
|
</dl>
|
|
@@ -3309,11 +3336,9 @@ Fetches a paginated list of **Chat Groups**.
|
|
|
3309
3336
|
<dd>
|
|
3310
3337
|
|
|
3311
3338
|
```typescript
|
|
3312
|
-
await client.
|
|
3313
|
-
|
|
3314
|
-
|
|
3315
|
-
ascendingOrder: true,
|
|
3316
|
-
configId: "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
|
|
3339
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
3340
|
+
urls: ["https://hume-tutorials.s3.amazonaws.com/faces.zip"],
|
|
3341
|
+
notify: true,
|
|
3317
3342
|
});
|
|
3318
3343
|
```
|
|
3319
3344
|
|
|
@@ -3330,7 +3355,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3330
3355
|
<dl>
|
|
3331
3356
|
<dd>
|
|
3332
3357
|
|
|
3333
|
-
**request:** `Hume.
|
|
3358
|
+
**request:** `Hume.InferenceBaseRequest`
|
|
3334
3359
|
|
|
3335
3360
|
</dd>
|
|
3336
3361
|
</dl>
|
|
@@ -3338,7 +3363,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3338
3363
|
<dl>
|
|
3339
3364
|
<dd>
|
|
3340
3365
|
|
|
3341
|
-
**requestOptions:** `
|
|
3366
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
3342
3367
|
|
|
3343
3368
|
</dd>
|
|
3344
3369
|
</dl>
|
|
@@ -3349,7 +3374,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3349
3374
|
</dl>
|
|
3350
3375
|
</details>
|
|
3351
3376
|
|
|
3352
|
-
<details><summary><code>client.
|
|
3377
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code></summary>
|
|
3353
3378
|
<dl>
|
|
3354
3379
|
<dd>
|
|
3355
3380
|
|
|
@@ -3361,7 +3386,7 @@ await client.empathicVoice.chatGroups.listChatGroups({
|
|
|
3361
3386
|
<dl>
|
|
3362
3387
|
<dd>
|
|
3363
3388
|
|
|
3364
|
-
|
|
3389
|
+
Get the request details and state of a given job.
|
|
3365
3390
|
|
|
3366
3391
|
</dd>
|
|
3367
3392
|
</dl>
|
|
@@ -3377,11 +3402,7 @@ Fetches a **ChatGroup** by ID, including a paginated list of **Chats** associate
|
|
|
3377
3402
|
<dd>
|
|
3378
3403
|
|
|
3379
3404
|
```typescript
|
|
3380
|
-
await client.
|
|
3381
|
-
pageNumber: 0,
|
|
3382
|
-
pageSize: 1,
|
|
3383
|
-
ascendingOrder: true,
|
|
3384
|
-
});
|
|
3405
|
+
await client.expressionMeasurement.batch.getJobDetails("job_id");
|
|
3385
3406
|
```
|
|
3386
3407
|
|
|
3387
3408
|
</dd>
|
|
@@ -3397,15 +3418,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3397
3418
|
<dl>
|
|
3398
3419
|
<dd>
|
|
3399
3420
|
|
|
3400
|
-
**id:** `string` —
|
|
3401
|
-
|
|
3402
|
-
</dd>
|
|
3403
|
-
</dl>
|
|
3404
|
-
|
|
3405
|
-
<dl>
|
|
3406
|
-
<dd>
|
|
3407
|
-
|
|
3408
|
-
**request:** `Hume.empathicVoice.ChatGroupsGetChatGroupRequest`
|
|
3421
|
+
**id:** `string` — The unique identifier for the job.
|
|
3409
3422
|
|
|
3410
3423
|
</dd>
|
|
3411
3424
|
</dl>
|
|
@@ -3413,7 +3426,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3413
3426
|
<dl>
|
|
3414
3427
|
<dd>
|
|
3415
3428
|
|
|
3416
|
-
**requestOptions:** `
|
|
3429
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
3417
3430
|
|
|
3418
3431
|
</dd>
|
|
3419
3432
|
</dl>
|
|
@@ -3424,7 +3437,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3424
3437
|
</dl>
|
|
3425
3438
|
</details>
|
|
3426
3439
|
|
|
3427
|
-
<details><summary><code>client.
|
|
3440
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code></summary>
|
|
3428
3441
|
<dl>
|
|
3429
3442
|
<dd>
|
|
3430
3443
|
|
|
@@ -3436,7 +3449,7 @@ await client.empathicVoice.chatGroups.getChatGroup("697056f0-6c7e-487d-9bd8-9c19
|
|
|
3436
3449
|
<dl>
|
|
3437
3450
|
<dd>
|
|
3438
3451
|
|
|
3439
|
-
|
|
3452
|
+
Get the JSON predictions of a completed inference job.
|
|
3440
3453
|
|
|
3441
3454
|
</dd>
|
|
3442
3455
|
</dl>
|
|
@@ -3452,11 +3465,7 @@ Fetches a paginated list of **Chat** events associated with a **Chat Group**.
|
|
|
3452
3465
|
<dd>
|
|
3453
3466
|
|
|
3454
3467
|
```typescript
|
|
3455
|
-
await client.
|
|
3456
|
-
pageNumber: 0,
|
|
3457
|
-
pageSize: 3,
|
|
3458
|
-
ascendingOrder: true,
|
|
3459
|
-
});
|
|
3468
|
+
await client.expressionMeasurement.batch.getJobPredictions("job_id");
|
|
3460
3469
|
```
|
|
3461
3470
|
|
|
3462
3471
|
</dd>
|
|
@@ -3472,15 +3481,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3472
3481
|
<dl>
|
|
3473
3482
|
<dd>
|
|
3474
3483
|
|
|
3475
|
-
**id:** `string` —
|
|
3476
|
-
|
|
3477
|
-
</dd>
|
|
3478
|
-
</dl>
|
|
3479
|
-
|
|
3480
|
-
<dl>
|
|
3481
|
-
<dd>
|
|
3482
|
-
|
|
3483
|
-
**request:** `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`
|
|
3484
|
+
**id:** `string` — The unique identifier for the job.
|
|
3484
3485
|
|
|
3485
3486
|
</dd>
|
|
3486
3487
|
</dl>
|
|
@@ -3488,7 +3489,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3488
3489
|
<dl>
|
|
3489
3490
|
<dd>
|
|
3490
3491
|
|
|
3491
|
-
**requestOptions:** `
|
|
3492
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
3492
3493
|
|
|
3493
3494
|
</dd>
|
|
3494
3495
|
</dl>
|
|
@@ -3499,7 +3500,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3499
3500
|
</dl>
|
|
3500
3501
|
</details>
|
|
3501
3502
|
|
|
3502
|
-
<details><summary><code>client.
|
|
3503
|
+
<details><summary><code>client.expressionMeasurement.batch.<a href="/src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJobFromLocalFile</a>(file, { ...params }) -> Hume.JobId</code></summary>
|
|
3503
3504
|
<dl>
|
|
3504
3505
|
<dd>
|
|
3505
3506
|
|
|
@@ -3511,7 +3512,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents("697056f0-6c7e-487d-9b
|
|
|
3511
3512
|
<dl>
|
|
3512
3513
|
<dd>
|
|
3513
3514
|
|
|
3514
|
-
|
|
3515
|
+
Start a new batch inference job.
|
|
3515
3516
|
|
|
3516
3517
|
</dd>
|
|
3517
3518
|
</dl>
|
|
@@ -3527,11 +3528,10 @@ Fetches a paginated list of audio for each **Chat** within the specified **Chat
|
|
|
3527
3528
|
<dd>
|
|
3528
3529
|
|
|
3529
3530
|
```typescript
|
|
3530
|
-
await client.
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
});
|
|
3531
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
3532
|
+
[fs.createReadStream("/path/to/your/file")],
|
|
3533
|
+
{}
|
|
3534
|
+
);
|
|
3535
3535
|
```
|
|
3536
3536
|
|
|
3537
3537
|
</dd>
|
|
@@ -3547,7 +3547,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3547
3547
|
<dl>
|
|
3548
3548
|
<dd>
|
|
3549
3549
|
|
|
3550
|
-
**
|
|
3550
|
+
**file:** `File[] | fs.ReadStream[] | Blob[]`
|
|
3551
3551
|
|
|
3552
3552
|
</dd>
|
|
3553
3553
|
</dl>
|
|
@@ -3555,7 +3555,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3555
3555
|
<dl>
|
|
3556
3556
|
<dd>
|
|
3557
3557
|
|
|
3558
|
-
**request:** `Hume.
|
|
3558
|
+
**request:** `Hume.expressionMeasurement.batch.BatchStartInferenceJobFromLocalFileRequest`
|
|
3559
3559
|
|
|
3560
3560
|
</dd>
|
|
3561
3561
|
</dl>
|
|
@@ -3563,7 +3563,7 @@ await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cd
|
|
|
3563
3563
|
<dl>
|
|
3564
3564
|
<dd>
|
|
3565
3565
|
|
|
3566
|
-
**requestOptions:** `
|
|
3566
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
3567
3567
|
|
|
3568
3568
|
</dd>
|
|
3569
3569
|
</dl>
|