Rate this page:

AvatarResponseParameters

Parameters of the generateResponse method that generates an avatar response object.

Props

channelParameters

Copy URL
channelParameters: 

ChannelParameters

Optional. Avatar text and voice channel parameters

currentState

Copy URL
currentState: 

string

|

undefined

Optional. Current avatar state

customData

Copy URL
customData: 

Object

Optional. Additional data returned from an avatar. Can be obtained in the platform scenario VoximplantAvatar.Events.Reply and VoximplantAvatar.Events.Finish events via customData parameter

interruptableAfter

Copy URL
interruptableAfter: 

number

|

undefined

Optional. Time after which an avatar is ready to handle customer's interruptions (in case the avatar voices its response)

isFinal

Copy URL
isFinal: 

false

|

undefined

|

true

Optional. 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. Whether the avatar listens to the customer after saying its line (or during the line if interruptions are enabled). Disregard if the 'nextState' parameter is specified

listenTimeout

Copy URL
listenTimeout: 

number

|

undefined

Optional. Timeout for listening to the customer's utterance in milliseconds. If there is no customer's utterance during this period of time, AvatarState.onTimeout callback function is called. Overrides the VoiceAvatarConfig.defaultListenTimeout parameter for the current response. If not specified for the text avatar, the waiting time is not limited

nextState

Copy URL
nextState: 

string

|

undefined

Optional. Next avatar state.

nluHint

Copy URL
nluHint: 

AvatarNluHint

Optional. Hint for NLU processor

utterance

Copy URL
utterance: 

string

|

undefined

Optional. Phrase to reply to the user with