AvatarResponseParameters
Parameters of the generateResponse method that generates an avatar response object.
Props
channelParameters
channelParameters: Optional. Avatar text and voice channel parameters
currentState
currentState: string
| undefined
Optional. Current avatar state
customData
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
interruptableAfter: number
| undefined
Optional. Time after which an avatar is ready to handle customer's interruptions (in case the avatar voices its response)
isFinal
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
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
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
nextState: string
| undefined
Optional. Next avatar state.
utterance
utterance: string
| undefined
Optional. Phrase to reply to the user with