DialogflowInstance
This class represents an instance of the Dialogflow instance. Add the following line to your scenario code to use the class:
require(Modules.AI);
Methods
addEventListener
addEventListener(event: , callback: Function
): void
Add a handler for specific event generated by the specified Dialogflow instance. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler will be called.
Parameters
event:
callback:
Function
Handler function
Returns
type:
void
addMarker
addMarker(offset: number
): void
Add Dialogflow speech synthesis playback marker. The AI.Events.DialogflowPlaybackMarkerReached event will be triggered when the marker is reached.
Parameters
offset:
number
Positive/negative offset (ms) from the start/end of media.
Returns
type:
void
removeEventListener
removeEventListener(event: , callback: Function
): void
Remove the event handler for specific event generated by the specified Dialogflow instance.
Parameters
event:
The AI.DialogflowError, AI.DialogflowQueryResult or AI.DialogflowRecognitionResult event.
callback:
Function
OptionalHandler function. If not specified, all event listeners are removed
Returns
type:
void
sendMediaTo
sendMediaTo(targetMediaUnit: , optional: ): void
Parameters
targetMediaUnit:
optional:
Optional
Returns
type:
void
sendQuery
sendQuery(dialogflowQuery: ): void
Send a query to the DialogFlow instance. You can send either text string up to 256 characters or the event object with the event name and the additional data.
Parameters
dialogflowQuery:
Text string (up to 256 characters) or the event object.
Returns
type:
void
setOutputAudioConfig
setOutputAudioConfig(outputAudioConfig: ): void
Update audio output parameter
Parameters
outputAudioConfig:
Returns
type:
void
setPhraseHints
setPhraseHints(phraseHints: {[id: string]: string}
): void
Set the collection of phrase hints for the intents.
Parameters
phraseHints:
{[id: string]: string}
The collection of phrase hints which are used to boost accuracy of speech recognition.
Returns
type:
void
setQueryParameters
setQueryParameters(queryParameters: ): void
Set the parameters for the intents.
Parameters
queryParameters:
Returns
type:
void
stop
stop(): void
Stop and destroy current Dialogflow instance
Returns
type:
void
stopMediaTo
stopMediaTo(targetMediaUnit: ): void
Parameters
targetMediaUnit:
Returns
type:
void