Get Voice User Metadata Config

getVoiceprintVoiceUserMetadataConfig(params?: GetVoiceprintVoiceUserMetadataConfigParams)

Requires:

@tuya-miniapp/cloud-api≥1.x.x

Description

Get the voice user metadata configuration.

Parameters

Parameter	Type	Required	Description
		No	Request parameters

Return Value

Type: Promise<VoiceprintVoiceUserMetadataConfig>

GetVoiceprintVoiceUserMetadataConfigResult (for field meanings, see the type definition and minituya response parameters)

Referenced Types

interfaceVoiceprintVoiceUserMetadataConfigVoice user metadata configuration

Property	Type	Description
`voiceprintVoiceUserAvatarDomain`	string	Domain name for voice user avatars
`voiceprintVoiceUserAvatarObjectKeys`	string[]	List of object keys for voice user avatars
`voiceprintVoiceUserMaxCountOfGid`	number	Maximum number of voice users per home
`autoRegisterVoiceUserExpireMaxDays`	number	Maximum number of days before automatically enrolled voice users expire
`voiceprintProtocolUrl`	string	Voiceprint agreement URL
`textSimilarity`	number	Similarity between ASR text and sample text
		List of supported languages

Examples

Request example

import { getVoiceprintVoiceUserMetadataConfig } from '@tuya-miniapp/cloud-api';

getVoiceprintVoiceUserMetadataConfig()
  .then(result => {
    console.log('Voice user metadata config:', result);
  })
  .catch(error => {
    console.error('Failed to get voice user metadata config:', error);
  });

Response example

{
  "voiceprintVoiceUserAvatarDomain": "https://images.tuyacn.com",
  "voiceprintVoiceUserAvatarObjectKeys": [
    "avatar/1.png"
  ],
  "voiceprintVoiceUserMaxCountOfGid": 10,
  "autoRegisterVoiceUserExpireMaxDays": 30,
  "voiceprintProtocolUrl": "https://example.com/protocol",
  "textSimilarity": 0.8,
  "supportLangs": [
    {
      "lang": "zh",
      "langName": "Chinese",
      "exampleTexts": [
        "The weather is great today"
      ]
    }
  ]
}