DialogflowInstance

Constructor

1
new DialogflowInstance(id: string, parameters: Object)

Parameters

1
new DialogflowInstance(id: string, parameters: Object)

Parameters

Methods

addEventListener

Adds a handler for the specified AI.Events. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: AI.Events | T, callback: (event: AI._Events[T]) => any): void

Parameters

addMarker

Add a Dialogflow speech synthesis playback marker. The AI.Events.DialogflowPlaybackMarkerReached(/docs/references/voxengine/ai/events#dialogflowplaybackmarkerreached) event is triggered when the marker is reached.

1
addMarker(offset: number): void

Parameters

id

Returns the dialogflow instance’s id.

1
id(): string

removeEventListener

Removes a handler for the specified AI.Events event.

1
removeEventListener(event: AI.Events | T, callback?: (event: AI._Events[T]) => any): void

Parameters

sendMediaTo

Starts sending media (voice) from a Dialogflow participant to the media unit.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

sendQuery

Send a query to the DialogFlow instance. You can send either a text string up to 256 characters or an event object with the event name and additional data.

1
sendQuery(dialogflowQuery: DialogflowQueryInput): void

Parameters

setOutputAudioConfig

Update the audio output configuration.

1
setOutputAudioConfig(outputAudioConfig: DialogflowOutputAudioConfig): void

Parameters

setPhraseHints

Set a collection of phrase hints for the intents.

1
setPhraseHints(phraseHints: { [id: string]: string }): void

Parameters

setQueryParameters

Set parameters for the intents.

1
setQueryParameters(queryParameters: DialogflowQueryParameters): void

Parameters

stop

Stop and destroy the current Dialogflow instance.

1
stop(): void

stopMediaTo

Stops sending media (voice) from a Dialogflow participant to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters