Rate this page:

AvatarResponse

Parameters of the Response() method that generates an avatar response object.

Props

customData

Copy URL
customData: 

Record

Additional data returned from an avatar

interruptableAfter

Copy URL
interruptableAfter: 

undefined

|

number

Time after which an avatar is ready to handle user interruptions (in case the avatar voices its response)

isFinal

Copy URL
isFinal: 

undefined

|

false

|

true

Boolean value that specifies whether an avatar's reply is final. If set to true, all other parameters except customData are ignored and the avatar does not process any more inputs in the current conversation

listen

Copy URL
listen: 

undefined

|

true

Optional boolean value that specifies whether an avatar will listen to the user after saying its line (or during the line if interruptions are enabled)

nextState

Copy URL
nextState: 

undefined

|

string

Next avatar state. Optional value

utterance

Copy URL
utterance: 

undefined

|

string

Phrase to reply to the user with