Rate this page:

AvatarConfig

Avatar configuration object. Can be passed as arguments to the VoximplantAvatar.createAvatar method.

Props

avatarId

Copy URL
avatarId: 

string

Unique avatar id.

customData

Copy URL
customData: 

Object

Optional. Set of key-value pairs to be passed to an avatar for personalization (e.g., a customer's name). Can be obtained in the avatar script via getCustomData function.

extended

Copy URL
extended: 

false

|

undefined

|

true

Optional. Whether an avatar should return detailed information on recognizing the user input (i.e. whether the intents are passed to VoximplantAvatar.Events.UtteranceParsed in the avatar script). NOTE: starting from the text implementation the avatar always returns detailed information.