hume 0.8.4 → 0.8.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/empathic-voice/__package__.yml +855 -216
- package/.mock/definition/empathic-voice/chatGroups.yml +383 -35
- package/.mock/definition/empathic-voice/chats.yml +393 -44
- package/.mock/definition/empathic-voice/configs.yml +437 -228
- package/.mock/definition/empathic-voice/prompts.yml +258 -83
- package/.mock/definition/empathic-voice/tools.yml +119 -23
- package/.mock/definition/expression-measurement/__package__.yml +203 -59
- package/.mock/definition/expression-measurement/batch.yml +64 -35
- package/.mock/fern.config.json +1 -1
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +12 -3
- package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +14 -5
- package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +12 -4
- package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +16 -5
- package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +13 -5
- package/api/resources/empathicVoice/resources/chats/client/Client.js +129 -97
- package/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.ts +12 -4
- package/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.ts +12 -4
- package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +96 -20
- package/api/resources/empathicVoice/resources/configs/client/Client.js +105 -29
- package/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.ts +7 -3
- package/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +11 -4
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +42 -4
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigName.d.ts +1 -1
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +47 -4
- package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts +4 -2
- package/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +41 -23
- package/api/resources/empathicVoice/resources/prompts/client/Client.js +111 -80
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +10 -4
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptName.d.ts +1 -1
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +10 -3
- package/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts +4 -2
- package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts +7 -3
- package/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +11 -4
- package/api/resources/empathicVoice/resources/tools/client/Client.d.ts +23 -11
- package/api/resources/empathicVoice/resources/tools/client/Client.js +93 -68
- package/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +8 -4
- package/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +8 -4
- package/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts +1 -1
- package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolVersionsRequest.d.ts +7 -3
- package/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +7 -3
- package/api/resources/empathicVoice/types/AudioInput.d.ts +4 -2
- package/api/resources/empathicVoice/types/Inference.d.ts +1 -1
- package/api/resources/empathicVoice/types/JsonMessage.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedEllmModel.d.ts +5 -1
- package/api/resources/empathicVoice/types/PostedEventMessageSpec.d.ts +6 -2
- package/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +16 -2
- package/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +7 -3
- package/api/resources/empathicVoice/types/PostedLanguageModelModelProvider.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +8 -2
- package/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +3 -1
- package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
- package/api/resources/empathicVoice/types/PostedUserDefinedToolSpec.d.ts +7 -1
- package/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
- package/api/resources/empathicVoice/types/ProsodyInference.d.ts +3 -1
- package/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +4 -3
- package/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.ts +11 -0
- package/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.js +10 -0
- package/api/resources/empathicVoice/types/ReturnChat.d.ts +20 -8
- package/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +38 -9
- package/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +21 -0
- package/api/resources/empathicVoice/types/ReturnChatEventRole.js +12 -0
- package/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +27 -0
- package/api/resources/empathicVoice/types/ReturnChatEventType.js +14 -0
- package/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +5 -5
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +19 -7
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.ts +13 -0
- package/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.js +10 -0
- package/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +38 -14
- package/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.ts +13 -0
- package/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.js +10 -0
- package/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.ts +27 -0
- package/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.js +14 -0
- package/api/resources/empathicVoice/types/ReturnChatStatus.d.ts +27 -0
- package/api/resources/empathicVoice/types/ReturnChatStatus.js +14 -0
- package/api/resources/empathicVoice/types/ReturnConfig.d.ts +23 -6
- package/api/resources/empathicVoice/types/ReturnConfigSpec.d.ts +8 -2
- package/api/resources/empathicVoice/types/ReturnEllmModel.d.ts +5 -1
- package/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts +6 -2
- package/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +16 -2
- package/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +9 -4
- package/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.d.ts +15 -0
- package/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.js +14 -0
- package/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +18 -6
- package/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.ts +13 -0
- package/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.js +10 -0
- package/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +18 -6
- package/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.ts +13 -0
- package/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js +10 -0
- package/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +12 -4
- package/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +12 -4
- package/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +12 -4
- package/api/resources/empathicVoice/types/ReturnPrompt.d.ts +21 -8
- package/api/resources/empathicVoice/types/ReturnPromptVersionType.d.ts +11 -0
- package/api/resources/empathicVoice/types/ReturnPromptVersionType.js +10 -0
- package/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +6 -2
- package/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +13 -1
- package/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +22 -11
- package/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.ts +11 -0
- package/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js +10 -0
- package/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts +11 -0
- package/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js +10 -0
- package/api/resources/empathicVoice/types/ReturnVoice.d.ts +4 -3
- package/api/resources/empathicVoice/types/ReturnVoiceName.d.ts +12 -0
- package/api/resources/empathicVoice/types/ReturnVoiceName.js +11 -0
- package/api/resources/empathicVoice/types/index.d.ts +14 -0
- package/api/resources/empathicVoice/types/index.js +14 -0
- package/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +4 -4
- package/api/resources/expressionMeasurement/resources/batch/client/Client.js +11 -19
- package/api/resources/expressionMeasurement/resources/batch/client/requests/BatchListJobsRequest.d.ts +25 -9
- package/api/resources/expressionMeasurement/resources/batch/client/requests/BatchStartInferenceJobFromLocalFileRequest.d.ts +1 -0
- package/api/resources/expressionMeasurement/types/{UnionJobJobInference.d.ts → CustomModelsInferenceJob.d.ts} +2 -1
- package/api/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.d.ts → CustomModelsTrainingJob.d.ts} +2 -1
- package/api/resources/expressionMeasurement/types/EmbeddingGenerationJob.d.ts +7 -0
- package/api/resources/expressionMeasurement/types/Face.d.ts +5 -0
- package/api/resources/expressionMeasurement/types/File_.d.ts +3 -0
- package/api/resources/expressionMeasurement/types/Granularity.d.ts +9 -1
- package/api/resources/expressionMeasurement/types/InferenceBaseRequest.d.ts +6 -1
- package/api/resources/expressionMeasurement/types/InferenceJob.d.ts +12 -0
- package/api/resources/expressionMeasurement/types/JobInference.d.ts +3 -0
- package/api/resources/expressionMeasurement/types/Language.d.ts +5 -0
- package/api/resources/expressionMeasurement/types/Models.d.ts +3 -0
- package/api/resources/expressionMeasurement/types/Ner.d.ts +5 -0
- package/api/resources/expressionMeasurement/types/Prosody.d.ts +5 -0
- package/api/resources/expressionMeasurement/types/Transcription.d.ts +40 -0
- package/api/resources/expressionMeasurement/types/UnionJob.d.ts +1 -15
- package/api/resources/expressionMeasurement/types/UnionPredictResult.d.ts +1 -1
- package/api/resources/expressionMeasurement/types/Window.d.ts +5 -0
- package/api/resources/expressionMeasurement/types/index.d.ts +4 -4
- package/api/resources/expressionMeasurement/types/index.js +4 -4
- package/api/resources/index.d.ts +1 -1
- package/api/resources/index.js +2 -2
- package/core/index.d.ts +1 -0
- package/core/index.js +1 -0
- package/core/pagination/Page.d.ts +29 -0
- package/core/pagination/Page.js +94 -0
- package/core/pagination/Pageable.d.ts +12 -0
- package/core/pagination/Pageable.js +10 -0
- package/core/pagination/index.d.ts +2 -0
- package/core/pagination/index.js +7 -0
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +12 -3
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +14 -5
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupEventsRequest.d.ts +12 -4
- package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsListChatGroupsRequest.d.ts +16 -5
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +13 -5
- package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +129 -97
- package/dist/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatEventsRequest.d.ts +12 -4
- package/dist/api/resources/empathicVoice/resources/chats/client/requests/ChatsListChatsRequest.d.ts +12 -4
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +96 -20
- package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +105 -29
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigVersionsRequest.d.ts +7 -3
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/ConfigsListConfigsRequest.d.ts +11 -4
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +42 -4
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigName.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +47 -4
- package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersionDescription.d.ts +4 -2
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.d.ts +41 -23
- package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +111 -80
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPrompt.d.ts +10 -4
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptName.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersion.d.ts +10 -3
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PostedPromptVersionDescription.d.ts +4 -2
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptVersionsRequest.d.ts +7 -3
- package/dist/api/resources/empathicVoice/resources/prompts/client/requests/PromptsListPromptsRequest.d.ts +11 -4
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.d.ts +23 -11
- package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +93 -68
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedTool.d.ts +8 -4
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersion.d.ts +8 -4
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/PostedUserDefinedToolVersionDescription.d.ts +1 -1
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolVersionsRequest.d.ts +7 -3
- package/dist/api/resources/empathicVoice/resources/tools/client/requests/ToolsListToolsRequest.d.ts +7 -3
- package/dist/api/resources/empathicVoice/types/AudioInput.d.ts +4 -2
- package/dist/api/resources/empathicVoice/types/Inference.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/JsonMessage.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedBuiltinTool.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedEllmModel.d.ts +5 -1
- package/dist/api/resources/empathicVoice/types/PostedEventMessageSpec.d.ts +6 -2
- package/dist/api/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +16 -2
- package/dist/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +7 -3
- package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelProvider.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedPromptSpec.d.ts +8 -2
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +3 -1
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/PostedUserDefinedToolSpec.d.ts +7 -1
- package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +1 -1
- package/dist/api/resources/empathicVoice/types/ProsodyInference.d.ts +3 -1
- package/dist/api/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +4 -3
- package/dist/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/ReturnBuiltinToolToolType.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnChat.d.ts +20 -8
- package/dist/api/resources/empathicVoice/types/ReturnChatEvent.d.ts +38 -9
- package/dist/api/resources/empathicVoice/types/ReturnChatEventRole.d.ts +21 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatEventRole.js +12 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatEventType.d.ts +27 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatEventType.js +14 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroup.d.ts +5 -5
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +19 -7
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.ts +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +38 -14
- package/dist/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.ts +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.ts +27 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatPagedEventsStatus.js +14 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatStatus.d.ts +27 -0
- package/dist/api/resources/empathicVoice/types/ReturnChatStatus.js +14 -0
- package/dist/api/resources/empathicVoice/types/ReturnConfig.d.ts +23 -6
- package/dist/api/resources/empathicVoice/types/ReturnConfigSpec.d.ts +8 -2
- package/dist/api/resources/empathicVoice/types/ReturnEllmModel.d.ts +5 -1
- package/dist/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts +6 -2
- package/dist/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +16 -2
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +9 -4
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.d.ts +15 -0
- package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelProvider.js +14 -0
- package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +18 -6
- package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.ts +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnPagedChats.d.ts +18 -6
- package/dist/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.ts +13 -0
- package/dist/api/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts +12 -4
- package/dist/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts +12 -4
- package/dist/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts +12 -4
- package/dist/api/resources/empathicVoice/types/ReturnPrompt.d.ts +21 -8
- package/dist/api/resources/empathicVoice/types/ReturnPromptVersionType.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/ReturnPromptVersionType.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts +6 -2
- package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +13 -1
- package/dist/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +22 -11
- package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts +11 -0
- package/dist/api/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js +10 -0
- package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +4 -3
- package/dist/api/resources/empathicVoice/types/ReturnVoiceName.d.ts +12 -0
- package/dist/api/resources/empathicVoice/types/ReturnVoiceName.js +11 -0
- package/dist/api/resources/empathicVoice/types/index.d.ts +14 -0
- package/dist/api/resources/empathicVoice/types/index.js +14 -0
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.d.ts +4 -4
- package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +11 -19
- package/dist/api/resources/expressionMeasurement/resources/batch/client/requests/BatchListJobsRequest.d.ts +25 -9
- package/dist/api/resources/expressionMeasurement/resources/batch/client/requests/BatchStartInferenceJobFromLocalFileRequest.d.ts +1 -0
- package/{api/resources/expressionMeasurement/types/UnionJobJobTraining.d.ts → dist/api/resources/expressionMeasurement/types/CustomModelsInferenceJob.d.ts} +2 -1
- package/{api/resources/expressionMeasurement/types/UnionJobJobTlInference.d.ts → dist/api/resources/expressionMeasurement/types/CustomModelsTrainingJob.d.ts} +2 -1
- package/dist/api/resources/expressionMeasurement/types/EmbeddingGenerationJob.d.ts +7 -0
- package/dist/api/resources/expressionMeasurement/types/Face.d.ts +5 -0
- package/dist/api/resources/expressionMeasurement/types/File_.d.ts +3 -0
- package/dist/api/resources/expressionMeasurement/types/Granularity.d.ts +9 -1
- package/dist/api/resources/expressionMeasurement/types/InferenceBaseRequest.d.ts +6 -1
- package/dist/api/resources/expressionMeasurement/types/InferenceJob.d.ts +12 -0
- package/dist/api/resources/expressionMeasurement/types/JobInference.d.ts +3 -0
- package/dist/api/resources/expressionMeasurement/types/Language.d.ts +5 -0
- package/dist/api/resources/expressionMeasurement/types/Models.d.ts +3 -0
- package/dist/api/resources/expressionMeasurement/types/Ner.d.ts +5 -0
- package/dist/api/resources/expressionMeasurement/types/Prosody.d.ts +5 -0
- package/dist/api/resources/expressionMeasurement/types/Transcription.d.ts +40 -0
- package/dist/api/resources/expressionMeasurement/types/UnionJob.d.ts +1 -15
- package/dist/api/resources/expressionMeasurement/types/UnionPredictResult.d.ts +1 -1
- package/dist/api/resources/expressionMeasurement/types/Window.d.ts +5 -0
- package/dist/api/resources/expressionMeasurement/types/index.d.ts +4 -4
- package/dist/api/resources/expressionMeasurement/types/index.js +4 -4
- package/dist/api/resources/index.d.ts +1 -1
- package/dist/api/resources/index.js +2 -2
- package/dist/core/index.d.ts +1 -0
- package/dist/core/index.js +1 -0
- package/dist/core/pagination/Page.d.ts +29 -0
- package/dist/core/pagination/Page.js +94 -0
- package/dist/core/pagination/Pageable.d.ts +12 -0
- package/dist/core/pagination/Pageable.js +10 -0
- package/dist/core/pagination/index.d.ts +2 -0
- package/dist/core/pagination/index.js +7 -0
- package/dist/errors/HumeError.js +1 -1
- package/dist/serialization/resources/empathicVoice/types/JsonMessage.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/JsonMessage.js +2 -0
- package/dist/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +2 -0
- package/dist/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.js +2 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnBuiltinTool.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.ts +10 -0
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobTraining.js → dist/serialization/resources/empathicVoice/types/ReturnBuiltinToolToolType.js} +2 -3
- package/dist/serialization/resources/empathicVoice/types/ReturnChat.d.ts +2 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnChat.js +2 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +4 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnChatEvent.js +4 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnChatEventRole.d.ts +10 -0
- package/dist/serialization/resources/{expressionMeasurement/types/UnionJobJobTraining.js → empathicVoice/types/ReturnChatEventRole.js} +2 -3
- package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatEventType.js +38 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +4 -3
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +4 -3
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatPagedEventsStatus.js +38 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatStatus.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnChatStatus.js +38 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +2 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.js +2 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelProvider.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelProvider.js +38 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChats.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChats.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPrompt.js +2 -1
- package/dist/serialization/resources/empathicVoice/types/ReturnPromptVersionType.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnPromptVersionType.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +4 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.js +4 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +3 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnVoice.js +3 -2
- package/dist/serialization/resources/empathicVoice/types/ReturnVoiceName.d.ts +10 -0
- package/dist/serialization/resources/empathicVoice/types/ReturnVoiceName.js +31 -0
- package/dist/serialization/resources/empathicVoice/types/index.d.ts +14 -0
- package/dist/serialization/resources/empathicVoice/types/index.js +14 -0
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobTlInference.d.ts → dist/serialization/resources/expressionMeasurement/types/CustomModelsInferenceJob.d.ts} +3 -2
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobTlInference.js → dist/serialization/resources/expressionMeasurement/types/CustomModelsInferenceJob.js} +6 -2
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobTraining.d.ts → dist/serialization/resources/expressionMeasurement/types/CustomModelsTrainingJob.d.ts} +3 -2
- package/dist/serialization/resources/expressionMeasurement/types/CustomModelsTrainingJob.js +36 -0
- package/dist/serialization/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.d.ts → EmbeddingGenerationJob.d.ts} +3 -2
- package/dist/serialization/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.js → EmbeddingGenerationJob.js} +6 -2
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobInference.d.ts → dist/serialization/resources/expressionMeasurement/types/InferenceJob.d.ts} +3 -2
- package/{serialization/resources/expressionMeasurement/types/UnionJobJobInference.js → dist/serialization/resources/expressionMeasurement/types/InferenceJob.js} +6 -2
- package/dist/serialization/resources/expressionMeasurement/types/UnionJob.d.ts +3 -18
- package/dist/serialization/resources/expressionMeasurement/types/UnionJob.js +2 -39
- package/dist/serialization/resources/expressionMeasurement/types/UnionPredictResult.d.ts +2 -3
- package/dist/serialization/resources/expressionMeasurement/types/UnionPredictResult.js +1 -29
- package/dist/serialization/resources/expressionMeasurement/types/index.d.ts +4 -4
- package/dist/serialization/resources/expressionMeasurement/types/index.js +4 -4
- package/dist/serialization/resources/index.d.ts +1 -1
- package/dist/serialization/resources/index.js +2 -2
- package/errors/HumeError.js +1 -1
- package/eslint.config.mjs +1 -1
- package/{jest.config.mjs → jest.config.js} +1 -3
- package/package.json +2 -2
- package/reference.md +608 -502
- package/serialization/resources/empathicVoice/types/JsonMessage.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/JsonMessage.js +2 -0
- package/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.d.ts +2 -0
- package/serialization/resources/empathicVoice/types/PostedEventMessageSpecs.js +2 -0
- package/serialization/resources/empathicVoice/types/ReturnBuiltinTool.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnBuiltinTool.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnBuiltinToolToolType.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnBuiltinToolToolType.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChat.d.ts +2 -2
- package/serialization/resources/empathicVoice/types/ReturnChat.js +2 -2
- package/serialization/resources/empathicVoice/types/ReturnChatEvent.d.ts +4 -2
- package/serialization/resources/empathicVoice/types/ReturnChatEvent.js +4 -2
- package/serialization/resources/empathicVoice/types/ReturnChatEventRole.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatEventRole.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChatEventType.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatEventType.js +38 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEvents.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedEventsPaginationDirection.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.d.ts +4 -3
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEvents.js +4 -3
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEventsPaginationDirection.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEventsStatus.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatPagedEventsStatus.js +38 -0
- package/serialization/resources/empathicVoice/types/ReturnChatStatus.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnChatStatus.js +38 -0
- package/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts +2 -0
- package/serialization/resources/empathicVoice/types/ReturnEventMessageSpecs.js +2 -0
- package/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelProvider.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelProvider.js +38 -0
- package/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPagedChatGroups.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnPagedChatGroupsPaginationDirection.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnPagedChats.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPagedChats.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnPagedChatsPaginationDirection.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnPrompt.d.ts +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPrompt.js +2 -1
- package/serialization/resources/empathicVoice/types/ReturnPromptVersionType.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnPromptVersionType.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts +4 -2
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedTool.js +4 -2
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedToolToolType.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedToolToolType.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnUserDefinedToolVersionType.js +31 -0
- package/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +3 -2
- package/serialization/resources/empathicVoice/types/ReturnVoice.js +3 -2
- package/serialization/resources/empathicVoice/types/ReturnVoiceName.d.ts +10 -0
- package/serialization/resources/empathicVoice/types/ReturnVoiceName.js +31 -0
- package/serialization/resources/empathicVoice/types/index.d.ts +14 -0
- package/serialization/resources/empathicVoice/types/index.js +14 -0
- package/{dist/serialization/resources/expressionMeasurement/types/UnionJobJobTlInference.d.ts → serialization/resources/expressionMeasurement/types/CustomModelsInferenceJob.d.ts} +3 -2
- package/{dist/serialization/resources/expressionMeasurement/types/UnionJobJobTlInference.js → serialization/resources/expressionMeasurement/types/CustomModelsInferenceJob.js} +6 -2
- package/{dist/serialization/resources/expressionMeasurement/types/UnionJobJobTraining.d.ts → serialization/resources/expressionMeasurement/types/CustomModelsTrainingJob.d.ts} +3 -2
- package/serialization/resources/expressionMeasurement/types/CustomModelsTrainingJob.js +36 -0
- package/serialization/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.d.ts → EmbeddingGenerationJob.d.ts} +3 -2
- package/serialization/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.js → EmbeddingGenerationJob.js} +6 -2
- package/{dist/serialization/resources/expressionMeasurement/types/UnionJobJobInference.d.ts → serialization/resources/expressionMeasurement/types/InferenceJob.d.ts} +3 -2
- package/{dist/serialization/resources/expressionMeasurement/types/UnionJobJobInference.js → serialization/resources/expressionMeasurement/types/InferenceJob.js} +6 -2
- package/serialization/resources/expressionMeasurement/types/UnionJob.d.ts +3 -18
- package/serialization/resources/expressionMeasurement/types/UnionJob.js +2 -39
- package/serialization/resources/expressionMeasurement/types/UnionPredictResult.d.ts +2 -3
- package/serialization/resources/expressionMeasurement/types/UnionPredictResult.js +1 -29
- package/serialization/resources/expressionMeasurement/types/index.d.ts +4 -4
- package/serialization/resources/expressionMeasurement/types/index.js +4 -4
- package/serialization/resources/index.d.ts +1 -1
- package/serialization/resources/index.js +2 -2
- package/dist/api/resources/expressionMeasurement/types/UnionJobJobEmbeddingGeneration.d.ts +0 -6
- package/dist/api/resources/expressionMeasurement/types/UnionJobJobInference.d.ts +0 -6
- package/dist/api/resources/expressionMeasurement/types/UnionJobJobTlInference.d.ts +0 -6
- package/dist/api/resources/expressionMeasurement/types/UnionJobJobTraining.d.ts +0 -6
- /package/api/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.js → CustomModelsInferenceJob.js} +0 -0
- /package/api/resources/expressionMeasurement/types/{UnionJobJobInference.js → CustomModelsTrainingJob.js} +0 -0
- /package/api/resources/expressionMeasurement/types/{UnionJobJobTlInference.js → EmbeddingGenerationJob.js} +0 -0
- /package/api/resources/expressionMeasurement/types/{UnionJobJobTraining.js → InferenceJob.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/types/{UnionJobJobEmbeddingGeneration.js → CustomModelsInferenceJob.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/types/{UnionJobJobInference.js → CustomModelsTrainingJob.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/types/{UnionJobJobTlInference.js → EmbeddingGenerationJob.js} +0 -0
- /package/dist/api/resources/expressionMeasurement/types/{UnionJobJobTraining.js → InferenceJob.js} +0 -0
package/reference.md
CHANGED
|
@@ -1,11 +1,31 @@
|
|
|
1
|
-
##
|
|
1
|
+
## ExpressionMeasurement Batch
|
|
2
|
+
|
|
3
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code> </summary>
|
|
4
|
+
|
|
5
|
+
<dl>
|
|
6
|
+
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
2
12
|
|
|
3
|
-
<
|
|
13
|
+
<dd>
|
|
4
14
|
|
|
5
15
|
<dl>
|
|
6
16
|
|
|
7
17
|
<dd>
|
|
8
18
|
|
|
19
|
+
Sort and filter jobs.
|
|
20
|
+
|
|
21
|
+
</dd>
|
|
22
|
+
|
|
23
|
+
</dl>
|
|
24
|
+
|
|
25
|
+
</dd>
|
|
26
|
+
|
|
27
|
+
</dl>
|
|
28
|
+
|
|
9
29
|
#### 🔌 Usage
|
|
10
30
|
|
|
11
31
|
<dl>
|
|
@@ -17,10 +37,7 @@
|
|
|
17
37
|
<dd>
|
|
18
38
|
|
|
19
39
|
```ts
|
|
20
|
-
await client.
|
|
21
|
-
pageNumber: 0,
|
|
22
|
-
pageSize: 2,
|
|
23
|
-
});
|
|
40
|
+
await client.expressionMeasurement.batch.listJobs();
|
|
24
41
|
```
|
|
25
42
|
|
|
26
43
|
</dd>
|
|
@@ -41,7 +58,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
41
58
|
|
|
42
59
|
<dd>
|
|
43
60
|
|
|
44
|
-
**request: `Hume.
|
|
61
|
+
**request: `Hume.expressionMeasurement.BatchListJobsRequest`**
|
|
45
62
|
|
|
46
63
|
</dd>
|
|
47
64
|
|
|
@@ -51,7 +68,7 @@ await client.empathicVoice.tools.listTools({
|
|
|
51
68
|
|
|
52
69
|
<dd>
|
|
53
70
|
|
|
54
|
-
**requestOptions: `
|
|
71
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
55
72
|
|
|
56
73
|
</dd>
|
|
57
74
|
|
|
@@ -66,12 +83,32 @@ await client.empathicVoice.tools.listTools({
|
|
|
66
83
|
</dl>
|
|
67
84
|
</details>
|
|
68
85
|
|
|
69
|
-
<details><summary> <code>client.
|
|
86
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">startInferenceJob</a>({ ...params }) -> Hume.JobId</code> </summary>
|
|
87
|
+
|
|
88
|
+
<dl>
|
|
89
|
+
|
|
90
|
+
<dd>
|
|
91
|
+
|
|
92
|
+
#### 📝 Description
|
|
93
|
+
|
|
94
|
+
<dl>
|
|
95
|
+
|
|
96
|
+
<dd>
|
|
70
97
|
|
|
71
98
|
<dl>
|
|
72
99
|
|
|
73
100
|
<dd>
|
|
74
101
|
|
|
102
|
+
Start a new measurement inference job.
|
|
103
|
+
|
|
104
|
+
</dd>
|
|
105
|
+
|
|
106
|
+
</dl>
|
|
107
|
+
|
|
108
|
+
</dd>
|
|
109
|
+
|
|
110
|
+
</dl>
|
|
111
|
+
|
|
75
112
|
#### 🔌 Usage
|
|
76
113
|
|
|
77
114
|
<dl>
|
|
@@ -83,14 +120,9 @@ await client.empathicVoice.tools.listTools({
|
|
|
83
120
|
<dd>
|
|
84
121
|
|
|
85
122
|
```ts
|
|
86
|
-
await client.
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
'{ "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"] }',
|
|
90
|
-
versionDescription:
|
|
91
|
-
'Fetches current weather and uses celsius or fahrenheit based on location of user.',
|
|
92
|
-
description: 'This tool is for getting the current weather.',
|
|
93
|
-
fallbackContent: 'Unable to fetch current weather.',
|
|
123
|
+
await client.expressionMeasurement.batch.startInferenceJob({
|
|
124
|
+
urls: ['https://hume-tutorials.s3.amazonaws.com/faces.zip'],
|
|
125
|
+
notify: true,
|
|
94
126
|
});
|
|
95
127
|
```
|
|
96
128
|
|
|
@@ -112,7 +144,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
112
144
|
|
|
113
145
|
<dd>
|
|
114
146
|
|
|
115
|
-
**request: `Hume.
|
|
147
|
+
**request: `Hume.InferenceBaseRequest`**
|
|
116
148
|
|
|
117
149
|
</dd>
|
|
118
150
|
|
|
@@ -122,7 +154,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
122
154
|
|
|
123
155
|
<dd>
|
|
124
156
|
|
|
125
|
-
**requestOptions: `
|
|
157
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
126
158
|
|
|
127
159
|
</dd>
|
|
128
160
|
|
|
@@ -137,13 +169,13 @@ await client.empathicVoice.tools.createTool({
|
|
|
137
169
|
</dl>
|
|
138
170
|
</details>
|
|
139
171
|
|
|
140
|
-
<details><summary> <code>client.
|
|
172
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobDetails</a>(id) -> Hume.UnionJob</code> </summary>
|
|
141
173
|
|
|
142
174
|
<dl>
|
|
143
175
|
|
|
144
176
|
<dd>
|
|
145
177
|
|
|
146
|
-
####
|
|
178
|
+
#### 📝 Description
|
|
147
179
|
|
|
148
180
|
<dl>
|
|
149
181
|
|
|
@@ -153,11 +185,7 @@ await client.empathicVoice.tools.createTool({
|
|
|
153
185
|
|
|
154
186
|
<dd>
|
|
155
187
|
|
|
156
|
-
|
|
157
|
-
await client.empathicVoice.tools.listToolVersions(
|
|
158
|
-
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
159
|
-
);
|
|
160
|
-
```
|
|
188
|
+
Get the request details and state of a given job.
|
|
161
189
|
|
|
162
190
|
</dd>
|
|
163
191
|
|
|
@@ -167,7 +195,7 @@ await client.empathicVoice.tools.listToolVersions(
|
|
|
167
195
|
|
|
168
196
|
</dl>
|
|
169
197
|
|
|
170
|
-
####
|
|
198
|
+
#### 🔌 Usage
|
|
171
199
|
|
|
172
200
|
<dl>
|
|
173
201
|
|
|
@@ -177,17 +205,29 @@ await client.empathicVoice.tools.listToolVersions(
|
|
|
177
205
|
|
|
178
206
|
<dd>
|
|
179
207
|
|
|
180
|
-
|
|
208
|
+
```ts
|
|
209
|
+
await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
</dd>
|
|
213
|
+
|
|
214
|
+
</dl>
|
|
181
215
|
|
|
182
216
|
</dd>
|
|
183
217
|
|
|
184
218
|
</dl>
|
|
185
219
|
|
|
220
|
+
#### ⚙️ Parameters
|
|
221
|
+
|
|
186
222
|
<dl>
|
|
187
223
|
|
|
188
224
|
<dd>
|
|
189
225
|
|
|
190
|
-
|
|
226
|
+
<dl>
|
|
227
|
+
|
|
228
|
+
<dd>
|
|
229
|
+
|
|
230
|
+
**id: `string`** — The unique identifier for the job.
|
|
191
231
|
|
|
192
232
|
</dd>
|
|
193
233
|
|
|
@@ -197,7 +237,7 @@ await client.empathicVoice.tools.listToolVersions(
|
|
|
197
237
|
|
|
198
238
|
<dd>
|
|
199
239
|
|
|
200
|
-
**requestOptions: `
|
|
240
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
201
241
|
|
|
202
242
|
</dd>
|
|
203
243
|
|
|
@@ -212,13 +252,13 @@ await client.empathicVoice.tools.listToolVersions(
|
|
|
212
252
|
</dl>
|
|
213
253
|
</details>
|
|
214
254
|
|
|
215
|
-
<details><summary> <code>client.
|
|
255
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobPredictions</a>(id) -> Hume.UnionPredictResult[]</code> </summary>
|
|
216
256
|
|
|
217
257
|
<dl>
|
|
218
258
|
|
|
219
259
|
<dd>
|
|
220
260
|
|
|
221
|
-
####
|
|
261
|
+
#### 📝 Description
|
|
222
262
|
|
|
223
263
|
<dl>
|
|
224
264
|
|
|
@@ -228,19 +268,7 @@ await client.empathicVoice.tools.listToolVersions(
|
|
|
228
268
|
|
|
229
269
|
<dd>
|
|
230
270
|
|
|
231
|
-
|
|
232
|
-
await client.empathicVoice.tools.createToolVersion(
|
|
233
|
-
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
234
|
-
{
|
|
235
|
-
parameters:
|
|
236
|
-
'{ "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"] }',
|
|
237
|
-
versionDescription:
|
|
238
|
-
'Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.',
|
|
239
|
-
fallbackContent: 'Unable to fetch current weather.',
|
|
240
|
-
description: 'This tool is for getting the current weather.',
|
|
241
|
-
},
|
|
242
|
-
);
|
|
243
|
-
```
|
|
271
|
+
Get the JSON predictions of a completed inference job.
|
|
244
272
|
|
|
245
273
|
</dd>
|
|
246
274
|
|
|
@@ -250,7 +278,7 @@ await client.empathicVoice.tools.createToolVersion(
|
|
|
250
278
|
|
|
251
279
|
</dl>
|
|
252
280
|
|
|
253
|
-
####
|
|
281
|
+
#### 🔌 Usage
|
|
254
282
|
|
|
255
283
|
<dl>
|
|
256
284
|
|
|
@@ -260,17 +288,29 @@ await client.empathicVoice.tools.createToolVersion(
|
|
|
260
288
|
|
|
261
289
|
<dd>
|
|
262
290
|
|
|
263
|
-
|
|
291
|
+
```ts
|
|
292
|
+
await client.expressionMeasurement.batch.getJobPredictions('job_id');
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
</dd>
|
|
296
|
+
|
|
297
|
+
</dl>
|
|
264
298
|
|
|
265
299
|
</dd>
|
|
266
300
|
|
|
267
301
|
</dl>
|
|
268
302
|
|
|
303
|
+
#### ⚙️ Parameters
|
|
304
|
+
|
|
269
305
|
<dl>
|
|
270
306
|
|
|
271
307
|
<dd>
|
|
272
308
|
|
|
273
|
-
|
|
309
|
+
<dl>
|
|
310
|
+
|
|
311
|
+
<dd>
|
|
312
|
+
|
|
313
|
+
**id: `string`** — The unique identifier for the job.
|
|
274
314
|
|
|
275
315
|
</dd>
|
|
276
316
|
|
|
@@ -280,7 +320,7 @@ await client.empathicVoice.tools.createToolVersion(
|
|
|
280
320
|
|
|
281
321
|
<dd>
|
|
282
322
|
|
|
283
|
-
**requestOptions: `
|
|
323
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
284
324
|
|
|
285
325
|
</dd>
|
|
286
326
|
|
|
@@ -295,13 +335,13 @@ await client.empathicVoice.tools.createToolVersion(
|
|
|
295
335
|
</dl>
|
|
296
336
|
</details>
|
|
297
337
|
|
|
298
|
-
<details><summary> <code>client.
|
|
338
|
+
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">getJobArtifacts</a>(id) -> stream.Readable</code> </summary>
|
|
299
339
|
|
|
300
340
|
<dl>
|
|
301
341
|
|
|
302
342
|
<dd>
|
|
303
343
|
|
|
304
|
-
####
|
|
344
|
+
#### 📝 Description
|
|
305
345
|
|
|
306
346
|
<dl>
|
|
307
347
|
|
|
@@ -311,11 +351,7 @@ await client.empathicVoice.tools.createToolVersion(
|
|
|
311
351
|
|
|
312
352
|
<dd>
|
|
313
353
|
|
|
314
|
-
|
|
315
|
-
await client.empathicVoice.tools.deleteTool(
|
|
316
|
-
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
317
|
-
);
|
|
318
|
-
```
|
|
354
|
+
Get the artifacts ZIP of a completed inference job.
|
|
319
355
|
|
|
320
356
|
</dd>
|
|
321
357
|
|
|
@@ -325,27 +361,19 @@ await client.empathicVoice.tools.deleteTool(
|
|
|
325
361
|
|
|
326
362
|
</dl>
|
|
327
363
|
|
|
328
|
-
####
|
|
329
|
-
|
|
330
|
-
<dl>
|
|
331
|
-
|
|
332
|
-
<dd>
|
|
364
|
+
#### 🔌 Usage
|
|
333
365
|
|
|
334
366
|
<dl>
|
|
335
367
|
|
|
336
368
|
<dd>
|
|
337
369
|
|
|
338
|
-
**id: `string`** — Identifier for a tool. Formatted as a UUID.
|
|
339
|
-
|
|
340
|
-
</dd>
|
|
341
|
-
|
|
342
|
-
</dl>
|
|
343
|
-
|
|
344
370
|
<dl>
|
|
345
371
|
|
|
346
372
|
<dd>
|
|
347
373
|
|
|
348
|
-
|
|
374
|
+
```ts
|
|
375
|
+
await client.expressionMeasurement.batch.getJobArtifacts('string');
|
|
376
|
+
```
|
|
349
377
|
|
|
350
378
|
</dd>
|
|
351
379
|
|
|
@@ -355,35 +383,27 @@ await client.empathicVoice.tools.deleteTool(
|
|
|
355
383
|
|
|
356
384
|
</dl>
|
|
357
385
|
|
|
358
|
-
|
|
386
|
+
#### ⚙️ Parameters
|
|
359
387
|
|
|
360
|
-
|
|
361
|
-
</details>
|
|
388
|
+
<dl>
|
|
362
389
|
|
|
363
|
-
<
|
|
390
|
+
<dd>
|
|
364
391
|
|
|
365
392
|
<dl>
|
|
366
393
|
|
|
367
394
|
<dd>
|
|
368
395
|
|
|
369
|
-
|
|
396
|
+
**id: `string`** — The unique identifier for the job.
|
|
370
397
|
|
|
371
|
-
|
|
398
|
+
</dd>
|
|
372
399
|
|
|
373
|
-
|
|
400
|
+
</dl>
|
|
374
401
|
|
|
375
402
|
<dl>
|
|
376
403
|
|
|
377
404
|
<dd>
|
|
378
405
|
|
|
379
|
-
|
|
380
|
-
await client.empathicVoice.tools.updateToolName(
|
|
381
|
-
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
382
|
-
{
|
|
383
|
-
name: 'get_current_temperature',
|
|
384
|
-
},
|
|
385
|
-
);
|
|
386
|
-
```
|
|
406
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
387
407
|
|
|
388
408
|
</dd>
|
|
389
409
|
|
|
@@ -393,41 +413,28 @@ await client.empathicVoice.tools.updateToolName(
|
|
|
393
413
|
|
|
394
414
|
</dl>
|
|
395
415
|
|
|
396
|
-
|
|
416
|
+
</dd>
|
|
397
417
|
|
|
398
|
-
|
|
418
|
+
</dl>
|
|
419
|
+
</details>
|
|
399
420
|
|
|
400
|
-
<
|
|
421
|
+
<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>
|
|
401
422
|
|
|
402
423
|
<dl>
|
|
403
424
|
|
|
404
425
|
<dd>
|
|
405
426
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
</dd>
|
|
409
|
-
|
|
410
|
-
</dl>
|
|
427
|
+
#### 📝 Description
|
|
411
428
|
|
|
412
429
|
<dl>
|
|
413
430
|
|
|
414
431
|
<dd>
|
|
415
432
|
|
|
416
|
-
**request: `Hume.empathicVoice.PostedUserDefinedToolName`**
|
|
417
|
-
|
|
418
|
-
</dd>
|
|
419
|
-
|
|
420
|
-
</dl>
|
|
421
|
-
|
|
422
433
|
<dl>
|
|
423
434
|
|
|
424
435
|
<dd>
|
|
425
436
|
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
</dd>
|
|
429
|
-
|
|
430
|
-
</dl>
|
|
437
|
+
Start a new batch inference job.
|
|
431
438
|
|
|
432
439
|
</dd>
|
|
433
440
|
|
|
@@ -436,13 +443,6 @@ await client.empathicVoice.tools.updateToolName(
|
|
|
436
443
|
</dd>
|
|
437
444
|
|
|
438
445
|
</dl>
|
|
439
|
-
</details>
|
|
440
|
-
|
|
441
|
-
<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>
|
|
442
|
-
|
|
443
|
-
<dl>
|
|
444
|
-
|
|
445
|
-
<dd>
|
|
446
446
|
|
|
447
447
|
#### 🔌 Usage
|
|
448
448
|
|
|
@@ -455,9 +455,9 @@ await client.empathicVoice.tools.updateToolName(
|
|
|
455
455
|
<dd>
|
|
456
456
|
|
|
457
457
|
```ts
|
|
458
|
-
await client.
|
|
459
|
-
'
|
|
460
|
-
|
|
458
|
+
await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
459
|
+
[fs.createReadStream('/path/to/your/file')],
|
|
460
|
+
{},
|
|
461
461
|
);
|
|
462
462
|
```
|
|
463
463
|
|
|
@@ -479,7 +479,7 @@ await client.empathicVoice.tools.getToolVersion(
|
|
|
479
479
|
|
|
480
480
|
<dd>
|
|
481
481
|
|
|
482
|
-
**
|
|
482
|
+
**file: `File[] | fs.ReadStream[]`**
|
|
483
483
|
|
|
484
484
|
</dd>
|
|
485
485
|
|
|
@@ -489,7 +489,7 @@ await client.empathicVoice.tools.getToolVersion(
|
|
|
489
489
|
|
|
490
490
|
<dd>
|
|
491
491
|
|
|
492
|
-
**
|
|
492
|
+
**request: `Hume.expressionMeasurement.BatchStartInferenceJobFromLocalFileRequest`**
|
|
493
493
|
|
|
494
494
|
</dd>
|
|
495
495
|
|
|
@@ -499,7 +499,7 @@ await client.empathicVoice.tools.getToolVersion(
|
|
|
499
499
|
|
|
500
500
|
<dd>
|
|
501
501
|
|
|
502
|
-
**requestOptions: `
|
|
502
|
+
**requestOptions: `Batch.RequestOptions`**
|
|
503
503
|
|
|
504
504
|
</dd>
|
|
505
505
|
|
|
@@ -514,7 +514,9 @@ await client.empathicVoice.tools.getToolVersion(
|
|
|
514
514
|
</dl>
|
|
515
515
|
</details>
|
|
516
516
|
|
|
517
|
-
|
|
517
|
+
## EmpathicVoice Tools
|
|
518
|
+
|
|
519
|
+
<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>
|
|
518
520
|
|
|
519
521
|
<dl>
|
|
520
522
|
|
|
@@ -531,10 +533,10 @@ await client.empathicVoice.tools.getToolVersion(
|
|
|
531
533
|
<dd>
|
|
532
534
|
|
|
533
535
|
```ts
|
|
534
|
-
await client.empathicVoice.tools.
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
);
|
|
536
|
+
await client.empathicVoice.tools.listTools({
|
|
537
|
+
pageNumber: 0,
|
|
538
|
+
pageSize: 2,
|
|
539
|
+
});
|
|
538
540
|
```
|
|
539
541
|
|
|
540
542
|
</dd>
|
|
@@ -555,17 +557,7 @@ await client.empathicVoice.tools.deleteToolVersion(
|
|
|
555
557
|
|
|
556
558
|
<dd>
|
|
557
559
|
|
|
558
|
-
**
|
|
559
|
-
|
|
560
|
-
</dd>
|
|
561
|
-
|
|
562
|
-
</dl>
|
|
563
|
-
|
|
564
|
-
<dl>
|
|
565
|
-
|
|
566
|
-
<dd>
|
|
567
|
-
|
|
568
|
-
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
560
|
+
**request: `Hume.empathicVoice.ToolsListToolsRequest`**
|
|
569
561
|
|
|
570
562
|
</dd>
|
|
571
563
|
|
|
@@ -590,7 +582,7 @@ await client.empathicVoice.tools.deleteToolVersion(
|
|
|
590
582
|
</dl>
|
|
591
583
|
</details>
|
|
592
584
|
|
|
593
|
-
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">
|
|
585
|
+
<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>
|
|
594
586
|
|
|
595
587
|
<dl>
|
|
596
588
|
|
|
@@ -607,14 +599,15 @@ await client.empathicVoice.tools.deleteToolVersion(
|
|
|
607
599
|
<dd>
|
|
608
600
|
|
|
609
601
|
```ts
|
|
610
|
-
await client.empathicVoice.tools.
|
|
611
|
-
'
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
602
|
+
await client.empathicVoice.tools.createTool({
|
|
603
|
+
name: 'get_current_weather',
|
|
604
|
+
parameters:
|
|
605
|
+
'{ "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"] }',
|
|
606
|
+
versionDescription:
|
|
607
|
+
'Fetches current weather and uses celsius or fahrenheit based on location of user.',
|
|
608
|
+
description: 'This tool is for getting the current weather.',
|
|
609
|
+
fallbackContent: 'Unable to fetch current weather.',
|
|
610
|
+
});
|
|
618
611
|
```
|
|
619
612
|
|
|
620
613
|
</dd>
|
|
@@ -635,27 +628,7 @@ await client.empathicVoice.tools.updateToolDescription(
|
|
|
635
628
|
|
|
636
629
|
<dd>
|
|
637
630
|
|
|
638
|
-
**
|
|
639
|
-
|
|
640
|
-
</dd>
|
|
641
|
-
|
|
642
|
-
</dl>
|
|
643
|
-
|
|
644
|
-
<dl>
|
|
645
|
-
|
|
646
|
-
<dd>
|
|
647
|
-
|
|
648
|
-
**version: `number`** — Version number for a tool. Version numbers should be integers.
|
|
649
|
-
|
|
650
|
-
</dd>
|
|
651
|
-
|
|
652
|
-
</dl>
|
|
653
|
-
|
|
654
|
-
<dl>
|
|
655
|
-
|
|
656
|
-
<dd>
|
|
657
|
-
|
|
658
|
-
**request: `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`**
|
|
631
|
+
**request: `Hume.empathicVoice.PostedUserDefinedTool`**
|
|
659
632
|
|
|
660
633
|
</dd>
|
|
661
634
|
|
|
@@ -680,9 +653,7 @@ await client.empathicVoice.tools.updateToolDescription(
|
|
|
680
653
|
</dl>
|
|
681
654
|
</details>
|
|
682
655
|
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">listPrompts</a>({ ...params }) -> Hume.ReturnPagedPrompts</code> </summary>
|
|
656
|
+
<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>
|
|
686
657
|
|
|
687
658
|
<dl>
|
|
688
659
|
|
|
@@ -699,7 +670,9 @@ await client.empathicVoice.tools.updateToolDescription(
|
|
|
699
670
|
<dd>
|
|
700
671
|
|
|
701
672
|
```ts
|
|
702
|
-
await client.empathicVoice.
|
|
673
|
+
await client.empathicVoice.tools.listToolVersions(
|
|
674
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
675
|
+
);
|
|
703
676
|
```
|
|
704
677
|
|
|
705
678
|
</dd>
|
|
@@ -720,7 +693,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
720
693
|
|
|
721
694
|
<dd>
|
|
722
695
|
|
|
723
|
-
**
|
|
696
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
724
697
|
|
|
725
698
|
</dd>
|
|
726
699
|
|
|
@@ -730,7 +703,17 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
730
703
|
|
|
731
704
|
<dd>
|
|
732
705
|
|
|
733
|
-
**
|
|
706
|
+
**request: `Hume.empathicVoice.ToolsListToolVersionsRequest`**
|
|
707
|
+
|
|
708
|
+
</dd>
|
|
709
|
+
|
|
710
|
+
</dl>
|
|
711
|
+
|
|
712
|
+
<dl>
|
|
713
|
+
|
|
714
|
+
<dd>
|
|
715
|
+
|
|
716
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
734
717
|
|
|
735
718
|
</dd>
|
|
736
719
|
|
|
@@ -745,7 +728,7 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
745
728
|
</dl>
|
|
746
729
|
</details>
|
|
747
730
|
|
|
748
|
-
<details><summary> <code>client.empathicVoice.
|
|
731
|
+
<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>
|
|
749
732
|
|
|
750
733
|
<dl>
|
|
751
734
|
|
|
@@ -762,10 +745,17 @@ await client.empathicVoice.prompts.listPrompts();
|
|
|
762
745
|
<dd>
|
|
763
746
|
|
|
764
747
|
```ts
|
|
765
|
-
await client.empathicVoice.
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
748
|
+
await client.empathicVoice.tools.createToolVersion(
|
|
749
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
750
|
+
{
|
|
751
|
+
parameters:
|
|
752
|
+
'{ "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"] }',
|
|
753
|
+
versionDescription:
|
|
754
|
+
'Fetches current weather and uses celsius, fahrenheit, or kelvin based on location of user.',
|
|
755
|
+
fallbackContent: 'Unable to fetch current weather.',
|
|
756
|
+
description: 'This tool is for getting the current weather.',
|
|
757
|
+
},
|
|
758
|
+
);
|
|
769
759
|
```
|
|
770
760
|
|
|
771
761
|
</dd>
|
|
@@ -786,7 +776,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
786
776
|
|
|
787
777
|
<dd>
|
|
788
778
|
|
|
789
|
-
**
|
|
779
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
790
780
|
|
|
791
781
|
</dd>
|
|
792
782
|
|
|
@@ -796,7 +786,17 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
796
786
|
|
|
797
787
|
<dd>
|
|
798
788
|
|
|
799
|
-
**
|
|
789
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolVersion`**
|
|
790
|
+
|
|
791
|
+
</dd>
|
|
792
|
+
|
|
793
|
+
</dl>
|
|
794
|
+
|
|
795
|
+
<dl>
|
|
796
|
+
|
|
797
|
+
<dd>
|
|
798
|
+
|
|
799
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
800
800
|
|
|
801
801
|
</dd>
|
|
802
802
|
|
|
@@ -811,7 +811,7 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
811
811
|
</dl>
|
|
812
812
|
</details>
|
|
813
813
|
|
|
814
|
-
<details><summary> <code>client.empathicVoice.
|
|
814
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteTool</a>(id) -> void</code> </summary>
|
|
815
815
|
|
|
816
816
|
<dl>
|
|
817
817
|
|
|
@@ -828,7 +828,9 @@ await client.empathicVoice.prompts.createPrompt({
|
|
|
828
828
|
<dd>
|
|
829
829
|
|
|
830
830
|
```ts
|
|
831
|
-
await client.empathicVoice.
|
|
831
|
+
await client.empathicVoice.tools.deleteTool(
|
|
832
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
833
|
+
);
|
|
832
834
|
```
|
|
833
835
|
|
|
834
836
|
</dd>
|
|
@@ -849,17 +851,7 @@ await client.empathicVoice.prompts.listPromptVersions('id');
|
|
|
849
851
|
|
|
850
852
|
<dd>
|
|
851
853
|
|
|
852
|
-
**id: `string`** — Identifier for a
|
|
853
|
-
|
|
854
|
-
</dd>
|
|
855
|
-
|
|
856
|
-
</dl>
|
|
857
|
-
|
|
858
|
-
<dl>
|
|
859
|
-
|
|
860
|
-
<dd>
|
|
861
|
-
|
|
862
|
-
**request: `Hume.empathicVoice.PromptsListPromptVersionsRequest`**
|
|
854
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
863
855
|
|
|
864
856
|
</dd>
|
|
865
857
|
|
|
@@ -869,7 +861,7 @@ await client.empathicVoice.prompts.listPromptVersions('id');
|
|
|
869
861
|
|
|
870
862
|
<dd>
|
|
871
863
|
|
|
872
|
-
**requestOptions: `
|
|
864
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
873
865
|
|
|
874
866
|
</dd>
|
|
875
867
|
|
|
@@ -884,7 +876,7 @@ await client.empathicVoice.prompts.listPromptVersions('id');
|
|
|
884
876
|
</dl>
|
|
885
877
|
</details>
|
|
886
878
|
|
|
887
|
-
<details><summary> <code>client.empathicVoice.
|
|
879
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">updateToolName</a>(id, { ...params }) -> string</code> </summary>
|
|
888
880
|
|
|
889
881
|
<dl>
|
|
890
882
|
|
|
@@ -901,9 +893,12 @@ await client.empathicVoice.prompts.listPromptVersions('id');
|
|
|
901
893
|
<dd>
|
|
902
894
|
|
|
903
895
|
```ts
|
|
904
|
-
await client.empathicVoice.
|
|
905
|
-
|
|
906
|
-
|
|
896
|
+
await client.empathicVoice.tools.updateToolName(
|
|
897
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
898
|
+
{
|
|
899
|
+
name: 'get_current_temperature',
|
|
900
|
+
},
|
|
901
|
+
);
|
|
907
902
|
```
|
|
908
903
|
|
|
909
904
|
</dd>
|
|
@@ -924,7 +919,7 @@ await client.empathicVoice.prompts.createPromptVerison('id', {
|
|
|
924
919
|
|
|
925
920
|
<dd>
|
|
926
921
|
|
|
927
|
-
**id: `string`** — Identifier for a
|
|
922
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
928
923
|
|
|
929
924
|
</dd>
|
|
930
925
|
|
|
@@ -934,7 +929,7 @@ await client.empathicVoice.prompts.createPromptVerison('id', {
|
|
|
934
929
|
|
|
935
930
|
<dd>
|
|
936
931
|
|
|
937
|
-
**request: `Hume.empathicVoice.
|
|
932
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolName`**
|
|
938
933
|
|
|
939
934
|
</dd>
|
|
940
935
|
|
|
@@ -944,7 +939,7 @@ await client.empathicVoice.prompts.createPromptVerison('id', {
|
|
|
944
939
|
|
|
945
940
|
<dd>
|
|
946
941
|
|
|
947
|
-
**requestOptions: `
|
|
942
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
948
943
|
|
|
949
944
|
</dd>
|
|
950
945
|
|
|
@@ -959,7 +954,7 @@ await client.empathicVoice.prompts.createPromptVerison('id', {
|
|
|
959
954
|
</dl>
|
|
960
955
|
</details>
|
|
961
956
|
|
|
962
|
-
<details><summary> <code>client.empathicVoice.
|
|
957
|
+
<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>
|
|
963
958
|
|
|
964
959
|
<dl>
|
|
965
960
|
|
|
@@ -976,7 +971,10 @@ await client.empathicVoice.prompts.createPromptVerison('id', {
|
|
|
976
971
|
<dd>
|
|
977
972
|
|
|
978
973
|
```ts
|
|
979
|
-
await client.empathicVoice.
|
|
974
|
+
await client.empathicVoice.tools.getToolVersion(
|
|
975
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
976
|
+
1,
|
|
977
|
+
);
|
|
980
978
|
```
|
|
981
979
|
|
|
982
980
|
</dd>
|
|
@@ -997,7 +995,7 @@ await client.empathicVoice.prompts.deletePrompt('id');
|
|
|
997
995
|
|
|
998
996
|
<dd>
|
|
999
997
|
|
|
1000
|
-
**id: `string`** — Identifier for a
|
|
998
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
1001
999
|
|
|
1002
1000
|
</dd>
|
|
1003
1001
|
|
|
@@ -1007,7 +1005,23 @@ await client.empathicVoice.prompts.deletePrompt('id');
|
|
|
1007
1005
|
|
|
1008
1006
|
<dd>
|
|
1009
1007
|
|
|
1010
|
-
**
|
|
1008
|
+
**version: `number`**
|
|
1009
|
+
|
|
1010
|
+
Version number for a Tool.
|
|
1011
|
+
|
|
1012
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1013
|
+
|
|
1014
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1015
|
+
|
|
1016
|
+
</dd>
|
|
1017
|
+
|
|
1018
|
+
</dl>
|
|
1019
|
+
|
|
1020
|
+
<dl>
|
|
1021
|
+
|
|
1022
|
+
<dd>
|
|
1023
|
+
|
|
1024
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1011
1025
|
|
|
1012
1026
|
</dd>
|
|
1013
1027
|
|
|
@@ -1022,7 +1036,7 @@ await client.empathicVoice.prompts.deletePrompt('id');
|
|
|
1022
1036
|
</dl>
|
|
1023
1037
|
</details>
|
|
1024
1038
|
|
|
1025
|
-
<details><summary> <code>client.empathicVoice.
|
|
1039
|
+
<details><summary> <code>client.empathicVoice.tools.<a href="./src/api/resources/empathicVoice/resources/tools/client/Client.ts">deleteToolVersion</a>(id, version) -> void</code> </summary>
|
|
1026
1040
|
|
|
1027
1041
|
<dl>
|
|
1028
1042
|
|
|
@@ -1039,9 +1053,10 @@ await client.empathicVoice.prompts.deletePrompt('id');
|
|
|
1039
1053
|
<dd>
|
|
1040
1054
|
|
|
1041
1055
|
```ts
|
|
1042
|
-
await client.empathicVoice.
|
|
1043
|
-
|
|
1044
|
-
|
|
1056
|
+
await client.empathicVoice.tools.deleteToolVersion(
|
|
1057
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
1058
|
+
1,
|
|
1059
|
+
);
|
|
1045
1060
|
```
|
|
1046
1061
|
|
|
1047
1062
|
</dd>
|
|
@@ -1062,7 +1077,7 @@ await client.empathicVoice.prompts.updatePromptName('string', {
|
|
|
1062
1077
|
|
|
1063
1078
|
<dd>
|
|
1064
1079
|
|
|
1065
|
-
**id: `string`** — Identifier for a
|
|
1080
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
1066
1081
|
|
|
1067
1082
|
</dd>
|
|
1068
1083
|
|
|
@@ -1072,7 +1087,13 @@ await client.empathicVoice.prompts.updatePromptName('string', {
|
|
|
1072
1087
|
|
|
1073
1088
|
<dd>
|
|
1074
1089
|
|
|
1075
|
-
**
|
|
1090
|
+
**version: `number`**
|
|
1091
|
+
|
|
1092
|
+
Version number for a Tool.
|
|
1093
|
+
|
|
1094
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1095
|
+
|
|
1096
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1076
1097
|
|
|
1077
1098
|
</dd>
|
|
1078
1099
|
|
|
@@ -1082,7 +1103,7 @@ await client.empathicVoice.prompts.updatePromptName('string', {
|
|
|
1082
1103
|
|
|
1083
1104
|
<dd>
|
|
1084
1105
|
|
|
1085
|
-
**requestOptions: `
|
|
1106
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1086
1107
|
|
|
1087
1108
|
</dd>
|
|
1088
1109
|
|
|
@@ -1097,7 +1118,7 @@ await client.empathicVoice.prompts.updatePromptName('string', {
|
|
|
1097
1118
|
</dl>
|
|
1098
1119
|
</details>
|
|
1099
1120
|
|
|
1100
|
-
<details><summary> <code>client.empathicVoice.
|
|
1121
|
+
<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>
|
|
1101
1122
|
|
|
1102
1123
|
<dl>
|
|
1103
1124
|
|
|
@@ -1114,7 +1135,14 @@ await client.empathicVoice.prompts.updatePromptName('string', {
|
|
|
1114
1135
|
<dd>
|
|
1115
1136
|
|
|
1116
1137
|
```ts
|
|
1117
|
-
await client.empathicVoice.
|
|
1138
|
+
await client.empathicVoice.tools.updateToolDescription(
|
|
1139
|
+
'00183a3f-79ba-413d-9f3b-609864268bea',
|
|
1140
|
+
1,
|
|
1141
|
+
{
|
|
1142
|
+
versionDescription:
|
|
1143
|
+
"Fetches current temperature, precipitation, wind speed, AQI, and other weather conditions. Uses Celsius, Fahrenheit, or kelvin depending on user's region.",
|
|
1144
|
+
},
|
|
1145
|
+
);
|
|
1118
1146
|
```
|
|
1119
1147
|
|
|
1120
1148
|
</dd>
|
|
@@ -1135,7 +1163,7 @@ await client.empathicVoice.prompts.getPromptVersion('id', 1);
|
|
|
1135
1163
|
|
|
1136
1164
|
<dd>
|
|
1137
1165
|
|
|
1138
|
-
**id: `string`** — Identifier for a
|
|
1166
|
+
**id: `string`** — Identifier for a Tool. Formatted as a UUID.
|
|
1139
1167
|
|
|
1140
1168
|
</dd>
|
|
1141
1169
|
|
|
@@ -1145,7 +1173,13 @@ await client.empathicVoice.prompts.getPromptVersion('id', 1);
|
|
|
1145
1173
|
|
|
1146
1174
|
<dd>
|
|
1147
1175
|
|
|
1148
|
-
**version: `number`**
|
|
1176
|
+
**version: `number`**
|
|
1177
|
+
|
|
1178
|
+
Version number for a Tool.
|
|
1179
|
+
|
|
1180
|
+
Tools, as well as Configs and Prompts, are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.
|
|
1181
|
+
|
|
1182
|
+
Version numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number.
|
|
1149
1183
|
|
|
1150
1184
|
</dd>
|
|
1151
1185
|
|
|
@@ -1155,7 +1189,17 @@ await client.empathicVoice.prompts.getPromptVersion('id', 1);
|
|
|
1155
1189
|
|
|
1156
1190
|
<dd>
|
|
1157
1191
|
|
|
1158
|
-
**
|
|
1192
|
+
**request: `Hume.empathicVoice.PostedUserDefinedToolVersionDescription`**
|
|
1193
|
+
|
|
1194
|
+
</dd>
|
|
1195
|
+
|
|
1196
|
+
</dl>
|
|
1197
|
+
|
|
1198
|
+
<dl>
|
|
1199
|
+
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
**requestOptions: `Tools.RequestOptions`**
|
|
1159
1203
|
|
|
1160
1204
|
</dd>
|
|
1161
1205
|
|
|
@@ -1170,7 +1214,9 @@ await client.empathicVoice.prompts.getPromptVersion('id', 1);
|
|
|
1170
1214
|
</dl>
|
|
1171
1215
|
</details>
|
|
1172
1216
|
|
|
1173
|
-
|
|
1217
|
+
## EmpathicVoice Prompts
|
|
1218
|
+
|
|
1219
|
+
<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>
|
|
1174
1220
|
|
|
1175
1221
|
<dl>
|
|
1176
1222
|
|
|
@@ -1187,7 +1233,10 @@ await client.empathicVoice.prompts.getPromptVersion('id', 1);
|
|
|
1187
1233
|
<dd>
|
|
1188
1234
|
|
|
1189
1235
|
```ts
|
|
1190
|
-
await client.empathicVoice.prompts.
|
|
1236
|
+
await client.empathicVoice.prompts.listPrompts({
|
|
1237
|
+
pageNumber: 0,
|
|
1238
|
+
pageSize: 2,
|
|
1239
|
+
});
|
|
1191
1240
|
```
|
|
1192
1241
|
|
|
1193
1242
|
</dd>
|
|
@@ -1208,17 +1257,7 @@ await client.empathicVoice.prompts.deletePromptVersion('id', 1);
|
|
|
1208
1257
|
|
|
1209
1258
|
<dd>
|
|
1210
1259
|
|
|
1211
|
-
**
|
|
1212
|
-
|
|
1213
|
-
</dd>
|
|
1214
|
-
|
|
1215
|
-
</dl>
|
|
1216
|
-
|
|
1217
|
-
<dl>
|
|
1218
|
-
|
|
1219
|
-
<dd>
|
|
1220
|
-
|
|
1221
|
-
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1260
|
+
**request: `Hume.empathicVoice.PromptsListPromptsRequest`**
|
|
1222
1261
|
|
|
1223
1262
|
</dd>
|
|
1224
1263
|
|
|
@@ -1243,7 +1282,7 @@ await client.empathicVoice.prompts.deletePromptVersion('id', 1);
|
|
|
1243
1282
|
</dl>
|
|
1244
1283
|
</details>
|
|
1245
1284
|
|
|
1246
|
-
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">
|
|
1285
|
+
<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>
|
|
1247
1286
|
|
|
1248
1287
|
<dl>
|
|
1249
1288
|
|
|
@@ -1260,7 +1299,10 @@ await client.empathicVoice.prompts.deletePromptVersion('id', 1);
|
|
|
1260
1299
|
<dd>
|
|
1261
1300
|
|
|
1262
1301
|
```ts
|
|
1263
|
-
await client.empathicVoice.prompts.
|
|
1302
|
+
await client.empathicVoice.prompts.createPrompt({
|
|
1303
|
+
name: 'Weather Assistant Prompt',
|
|
1304
|
+
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>',
|
|
1305
|
+
});
|
|
1264
1306
|
```
|
|
1265
1307
|
|
|
1266
1308
|
</dd>
|
|
@@ -1281,27 +1323,7 @@ await client.empathicVoice.prompts.updatePromptDescription('id', 1);
|
|
|
1281
1323
|
|
|
1282
1324
|
<dd>
|
|
1283
1325
|
|
|
1284
|
-
**
|
|
1285
|
-
|
|
1286
|
-
</dd>
|
|
1287
|
-
|
|
1288
|
-
</dl>
|
|
1289
|
-
|
|
1290
|
-
<dl>
|
|
1291
|
-
|
|
1292
|
-
<dd>
|
|
1293
|
-
|
|
1294
|
-
**version: `number`** — Version number for a prompt. Version numbers should be integers.
|
|
1295
|
-
|
|
1296
|
-
</dd>
|
|
1297
|
-
|
|
1298
|
-
</dl>
|
|
1299
|
-
|
|
1300
|
-
<dl>
|
|
1301
|
-
|
|
1302
|
-
<dd>
|
|
1303
|
-
|
|
1304
|
-
**request: `Hume.empathicVoice.PostedPromptVersionDescription`**
|
|
1326
|
+
**request: `Hume.empathicVoice.PostedPrompt`**
|
|
1305
1327
|
|
|
1306
1328
|
</dd>
|
|
1307
1329
|
|
|
@@ -1326,9 +1348,7 @@ await client.empathicVoice.prompts.updatePromptDescription('id', 1);
|
|
|
1326
1348
|
</dl>
|
|
1327
1349
|
</details>
|
|
1328
1350
|
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code> </summary>
|
|
1351
|
+
<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>
|
|
1332
1352
|
|
|
1333
1353
|
<dl>
|
|
1334
1354
|
|
|
@@ -1345,7 +1365,9 @@ await client.empathicVoice.prompts.updatePromptDescription('id', 1);
|
|
|
1345
1365
|
<dd>
|
|
1346
1366
|
|
|
1347
1367
|
```ts
|
|
1348
|
-
await client.empathicVoice.
|
|
1368
|
+
await client.empathicVoice.prompts.listPromptVersions(
|
|
1369
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1370
|
+
);
|
|
1349
1371
|
```
|
|
1350
1372
|
|
|
1351
1373
|
</dd>
|
|
@@ -1366,7 +1388,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1366
1388
|
|
|
1367
1389
|
<dd>
|
|
1368
1390
|
|
|
1369
|
-
**
|
|
1391
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1370
1392
|
|
|
1371
1393
|
</dd>
|
|
1372
1394
|
|
|
@@ -1376,7 +1398,17 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1376
1398
|
|
|
1377
1399
|
<dd>
|
|
1378
1400
|
|
|
1379
|
-
**
|
|
1401
|
+
**request: `Hume.empathicVoice.PromptsListPromptVersionsRequest`**
|
|
1402
|
+
|
|
1403
|
+
</dd>
|
|
1404
|
+
|
|
1405
|
+
</dl>
|
|
1406
|
+
|
|
1407
|
+
<dl>
|
|
1408
|
+
|
|
1409
|
+
<dd>
|
|
1410
|
+
|
|
1411
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1380
1412
|
|
|
1381
1413
|
</dd>
|
|
1382
1414
|
|
|
@@ -1391,7 +1423,7 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1391
1423
|
</dl>
|
|
1392
1424
|
</details>
|
|
1393
1425
|
|
|
1394
|
-
<details><summary> <code>client.empathicVoice.
|
|
1426
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">createPromptVerison</a>(id, { ...params }) -> Hume.ReturnPrompt | undefined</code> </summary>
|
|
1395
1427
|
|
|
1396
1428
|
<dl>
|
|
1397
1429
|
|
|
@@ -1408,9 +1440,14 @@ await client.empathicVoice.configs.listConfigs();
|
|
|
1408
1440
|
<dd>
|
|
1409
1441
|
|
|
1410
1442
|
```ts
|
|
1411
|
-
await client.empathicVoice.
|
|
1412
|
-
|
|
1413
|
-
|
|
1443
|
+
await client.empathicVoice.prompts.createPromptVerison(
|
|
1444
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1445
|
+
{
|
|
1446
|
+
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>',
|
|
1447
|
+
versionDescription:
|
|
1448
|
+
'This is an updated version of the Weather Assistant Prompt.',
|
|
1449
|
+
},
|
|
1450
|
+
);
|
|
1414
1451
|
```
|
|
1415
1452
|
|
|
1416
1453
|
</dd>
|
|
@@ -1431,7 +1468,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1431
1468
|
|
|
1432
1469
|
<dd>
|
|
1433
1470
|
|
|
1434
|
-
**
|
|
1471
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1435
1472
|
|
|
1436
1473
|
</dd>
|
|
1437
1474
|
|
|
@@ -1441,7 +1478,17 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1441
1478
|
|
|
1442
1479
|
<dd>
|
|
1443
1480
|
|
|
1444
|
-
**
|
|
1481
|
+
**request: `Hume.empathicVoice.PostedPromptVersion`**
|
|
1482
|
+
|
|
1483
|
+
</dd>
|
|
1484
|
+
|
|
1485
|
+
</dl>
|
|
1486
|
+
|
|
1487
|
+
<dl>
|
|
1488
|
+
|
|
1489
|
+
<dd>
|
|
1490
|
+
|
|
1491
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1445
1492
|
|
|
1446
1493
|
</dd>
|
|
1447
1494
|
|
|
@@ -1456,7 +1503,7 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1456
1503
|
</dl>
|
|
1457
1504
|
</details>
|
|
1458
1505
|
|
|
1459
|
-
<details><summary> <code>client.empathicVoice.
|
|
1506
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePrompt</a>(id) -> void</code> </summary>
|
|
1460
1507
|
|
|
1461
1508
|
<dl>
|
|
1462
1509
|
|
|
@@ -1473,7 +1520,9 @@ await client.empathicVoice.configs.createConfig({
|
|
|
1473
1520
|
<dd>
|
|
1474
1521
|
|
|
1475
1522
|
```ts
|
|
1476
|
-
await client.empathicVoice.
|
|
1523
|
+
await client.empathicVoice.prompts.deletePrompt(
|
|
1524
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1525
|
+
);
|
|
1477
1526
|
```
|
|
1478
1527
|
|
|
1479
1528
|
</dd>
|
|
@@ -1494,17 +1543,7 @@ await client.empathicVoice.configs.listConfigVersions('id');
|
|
|
1494
1543
|
|
|
1495
1544
|
<dd>
|
|
1496
1545
|
|
|
1497
|
-
**id: `string`** — Identifier for a
|
|
1498
|
-
|
|
1499
|
-
</dd>
|
|
1500
|
-
|
|
1501
|
-
</dl>
|
|
1502
|
-
|
|
1503
|
-
<dl>
|
|
1504
|
-
|
|
1505
|
-
<dd>
|
|
1506
|
-
|
|
1507
|
-
**request: `Hume.empathicVoice.ConfigsListConfigVersionsRequest`**
|
|
1546
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1508
1547
|
|
|
1509
1548
|
</dd>
|
|
1510
1549
|
|
|
@@ -1514,7 +1553,7 @@ await client.empathicVoice.configs.listConfigVersions('id');
|
|
|
1514
1553
|
|
|
1515
1554
|
<dd>
|
|
1516
1555
|
|
|
1517
|
-
**requestOptions: `
|
|
1556
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1518
1557
|
|
|
1519
1558
|
</dd>
|
|
1520
1559
|
|
|
@@ -1529,7 +1568,7 @@ await client.empathicVoice.configs.listConfigVersions('id');
|
|
|
1529
1568
|
</dl>
|
|
1530
1569
|
</details>
|
|
1531
1570
|
|
|
1532
|
-
<details><summary> <code>client.empathicVoice.
|
|
1571
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">updatePromptName</a>(id, { ...params }) -> string</code> </summary>
|
|
1533
1572
|
|
|
1534
1573
|
<dl>
|
|
1535
1574
|
|
|
@@ -1546,7 +1585,12 @@ await client.empathicVoice.configs.listConfigVersions('id');
|
|
|
1546
1585
|
<dd>
|
|
1547
1586
|
|
|
1548
1587
|
```ts
|
|
1549
|
-
await client.empathicVoice.
|
|
1588
|
+
await client.empathicVoice.prompts.updatePromptName(
|
|
1589
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1590
|
+
{
|
|
1591
|
+
name: 'Updated Weather Assistant Prompt Name',
|
|
1592
|
+
},
|
|
1593
|
+
);
|
|
1550
1594
|
```
|
|
1551
1595
|
|
|
1552
1596
|
</dd>
|
|
@@ -1567,7 +1611,7 @@ await client.empathicVoice.configs.createConfigVersion('id');
|
|
|
1567
1611
|
|
|
1568
1612
|
<dd>
|
|
1569
1613
|
|
|
1570
|
-
**id: `string`** — Identifier for a
|
|
1614
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1571
1615
|
|
|
1572
1616
|
</dd>
|
|
1573
1617
|
|
|
@@ -1577,7 +1621,7 @@ await client.empathicVoice.configs.createConfigVersion('id');
|
|
|
1577
1621
|
|
|
1578
1622
|
<dd>
|
|
1579
1623
|
|
|
1580
|
-
**request: `Hume.empathicVoice.
|
|
1624
|
+
**request: `Hume.empathicVoice.PostedPromptName`**
|
|
1581
1625
|
|
|
1582
1626
|
</dd>
|
|
1583
1627
|
|
|
@@ -1587,7 +1631,7 @@ await client.empathicVoice.configs.createConfigVersion('id');
|
|
|
1587
1631
|
|
|
1588
1632
|
<dd>
|
|
1589
1633
|
|
|
1590
|
-
**requestOptions: `
|
|
1634
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1591
1635
|
|
|
1592
1636
|
</dd>
|
|
1593
1637
|
|
|
@@ -1602,7 +1646,7 @@ await client.empathicVoice.configs.createConfigVersion('id');
|
|
|
1602
1646
|
</dl>
|
|
1603
1647
|
</details>
|
|
1604
1648
|
|
|
1605
|
-
<details><summary> <code>client.empathicVoice.
|
|
1649
|
+
<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>
|
|
1606
1650
|
|
|
1607
1651
|
<dl>
|
|
1608
1652
|
|
|
@@ -1619,7 +1663,10 @@ await client.empathicVoice.configs.createConfigVersion('id');
|
|
|
1619
1663
|
<dd>
|
|
1620
1664
|
|
|
1621
1665
|
```ts
|
|
1622
|
-
await client.empathicVoice.
|
|
1666
|
+
await client.empathicVoice.prompts.getPromptVersion(
|
|
1667
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1668
|
+
0,
|
|
1669
|
+
);
|
|
1623
1670
|
```
|
|
1624
1671
|
|
|
1625
1672
|
</dd>
|
|
@@ -1640,7 +1687,7 @@ await client.empathicVoice.configs.deleteConfig('id');
|
|
|
1640
1687
|
|
|
1641
1688
|
<dd>
|
|
1642
1689
|
|
|
1643
|
-
**id: `string`** — Identifier for a
|
|
1690
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1644
1691
|
|
|
1645
1692
|
</dd>
|
|
1646
1693
|
|
|
@@ -1650,7 +1697,23 @@ await client.empathicVoice.configs.deleteConfig('id');
|
|
|
1650
1697
|
|
|
1651
1698
|
<dd>
|
|
1652
1699
|
|
|
1653
|
-
**
|
|
1700
|
+
**version: `number`**
|
|
1701
|
+
|
|
1702
|
+
Version number for a Prompt.
|
|
1703
|
+
|
|
1704
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1705
|
+
|
|
1706
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1707
|
+
|
|
1708
|
+
</dd>
|
|
1709
|
+
|
|
1710
|
+
</dl>
|
|
1711
|
+
|
|
1712
|
+
<dl>
|
|
1713
|
+
|
|
1714
|
+
<dd>
|
|
1715
|
+
|
|
1716
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1654
1717
|
|
|
1655
1718
|
</dd>
|
|
1656
1719
|
|
|
@@ -1665,7 +1728,7 @@ await client.empathicVoice.configs.deleteConfig('id');
|
|
|
1665
1728
|
</dl>
|
|
1666
1729
|
</details>
|
|
1667
1730
|
|
|
1668
|
-
<details><summary> <code>client.empathicVoice.
|
|
1731
|
+
<details><summary> <code>client.empathicVoice.prompts.<a href="./src/api/resources/empathicVoice/resources/prompts/client/Client.ts">deletePromptVersion</a>(id, version) -> void</code> </summary>
|
|
1669
1732
|
|
|
1670
1733
|
<dl>
|
|
1671
1734
|
|
|
@@ -1682,9 +1745,10 @@ await client.empathicVoice.configs.deleteConfig('id');
|
|
|
1682
1745
|
<dd>
|
|
1683
1746
|
|
|
1684
1747
|
```ts
|
|
1685
|
-
await client.empathicVoice.
|
|
1686
|
-
|
|
1687
|
-
|
|
1748
|
+
await client.empathicVoice.prompts.deletePromptVersion(
|
|
1749
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1750
|
+
1,
|
|
1751
|
+
);
|
|
1688
1752
|
```
|
|
1689
1753
|
|
|
1690
1754
|
</dd>
|
|
@@ -1705,7 +1769,7 @@ await client.empathicVoice.configs.updateConfigName('string', {
|
|
|
1705
1769
|
|
|
1706
1770
|
<dd>
|
|
1707
1771
|
|
|
1708
|
-
**id: `string`** — Identifier for a
|
|
1772
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1709
1773
|
|
|
1710
1774
|
</dd>
|
|
1711
1775
|
|
|
@@ -1715,7 +1779,13 @@ await client.empathicVoice.configs.updateConfigName('string', {
|
|
|
1715
1779
|
|
|
1716
1780
|
<dd>
|
|
1717
1781
|
|
|
1718
|
-
**
|
|
1782
|
+
**version: `number`**
|
|
1783
|
+
|
|
1784
|
+
Version number for a Prompt.
|
|
1785
|
+
|
|
1786
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1787
|
+
|
|
1788
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1719
1789
|
|
|
1720
1790
|
</dd>
|
|
1721
1791
|
|
|
@@ -1725,7 +1795,7 @@ await client.empathicVoice.configs.updateConfigName('string', {
|
|
|
1725
1795
|
|
|
1726
1796
|
<dd>
|
|
1727
1797
|
|
|
1728
|
-
**requestOptions: `
|
|
1798
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1729
1799
|
|
|
1730
1800
|
</dd>
|
|
1731
1801
|
|
|
@@ -1740,7 +1810,7 @@ await client.empathicVoice.configs.updateConfigName('string', {
|
|
|
1740
1810
|
</dl>
|
|
1741
1811
|
</details>
|
|
1742
1812
|
|
|
1743
|
-
<details><summary> <code>client.empathicVoice.
|
|
1813
|
+
<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>
|
|
1744
1814
|
|
|
1745
1815
|
<dl>
|
|
1746
1816
|
|
|
@@ -1757,7 +1827,13 @@ await client.empathicVoice.configs.updateConfigName('string', {
|
|
|
1757
1827
|
<dd>
|
|
1758
1828
|
|
|
1759
1829
|
```ts
|
|
1760
|
-
await client.empathicVoice.
|
|
1830
|
+
await client.empathicVoice.prompts.updatePromptDescription(
|
|
1831
|
+
'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1832
|
+
1,
|
|
1833
|
+
{
|
|
1834
|
+
versionDescription: 'This is an updated version_description.',
|
|
1835
|
+
},
|
|
1836
|
+
);
|
|
1761
1837
|
```
|
|
1762
1838
|
|
|
1763
1839
|
</dd>
|
|
@@ -1778,7 +1854,7 @@ await client.empathicVoice.configs.getConfigVersion('id', 1);
|
|
|
1778
1854
|
|
|
1779
1855
|
<dd>
|
|
1780
1856
|
|
|
1781
|
-
**id: `string`** — Identifier for a
|
|
1857
|
+
**id: `string`** — Identifier for a Prompt. Formatted as a UUID.
|
|
1782
1858
|
|
|
1783
1859
|
</dd>
|
|
1784
1860
|
|
|
@@ -1788,7 +1864,13 @@ await client.empathicVoice.configs.getConfigVersion('id', 1);
|
|
|
1788
1864
|
|
|
1789
1865
|
<dd>
|
|
1790
1866
|
|
|
1791
|
-
**version: `number`**
|
|
1867
|
+
**version: `number`**
|
|
1868
|
+
|
|
1869
|
+
Version number for a Prompt.
|
|
1870
|
+
|
|
1871
|
+
Prompts, as well as Configs and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.
|
|
1872
|
+
|
|
1873
|
+
Version numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number.
|
|
1792
1874
|
|
|
1793
1875
|
</dd>
|
|
1794
1876
|
|
|
@@ -1798,7 +1880,17 @@ await client.empathicVoice.configs.getConfigVersion('id', 1);
|
|
|
1798
1880
|
|
|
1799
1881
|
<dd>
|
|
1800
1882
|
|
|
1801
|
-
**
|
|
1883
|
+
**request: `Hume.empathicVoice.PostedPromptVersionDescription`**
|
|
1884
|
+
|
|
1885
|
+
</dd>
|
|
1886
|
+
|
|
1887
|
+
</dl>
|
|
1888
|
+
|
|
1889
|
+
<dl>
|
|
1890
|
+
|
|
1891
|
+
<dd>
|
|
1892
|
+
|
|
1893
|
+
**requestOptions: `Prompts.RequestOptions`**
|
|
1802
1894
|
|
|
1803
1895
|
</dd>
|
|
1804
1896
|
|
|
@@ -1813,7 +1905,9 @@ await client.empathicVoice.configs.getConfigVersion('id', 1);
|
|
|
1813
1905
|
</dl>
|
|
1814
1906
|
</details>
|
|
1815
1907
|
|
|
1816
|
-
|
|
1908
|
+
## EmpathicVoice Configs
|
|
1909
|
+
|
|
1910
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">listConfigs</a>({ ...params }) -> Hume.ReturnPagedConfigs</code> </summary>
|
|
1817
1911
|
|
|
1818
1912
|
<dl>
|
|
1819
1913
|
|
|
@@ -1830,7 +1924,10 @@ await client.empathicVoice.configs.getConfigVersion('id', 1);
|
|
|
1830
1924
|
<dd>
|
|
1831
1925
|
|
|
1832
1926
|
```ts
|
|
1833
|
-
await client.empathicVoice.configs.
|
|
1927
|
+
await client.empathicVoice.configs.listConfigs({
|
|
1928
|
+
pageNumber: 0,
|
|
1929
|
+
pageSize: 1,
|
|
1930
|
+
});
|
|
1834
1931
|
```
|
|
1835
1932
|
|
|
1836
1933
|
</dd>
|
|
@@ -1851,17 +1948,7 @@ await client.empathicVoice.configs.deleteConfigVersion('id', 1);
|
|
|
1851
1948
|
|
|
1852
1949
|
<dd>
|
|
1853
1950
|
|
|
1854
|
-
**
|
|
1855
|
-
|
|
1856
|
-
</dd>
|
|
1857
|
-
|
|
1858
|
-
</dl>
|
|
1859
|
-
|
|
1860
|
-
<dl>
|
|
1861
|
-
|
|
1862
|
-
<dd>
|
|
1863
|
-
|
|
1864
|
-
**version: `number`** — Version number for a config. Version numbers should be integers.
|
|
1951
|
+
**request: `Hume.empathicVoice.ConfigsListConfigsRequest`**
|
|
1865
1952
|
|
|
1866
1953
|
</dd>
|
|
1867
1954
|
|
|
@@ -1886,7 +1973,7 @@ await client.empathicVoice.configs.deleteConfigVersion('id', 1);
|
|
|
1886
1973
|
</dl>
|
|
1887
1974
|
</details>
|
|
1888
1975
|
|
|
1889
|
-
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">
|
|
1976
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">createConfig</a>({ ...params }) -> Hume.ReturnConfig</code> </summary>
|
|
1890
1977
|
|
|
1891
1978
|
<dl>
|
|
1892
1979
|
|
|
@@ -1903,48 +1990,57 @@ await client.empathicVoice.configs.deleteConfigVersion('id', 1);
|
|
|
1903
1990
|
<dd>
|
|
1904
1991
|
|
|
1905
1992
|
```ts
|
|
1906
|
-
await client.empathicVoice.configs.
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1993
|
+
await client.empathicVoice.configs.createConfig({
|
|
1994
|
+
name: 'Weather Assistant Config',
|
|
1995
|
+
prompt: {
|
|
1996
|
+
id: 'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
1997
|
+
version: 0,
|
|
1998
|
+
},
|
|
1999
|
+
voice: {
|
|
2000
|
+
provider: 'HUME_AI',
|
|
2001
|
+
name: Hume.PostedVoiceName.Kora,
|
|
2002
|
+
},
|
|
2003
|
+
languageModel: {
|
|
2004
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2005
|
+
modelResource: 'claude-3-5-sonnet-20240620',
|
|
2006
|
+
temperature: 1,
|
|
2007
|
+
},
|
|
2008
|
+
eventMessages: {
|
|
2009
|
+
onNewChat: {
|
|
2010
|
+
enabled: false,
|
|
2011
|
+
text: '',
|
|
2012
|
+
},
|
|
2013
|
+
onInactivityTimeout: {
|
|
2014
|
+
enabled: false,
|
|
2015
|
+
text: '',
|
|
2016
|
+
},
|
|
2017
|
+
onMaxDurationTimeout: {
|
|
2018
|
+
enabled: false,
|
|
2019
|
+
text: '',
|
|
2020
|
+
},
|
|
2021
|
+
},
|
|
2022
|
+
});
|
|
2023
|
+
```
|
|
1924
2024
|
|
|
1925
|
-
|
|
2025
|
+
</dd>
|
|
1926
2026
|
|
|
1927
|
-
|
|
2027
|
+
</dl>
|
|
1928
2028
|
|
|
1929
2029
|
</dd>
|
|
1930
2030
|
|
|
1931
2031
|
</dl>
|
|
1932
2032
|
|
|
2033
|
+
#### ⚙️ Parameters
|
|
2034
|
+
|
|
1933
2035
|
<dl>
|
|
1934
2036
|
|
|
1935
2037
|
<dd>
|
|
1936
2038
|
|
|
1937
|
-
**version: `number`** — Version number for a config. Version numbers should be integers.
|
|
1938
|
-
|
|
1939
|
-
</dd>
|
|
1940
|
-
|
|
1941
|
-
</dl>
|
|
1942
|
-
|
|
1943
2039
|
<dl>
|
|
1944
2040
|
|
|
1945
2041
|
<dd>
|
|
1946
2042
|
|
|
1947
|
-
**request: `Hume.empathicVoice.
|
|
2043
|
+
**request: `Hume.empathicVoice.PostedConfig`**
|
|
1948
2044
|
|
|
1949
2045
|
</dd>
|
|
1950
2046
|
|
|
@@ -1969,9 +2065,7 @@ await client.empathicVoice.configs.updateConfigDescription('id', 1);
|
|
|
1969
2065
|
</dl>
|
|
1970
2066
|
</details>
|
|
1971
2067
|
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
<details><summary> <code>client.empathicVoice.chats.<a href="./src/api/resources/empathicVoice/resources/chats/client/Client.ts">listChats</a>({ ...params }) -> Hume.ReturnPagedChats</code> </summary>
|
|
2068
|
+
<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>
|
|
1975
2069
|
|
|
1976
2070
|
<dl>
|
|
1977
2071
|
|
|
@@ -1988,7 +2082,9 @@ await client.empathicVoice.configs.updateConfigDescription('id', 1);
|
|
|
1988
2082
|
<dd>
|
|
1989
2083
|
|
|
1990
2084
|
```ts
|
|
1991
|
-
await client.empathicVoice.
|
|
2085
|
+
await client.empathicVoice.configs.listConfigVersions(
|
|
2086
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2087
|
+
);
|
|
1992
2088
|
```
|
|
1993
2089
|
|
|
1994
2090
|
</dd>
|
|
@@ -2009,7 +2105,7 @@ await client.empathicVoice.chats.listChats();
|
|
|
2009
2105
|
|
|
2010
2106
|
<dd>
|
|
2011
2107
|
|
|
2012
|
-
**
|
|
2108
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2013
2109
|
|
|
2014
2110
|
</dd>
|
|
2015
2111
|
|
|
@@ -2019,7 +2115,17 @@ await client.empathicVoice.chats.listChats();
|
|
|
2019
2115
|
|
|
2020
2116
|
<dd>
|
|
2021
2117
|
|
|
2022
|
-
**
|
|
2118
|
+
**request: `Hume.empathicVoice.ConfigsListConfigVersionsRequest`**
|
|
2119
|
+
|
|
2120
|
+
</dd>
|
|
2121
|
+
|
|
2122
|
+
</dl>
|
|
2123
|
+
|
|
2124
|
+
<dl>
|
|
2125
|
+
|
|
2126
|
+
<dd>
|
|
2127
|
+
|
|
2128
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2023
2129
|
|
|
2024
2130
|
</dd>
|
|
2025
2131
|
|
|
@@ -2034,7 +2140,7 @@ await client.empathicVoice.chats.listChats();
|
|
|
2034
2140
|
</dl>
|
|
2035
2141
|
</details>
|
|
2036
2142
|
|
|
2037
|
-
<details><summary> <code>client.empathicVoice.
|
|
2143
|
+
<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>
|
|
2038
2144
|
|
|
2039
2145
|
<dl>
|
|
2040
2146
|
|
|
@@ -2051,7 +2157,43 @@ await client.empathicVoice.chats.listChats();
|
|
|
2051
2157
|
<dd>
|
|
2052
2158
|
|
|
2053
2159
|
```ts
|
|
2054
|
-
await client.empathicVoice.
|
|
2160
|
+
await client.empathicVoice.configs.createConfigVersion(
|
|
2161
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2162
|
+
{
|
|
2163
|
+
versionDescription:
|
|
2164
|
+
'This is an updated version of the Weather Assistant Config.',
|
|
2165
|
+
prompt: {
|
|
2166
|
+
id: 'af699d45-2985-42cc-91b9-af9e5da3bac5',
|
|
2167
|
+
version: 0,
|
|
2168
|
+
},
|
|
2169
|
+
voice: {
|
|
2170
|
+
provider: 'HUME_AI',
|
|
2171
|
+
name: Hume.PostedVoiceName.Ito,
|
|
2172
|
+
},
|
|
2173
|
+
languageModel: {
|
|
2174
|
+
modelProvider: Hume.PostedLanguageModelModelProvider.Anthropic,
|
|
2175
|
+
modelResource: 'claude-3-5-sonnet-20240620',
|
|
2176
|
+
temperature: 1,
|
|
2177
|
+
},
|
|
2178
|
+
ellmModel: {
|
|
2179
|
+
allowShortResponses: true,
|
|
2180
|
+
},
|
|
2181
|
+
eventMessages: {
|
|
2182
|
+
onNewChat: {
|
|
2183
|
+
enabled: false,
|
|
2184
|
+
text: '',
|
|
2185
|
+
},
|
|
2186
|
+
onInactivityTimeout: {
|
|
2187
|
+
enabled: false,
|
|
2188
|
+
text: '',
|
|
2189
|
+
},
|
|
2190
|
+
onMaxDurationTimeout: {
|
|
2191
|
+
enabled: false,
|
|
2192
|
+
text: '',
|
|
2193
|
+
},
|
|
2194
|
+
},
|
|
2195
|
+
},
|
|
2196
|
+
);
|
|
2055
2197
|
```
|
|
2056
2198
|
|
|
2057
2199
|
</dd>
|
|
@@ -2072,7 +2214,7 @@ await client.empathicVoice.chats.listChatEvents('id');
|
|
|
2072
2214
|
|
|
2073
2215
|
<dd>
|
|
2074
2216
|
|
|
2075
|
-
**id: `string`** — Identifier for a
|
|
2217
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2076
2218
|
|
|
2077
2219
|
</dd>
|
|
2078
2220
|
|
|
@@ -2082,7 +2224,7 @@ await client.empathicVoice.chats.listChatEvents('id');
|
|
|
2082
2224
|
|
|
2083
2225
|
<dd>
|
|
2084
2226
|
|
|
2085
|
-
**request: `Hume.empathicVoice.
|
|
2227
|
+
**request: `Hume.empathicVoice.PostedConfigVersion`**
|
|
2086
2228
|
|
|
2087
2229
|
</dd>
|
|
2088
2230
|
|
|
@@ -2092,7 +2234,7 @@ await client.empathicVoice.chats.listChatEvents('id');
|
|
|
2092
2234
|
|
|
2093
2235
|
<dd>
|
|
2094
2236
|
|
|
2095
|
-
**requestOptions: `
|
|
2237
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2096
2238
|
|
|
2097
2239
|
</dd>
|
|
2098
2240
|
|
|
@@ -2107,9 +2249,7 @@ await client.empathicVoice.chats.listChatEvents('id');
|
|
|
2107
2249
|
</dl>
|
|
2108
2250
|
</details>
|
|
2109
2251
|
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
<details><summary> <code>client.empathicVoice.chatGroups.<a href="./src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code> </summary>
|
|
2252
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfig</a>(id) -> void</code> </summary>
|
|
2113
2253
|
|
|
2114
2254
|
<dl>
|
|
2115
2255
|
|
|
@@ -2126,7 +2266,9 @@ await client.empathicVoice.chats.listChatEvents('id');
|
|
|
2126
2266
|
<dd>
|
|
2127
2267
|
|
|
2128
2268
|
```ts
|
|
2129
|
-
await client.empathicVoice.
|
|
2269
|
+
await client.empathicVoice.configs.deleteConfig(
|
|
2270
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2271
|
+
);
|
|
2130
2272
|
```
|
|
2131
2273
|
|
|
2132
2274
|
</dd>
|
|
@@ -2147,7 +2289,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2147
2289
|
|
|
2148
2290
|
<dd>
|
|
2149
2291
|
|
|
2150
|
-
**
|
|
2292
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2151
2293
|
|
|
2152
2294
|
</dd>
|
|
2153
2295
|
|
|
@@ -2157,7 +2299,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2157
2299
|
|
|
2158
2300
|
<dd>
|
|
2159
2301
|
|
|
2160
|
-
**requestOptions: `
|
|
2302
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2161
2303
|
|
|
2162
2304
|
</dd>
|
|
2163
2305
|
|
|
@@ -2172,7 +2314,7 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2172
2314
|
</dl>
|
|
2173
2315
|
</details>
|
|
2174
2316
|
|
|
2175
|
-
<details><summary> <code>client.empathicVoice.
|
|
2317
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">updateConfigName</a>(id, { ...params }) -> string</code> </summary>
|
|
2176
2318
|
|
|
2177
2319
|
<dl>
|
|
2178
2320
|
|
|
@@ -2189,7 +2331,12 @@ await client.empathicVoice.chatGroups.listChatGroups();
|
|
|
2189
2331
|
<dd>
|
|
2190
2332
|
|
|
2191
2333
|
```ts
|
|
2192
|
-
await client.empathicVoice.
|
|
2334
|
+
await client.empathicVoice.configs.updateConfigName(
|
|
2335
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2336
|
+
{
|
|
2337
|
+
name: 'Updated Weather Assistant Config Name',
|
|
2338
|
+
},
|
|
2339
|
+
);
|
|
2193
2340
|
```
|
|
2194
2341
|
|
|
2195
2342
|
</dd>
|
|
@@ -2210,7 +2357,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents('id');
|
|
|
2210
2357
|
|
|
2211
2358
|
<dd>
|
|
2212
2359
|
|
|
2213
|
-
**id: `string`** — Identifier for a
|
|
2360
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2214
2361
|
|
|
2215
2362
|
</dd>
|
|
2216
2363
|
|
|
@@ -2220,7 +2367,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents('id');
|
|
|
2220
2367
|
|
|
2221
2368
|
<dd>
|
|
2222
2369
|
|
|
2223
|
-
**request: `Hume.empathicVoice.
|
|
2370
|
+
**request: `Hume.empathicVoice.PostedConfigName`**
|
|
2224
2371
|
|
|
2225
2372
|
</dd>
|
|
2226
2373
|
|
|
@@ -2230,7 +2377,7 @@ await client.empathicVoice.chatGroups.listChatGroupEvents('id');
|
|
|
2230
2377
|
|
|
2231
2378
|
<dd>
|
|
2232
2379
|
|
|
2233
|
-
**requestOptions: `
|
|
2380
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2234
2381
|
|
|
2235
2382
|
</dd>
|
|
2236
2383
|
|
|
@@ -2245,15 +2392,13 @@ await client.empathicVoice.chatGroups.listChatGroupEvents('id');
|
|
|
2245
2392
|
</dl>
|
|
2246
2393
|
</details>
|
|
2247
2394
|
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
<details><summary> <code>client.expressionMeasurement.batch.<a href="./src/api/resources/expressionMeasurement/resources/batch/client/Client.ts">listJobs</a>({ ...params }) -> Hume.UnionJob[]</code> </summary>
|
|
2395
|
+
<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>
|
|
2251
2396
|
|
|
2252
2397
|
<dl>
|
|
2253
2398
|
|
|
2254
2399
|
<dd>
|
|
2255
2400
|
|
|
2256
|
-
####
|
|
2401
|
+
#### 🔌 Usage
|
|
2257
2402
|
|
|
2258
2403
|
<dl>
|
|
2259
2404
|
|
|
@@ -2263,7 +2408,12 @@ await client.empathicVoice.chatGroups.listChatGroupEvents('id');
|
|
|
2263
2408
|
|
|
2264
2409
|
<dd>
|
|
2265
2410
|
|
|
2266
|
-
|
|
2411
|
+
```ts
|
|
2412
|
+
await client.empathicVoice.configs.getConfigVersion(
|
|
2413
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2414
|
+
1,
|
|
2415
|
+
);
|
|
2416
|
+
```
|
|
2267
2417
|
|
|
2268
2418
|
</dd>
|
|
2269
2419
|
|
|
@@ -2273,7 +2423,7 @@ Sort and filter jobs.
|
|
|
2273
2423
|
|
|
2274
2424
|
</dl>
|
|
2275
2425
|
|
|
2276
|
-
####
|
|
2426
|
+
#### ⚙️ Parameters
|
|
2277
2427
|
|
|
2278
2428
|
<dl>
|
|
2279
2429
|
|
|
@@ -2283,29 +2433,23 @@ Sort and filter jobs.
|
|
|
2283
2433
|
|
|
2284
2434
|
<dd>
|
|
2285
2435
|
|
|
2286
|
-
|
|
2287
|
-
await client.expressionMeasurement.batch.listJobs();
|
|
2288
|
-
```
|
|
2289
|
-
|
|
2290
|
-
</dd>
|
|
2291
|
-
|
|
2292
|
-
</dl>
|
|
2436
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2293
2437
|
|
|
2294
2438
|
</dd>
|
|
2295
2439
|
|
|
2296
2440
|
</dl>
|
|
2297
2441
|
|
|
2298
|
-
#### ⚙️ Parameters
|
|
2299
|
-
|
|
2300
2442
|
<dl>
|
|
2301
2443
|
|
|
2302
2444
|
<dd>
|
|
2303
2445
|
|
|
2304
|
-
|
|
2446
|
+
**version: `number`**
|
|
2305
2447
|
|
|
2306
|
-
|
|
2448
|
+
Version number for a Config.
|
|
2307
2449
|
|
|
2308
|
-
|
|
2450
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2451
|
+
|
|
2452
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2309
2453
|
|
|
2310
2454
|
</dd>
|
|
2311
2455
|
|
|
@@ -2315,7 +2459,7 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2315
2459
|
|
|
2316
2460
|
<dd>
|
|
2317
2461
|
|
|
2318
|
-
**requestOptions: `
|
|
2462
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2319
2463
|
|
|
2320
2464
|
</dd>
|
|
2321
2465
|
|
|
@@ -2330,13 +2474,13 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2330
2474
|
</dl>
|
|
2331
2475
|
</details>
|
|
2332
2476
|
|
|
2333
|
-
<details><summary> <code>client.
|
|
2477
|
+
<details><summary> <code>client.empathicVoice.configs.<a href="./src/api/resources/empathicVoice/resources/configs/client/Client.ts">deleteConfigVersion</a>(id, version) -> void</code> </summary>
|
|
2334
2478
|
|
|
2335
2479
|
<dl>
|
|
2336
2480
|
|
|
2337
2481
|
<dd>
|
|
2338
2482
|
|
|
2339
|
-
####
|
|
2483
|
+
#### 🔌 Usage
|
|
2340
2484
|
|
|
2341
2485
|
<dl>
|
|
2342
2486
|
|
|
@@ -2346,7 +2490,12 @@ await client.expressionMeasurement.batch.listJobs();
|
|
|
2346
2490
|
|
|
2347
2491
|
<dd>
|
|
2348
2492
|
|
|
2349
|
-
|
|
2493
|
+
```ts
|
|
2494
|
+
await client.empathicVoice.configs.deleteConfigVersion(
|
|
2495
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2496
|
+
1,
|
|
2497
|
+
);
|
|
2498
|
+
```
|
|
2350
2499
|
|
|
2351
2500
|
</dd>
|
|
2352
2501
|
|
|
@@ -2356,7 +2505,7 @@ Start a new measurement inference job.
|
|
|
2356
2505
|
|
|
2357
2506
|
</dl>
|
|
2358
2507
|
|
|
2359
|
-
####
|
|
2508
|
+
#### ⚙️ Parameters
|
|
2360
2509
|
|
|
2361
2510
|
<dl>
|
|
2362
2511
|
|
|
@@ -2366,32 +2515,23 @@ Start a new measurement inference job.
|
|
|
2366
2515
|
|
|
2367
2516
|
<dd>
|
|
2368
2517
|
|
|
2369
|
-
|
|
2370
|
-
await client.expressionMeasurement.batch.startInferenceJob({
|
|
2371
|
-
urls: ['https://hume-tutorials.s3.amazonaws.com/faces.zip'],
|
|
2372
|
-
notify: true,
|
|
2373
|
-
});
|
|
2374
|
-
```
|
|
2375
|
-
|
|
2376
|
-
</dd>
|
|
2377
|
-
|
|
2378
|
-
</dl>
|
|
2518
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2379
2519
|
|
|
2380
2520
|
</dd>
|
|
2381
2521
|
|
|
2382
2522
|
</dl>
|
|
2383
2523
|
|
|
2384
|
-
#### ⚙️ Parameters
|
|
2385
|
-
|
|
2386
2524
|
<dl>
|
|
2387
2525
|
|
|
2388
2526
|
<dd>
|
|
2389
2527
|
|
|
2390
|
-
|
|
2528
|
+
**version: `number`**
|
|
2391
2529
|
|
|
2392
|
-
|
|
2530
|
+
Version number for a Config.
|
|
2393
2531
|
|
|
2394
|
-
|
|
2532
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2533
|
+
|
|
2534
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2395
2535
|
|
|
2396
2536
|
</dd>
|
|
2397
2537
|
|
|
@@ -2401,7 +2541,7 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2401
2541
|
|
|
2402
2542
|
<dd>
|
|
2403
2543
|
|
|
2404
|
-
**requestOptions: `
|
|
2544
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2405
2545
|
|
|
2406
2546
|
</dd>
|
|
2407
2547
|
|
|
@@ -2416,13 +2556,13 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2416
2556
|
</dl>
|
|
2417
2557
|
</details>
|
|
2418
2558
|
|
|
2419
|
-
<details><summary> <code>client.
|
|
2559
|
+
<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>
|
|
2420
2560
|
|
|
2421
2561
|
<dl>
|
|
2422
2562
|
|
|
2423
2563
|
<dd>
|
|
2424
2564
|
|
|
2425
|
-
####
|
|
2565
|
+
#### 🔌 Usage
|
|
2426
2566
|
|
|
2427
2567
|
<dl>
|
|
2428
2568
|
|
|
@@ -2432,7 +2572,15 @@ await client.expressionMeasurement.batch.startInferenceJob({
|
|
|
2432
2572
|
|
|
2433
2573
|
<dd>
|
|
2434
2574
|
|
|
2435
|
-
|
|
2575
|
+
```ts
|
|
2576
|
+
await client.empathicVoice.configs.updateConfigDescription(
|
|
2577
|
+
'1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2578
|
+
1,
|
|
2579
|
+
{
|
|
2580
|
+
versionDescription: 'This is an updated version_description.',
|
|
2581
|
+
},
|
|
2582
|
+
);
|
|
2583
|
+
```
|
|
2436
2584
|
|
|
2437
2585
|
</dd>
|
|
2438
2586
|
|
|
@@ -2442,7 +2590,7 @@ Get the request details and state of a given job.
|
|
|
2442
2590
|
|
|
2443
2591
|
</dl>
|
|
2444
2592
|
|
|
2445
|
-
####
|
|
2593
|
+
#### ⚙️ Parameters
|
|
2446
2594
|
|
|
2447
2595
|
<dl>
|
|
2448
2596
|
|
|
@@ -2452,29 +2600,33 @@ Get the request details and state of a given job.
|
|
|
2452
2600
|
|
|
2453
2601
|
<dd>
|
|
2454
2602
|
|
|
2455
|
-
|
|
2456
|
-
await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
2457
|
-
```
|
|
2603
|
+
**id: `string`** — Identifier for a Config. Formatted as a UUID.
|
|
2458
2604
|
|
|
2459
2605
|
</dd>
|
|
2460
2606
|
|
|
2461
2607
|
</dl>
|
|
2462
2608
|
|
|
2463
|
-
|
|
2609
|
+
<dl>
|
|
2464
2610
|
|
|
2465
|
-
|
|
2611
|
+
<dd>
|
|
2466
2612
|
|
|
2467
|
-
|
|
2613
|
+
**version: `number`**
|
|
2468
2614
|
|
|
2469
|
-
|
|
2615
|
+
Version number for a Config.
|
|
2470
2616
|
|
|
2471
|
-
|
|
2617
|
+
Configs, as well as Prompts and Tools, are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.
|
|
2618
|
+
|
|
2619
|
+
Version numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number.
|
|
2620
|
+
|
|
2621
|
+
</dd>
|
|
2622
|
+
|
|
2623
|
+
</dl>
|
|
2472
2624
|
|
|
2473
2625
|
<dl>
|
|
2474
2626
|
|
|
2475
2627
|
<dd>
|
|
2476
2628
|
|
|
2477
|
-
**
|
|
2629
|
+
**request: `Hume.empathicVoice.PostedConfigVersionDescription`**
|
|
2478
2630
|
|
|
2479
2631
|
</dd>
|
|
2480
2632
|
|
|
@@ -2484,7 +2636,7 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2484
2636
|
|
|
2485
2637
|
<dd>
|
|
2486
2638
|
|
|
2487
|
-
**requestOptions: `
|
|
2639
|
+
**requestOptions: `Configs.RequestOptions`**
|
|
2488
2640
|
|
|
2489
2641
|
</dd>
|
|
2490
2642
|
|
|
@@ -2499,32 +2651,14 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2499
2651
|
</dl>
|
|
2500
2652
|
</details>
|
|
2501
2653
|
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
<dl>
|
|
2505
|
-
|
|
2506
|
-
<dd>
|
|
2507
|
-
|
|
2508
|
-
#### 📝 Description
|
|
2509
|
-
|
|
2510
|
-
<dl>
|
|
2654
|
+
## EmpathicVoice Chats
|
|
2511
2655
|
|
|
2512
|
-
<
|
|
2656
|
+
<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>
|
|
2513
2657
|
|
|
2514
2658
|
<dl>
|
|
2515
2659
|
|
|
2516
2660
|
<dd>
|
|
2517
2661
|
|
|
2518
|
-
Get the request details and state of a given job.
|
|
2519
|
-
|
|
2520
|
-
</dd>
|
|
2521
|
-
|
|
2522
|
-
</dl>
|
|
2523
|
-
|
|
2524
|
-
</dd>
|
|
2525
|
-
|
|
2526
|
-
</dl>
|
|
2527
|
-
|
|
2528
2662
|
#### 🔌 Usage
|
|
2529
2663
|
|
|
2530
2664
|
<dl>
|
|
@@ -2536,7 +2670,11 @@ Get the request details and state of a given job.
|
|
|
2536
2670
|
<dd>
|
|
2537
2671
|
|
|
2538
2672
|
```ts
|
|
2539
|
-
await client.
|
|
2673
|
+
await client.empathicVoice.chats.listChats({
|
|
2674
|
+
pageNumber: 0,
|
|
2675
|
+
pageSize: 1,
|
|
2676
|
+
ascendingOrder: true,
|
|
2677
|
+
});
|
|
2540
2678
|
```
|
|
2541
2679
|
|
|
2542
2680
|
</dd>
|
|
@@ -2557,7 +2695,7 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2557
2695
|
|
|
2558
2696
|
<dd>
|
|
2559
2697
|
|
|
2560
|
-
**
|
|
2698
|
+
**request: `Hume.empathicVoice.ChatsListChatsRequest`**
|
|
2561
2699
|
|
|
2562
2700
|
</dd>
|
|
2563
2701
|
|
|
@@ -2567,7 +2705,7 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2567
2705
|
|
|
2568
2706
|
<dd>
|
|
2569
2707
|
|
|
2570
|
-
**requestOptions: `
|
|
2708
|
+
**requestOptions: `Chats.RequestOptions`**
|
|
2571
2709
|
|
|
2572
2710
|
</dd>
|
|
2573
2711
|
|
|
@@ -2582,13 +2720,13 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2582
2720
|
</dl>
|
|
2583
2721
|
</details>
|
|
2584
2722
|
|
|
2585
|
-
<details><summary> <code>client.
|
|
2723
|
+
<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>
|
|
2586
2724
|
|
|
2587
2725
|
<dl>
|
|
2588
2726
|
|
|
2589
2727
|
<dd>
|
|
2590
2728
|
|
|
2591
|
-
####
|
|
2729
|
+
#### 🔌 Usage
|
|
2592
2730
|
|
|
2593
2731
|
<dl>
|
|
2594
2732
|
|
|
@@ -2598,7 +2736,16 @@ await client.expressionMeasurement.batch.getJobDetails('job_id');
|
|
|
2598
2736
|
|
|
2599
2737
|
<dd>
|
|
2600
2738
|
|
|
2601
|
-
|
|
2739
|
+
```ts
|
|
2740
|
+
await client.empathicVoice.chats.listChatEvents(
|
|
2741
|
+
'470a49f6-1dec-4afe-8b61-035d3b2d63b0',
|
|
2742
|
+
{
|
|
2743
|
+
pageNumber: 0,
|
|
2744
|
+
pageSize: 3,
|
|
2745
|
+
ascendingOrder: true,
|
|
2746
|
+
},
|
|
2747
|
+
);
|
|
2748
|
+
```
|
|
2602
2749
|
|
|
2603
2750
|
</dd>
|
|
2604
2751
|
|
|
@@ -2608,7 +2755,7 @@ Get the JSON predictions of a completed measurement or custom models inference j
|
|
|
2608
2755
|
|
|
2609
2756
|
</dl>
|
|
2610
2757
|
|
|
2611
|
-
####
|
|
2758
|
+
#### ⚙️ Parameters
|
|
2612
2759
|
|
|
2613
2760
|
<dl>
|
|
2614
2761
|
|
|
@@ -2618,29 +2765,17 @@ Get the JSON predictions of a completed measurement or custom models inference j
|
|
|
2618
2765
|
|
|
2619
2766
|
<dd>
|
|
2620
2767
|
|
|
2621
|
-
|
|
2622
|
-
await client.expressionMeasurement.batch.getJobPredictions('job_id');
|
|
2623
|
-
```
|
|
2624
|
-
|
|
2625
|
-
</dd>
|
|
2626
|
-
|
|
2627
|
-
</dl>
|
|
2768
|
+
**id: `string`** — Identifier for a Chat. Formatted as a UUID.
|
|
2628
2769
|
|
|
2629
2770
|
</dd>
|
|
2630
2771
|
|
|
2631
2772
|
</dl>
|
|
2632
2773
|
|
|
2633
|
-
#### ⚙️ Parameters
|
|
2634
|
-
|
|
2635
|
-
<dl>
|
|
2636
|
-
|
|
2637
|
-
<dd>
|
|
2638
|
-
|
|
2639
2774
|
<dl>
|
|
2640
2775
|
|
|
2641
2776
|
<dd>
|
|
2642
2777
|
|
|
2643
|
-
**
|
|
2778
|
+
**request: `Hume.empathicVoice.ChatsListChatEventsRequest`**
|
|
2644
2779
|
|
|
2645
2780
|
</dd>
|
|
2646
2781
|
|
|
@@ -2650,7 +2785,7 @@ await client.expressionMeasurement.batch.getJobPredictions('job_id');
|
|
|
2650
2785
|
|
|
2651
2786
|
<dd>
|
|
2652
2787
|
|
|
2653
|
-
**requestOptions: `
|
|
2788
|
+
**requestOptions: `Chats.RequestOptions`**
|
|
2654
2789
|
|
|
2655
2790
|
</dd>
|
|
2656
2791
|
|
|
@@ -2665,32 +2800,14 @@ await client.expressionMeasurement.batch.getJobPredictions('job_id');
|
|
|
2665
2800
|
</dl>
|
|
2666
2801
|
</details>
|
|
2667
2802
|
|
|
2668
|
-
|
|
2669
|
-
|
|
2670
|
-
<dl>
|
|
2671
|
-
|
|
2672
|
-
<dd>
|
|
2673
|
-
|
|
2674
|
-
#### 📝 Description
|
|
2675
|
-
|
|
2676
|
-
<dl>
|
|
2803
|
+
## EmpathicVoice ChatGroups
|
|
2677
2804
|
|
|
2678
|
-
<
|
|
2805
|
+
<details><summary> <code>client.empathicVoice.chatGroups.<a href="./src/api/resources/empathicVoice/resources/chatGroups/client/Client.ts">listChatGroups</a>({ ...params }) -> Hume.ReturnPagedChatGroups</code> </summary>
|
|
2679
2806
|
|
|
2680
2807
|
<dl>
|
|
2681
2808
|
|
|
2682
2809
|
<dd>
|
|
2683
2810
|
|
|
2684
|
-
Get the artifacts ZIP of a completed measurement or custom models inference job.
|
|
2685
|
-
|
|
2686
|
-
</dd>
|
|
2687
|
-
|
|
2688
|
-
</dl>
|
|
2689
|
-
|
|
2690
|
-
</dd>
|
|
2691
|
-
|
|
2692
|
-
</dl>
|
|
2693
|
-
|
|
2694
2811
|
#### 🔌 Usage
|
|
2695
2812
|
|
|
2696
2813
|
<dl>
|
|
@@ -2702,7 +2819,12 @@ Get the artifacts ZIP of a completed measurement or custom models inference job.
|
|
|
2702
2819
|
<dd>
|
|
2703
2820
|
|
|
2704
2821
|
```ts
|
|
2705
|
-
await client.
|
|
2822
|
+
await client.empathicVoice.chatGroups.listChatGroups({
|
|
2823
|
+
pageNumber: 0,
|
|
2824
|
+
pageSize: 1,
|
|
2825
|
+
ascendingOrder: true,
|
|
2826
|
+
configId: '1b60e1a0-cc59-424a-8d2c-189d354db3f3',
|
|
2827
|
+
});
|
|
2706
2828
|
```
|
|
2707
2829
|
|
|
2708
2830
|
</dd>
|
|
@@ -2723,7 +2845,7 @@ await client.expressionMeasurement.batch.getJobArtifacts('string');
|
|
|
2723
2845
|
|
|
2724
2846
|
<dd>
|
|
2725
2847
|
|
|
2726
|
-
**
|
|
2848
|
+
**request: `Hume.empathicVoice.ChatGroupsListChatGroupsRequest`**
|
|
2727
2849
|
|
|
2728
2850
|
</dd>
|
|
2729
2851
|
|
|
@@ -2733,7 +2855,7 @@ await client.expressionMeasurement.batch.getJobArtifacts('string');
|
|
|
2733
2855
|
|
|
2734
2856
|
<dd>
|
|
2735
2857
|
|
|
2736
|
-
**requestOptions: `
|
|
2858
|
+
**requestOptions: `ChatGroups.RequestOptions`**
|
|
2737
2859
|
|
|
2738
2860
|
</dd>
|
|
2739
2861
|
|
|
@@ -2748,32 +2870,12 @@ await client.expressionMeasurement.batch.getJobArtifacts('string');
|
|
|
2748
2870
|
</dl>
|
|
2749
2871
|
</details>
|
|
2750
2872
|
|
|
2751
|
-
<details><summary> <code>client.
|
|
2752
|
-
|
|
2753
|
-
<dl>
|
|
2754
|
-
|
|
2755
|
-
<dd>
|
|
2756
|
-
|
|
2757
|
-
#### 📝 Description
|
|
2758
|
-
|
|
2759
|
-
<dl>
|
|
2760
|
-
|
|
2761
|
-
<dd>
|
|
2873
|
+
<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>
|
|
2762
2874
|
|
|
2763
2875
|
<dl>
|
|
2764
2876
|
|
|
2765
2877
|
<dd>
|
|
2766
2878
|
|
|
2767
|
-
Start a new batch inference job.
|
|
2768
|
-
|
|
2769
|
-
</dd>
|
|
2770
|
-
|
|
2771
|
-
</dl>
|
|
2772
|
-
|
|
2773
|
-
</dd>
|
|
2774
|
-
|
|
2775
|
-
</dl>
|
|
2776
|
-
|
|
2777
2879
|
#### 🔌 Usage
|
|
2778
2880
|
|
|
2779
2881
|
<dl>
|
|
@@ -2785,9 +2887,13 @@ Start a new batch inference job.
|
|
|
2785
2887
|
<dd>
|
|
2786
2888
|
|
|
2787
2889
|
```ts
|
|
2788
|
-
await client.
|
|
2789
|
-
|
|
2790
|
-
{
|
|
2890
|
+
await client.empathicVoice.chatGroups.listChatGroupEvents(
|
|
2891
|
+
'697056f0-6c7e-487d-9bd8-9c19df79f05f',
|
|
2892
|
+
{
|
|
2893
|
+
pageNumber: 0,
|
|
2894
|
+
pageSize: 3,
|
|
2895
|
+
ascendingOrder: true,
|
|
2896
|
+
},
|
|
2791
2897
|
);
|
|
2792
2898
|
```
|
|
2793
2899
|
|
|
@@ -2809,7 +2915,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2809
2915
|
|
|
2810
2916
|
<dd>
|
|
2811
2917
|
|
|
2812
|
-
**
|
|
2918
|
+
**id: `string`** — Identifier for a Chat Group. Formatted as a UUID.
|
|
2813
2919
|
|
|
2814
2920
|
</dd>
|
|
2815
2921
|
|
|
@@ -2819,7 +2925,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2819
2925
|
|
|
2820
2926
|
<dd>
|
|
2821
2927
|
|
|
2822
|
-
**request: `Hume.
|
|
2928
|
+
**request: `Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest`**
|
|
2823
2929
|
|
|
2824
2930
|
</dd>
|
|
2825
2931
|
|
|
@@ -2829,7 +2935,7 @@ await client.expressionMeasurement.batch.startInferenceJobFromLocalFile(
|
|
|
2829
2935
|
|
|
2830
2936
|
<dd>
|
|
2831
2937
|
|
|
2832
|
-
**requestOptions: `
|
|
2938
|
+
**requestOptions: `ChatGroups.RequestOptions`**
|
|
2833
2939
|
|
|
2834
2940
|
</dd>
|
|
2835
2941
|
|