Rate this page:

AvatarResponseParameters

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

Props

currentState

Copy URL
currentState: 

string

|

undefined

Current avatar state.

customData

Copy URL
customData: 

Object

Additional data returned from an avatar

interruptableAfter

Copy URL
interruptableAfter: 

number

|

undefined

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

isFinal

Copy URL
isFinal: 

false

|

undefined

|

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: 

true

|

undefined

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

listenTimeout

Copy URL
listenTimeout: 

number

|

undefined

Timeout for listening for customer's utterance

nextState

Copy URL
nextState: 

string

|

undefined

Next avatar state. Optional value

nluHint

Copy URL
nluHint: 

AvatarNluHint

Optional hint for NLU processor

utterance

Copy URL
utterance: 

string

|

undefined

Phrase to reply to the user with