DialogflowParam Element

The DialogflowParam element can be used to engage the Google Dialogflow services. The DialogflowParamelement is located under the Customer Virtual Assistant group in the Call Studio Elements. This elementis an extension of Form element and it engages the Speech Server resource on VVB to communicate withthe Google Speech-to-Text Server to get user input and then send it to Dialogflow and fills param valuefrom it. To indicate the Dialogflow server resource requirement, Call Studio creates a specific grammar -builtin:speech/transcribe - and sends it to VVB in VXML Page.

The DialogflowParam element works only in VoiceXML 2.1 with Cisco DTMF VoiceXMLGateway adaptor.

Note

• Settings, on page 1• Custom VoiceXML Properties, on page 4• Element Data, on page 5• Exit States, on page 6• Audio Group, on page 6• Folder and Class Information, on page 7• Events, on page 7

SettingsNotesDefaultSubstitution

AllowedSingleSettingValue

RequiredTypeName (Label)

The type of entryallowed for input.

voicefalsetrueYesstringInput Mode

Possible values arevoice (voice only)and dtmf+voice

(DTMF and voice).

The maximumduration allowed for

5struetrueYesint ≥ 0NoInput Timeout

silence before aNoInput event is

DialogflowParam Element1

NotesDefaultSubstitutionAllowed

SingleSettingValue

RequiredTypeName (Label)

triggered. Possiblevalues are standardtime designationsincludingnon-negativenumbers and a timeunit. For example,3s (for seconds) or300 ms (formilliseconds).

The maximumnumber of noinput

3truetrueYesint ≥ 0Max NoInput Count

events allowedduring input capture.Possible values areint > 0 where 0indicates infiniteNoInput eventspermitted.

The maximumnumber of NoMatch

3truetrueYesint ≥ 0Max NoMatch Count

events allowedduring DTMF inputcapture. Possiblevalues are int > 0

where 0 indicatesinfinite NoMatchevents permitted.

This option ismandatory only if

NoneyestrueYesstringDTMF Grammar

the input modeselected is DTMFand voice. Itsupports CiscoDTMF regex.

This option ismandatory only if

truetruetrueYesbooleanSend Digits to DF

the input modeselected is DTMFand voice. It enablesor disablessubmitting digitscollected to theDialogflow.

DialogflowParam Element2

DialogflowParam ElementSettings

NotesDefaultSubstitutionAllowed

SingleSettingValue

RequiredTypeName (Label)

Indicates whetherlogging of

falsetruetrueYesbooleanSecure Logging

potentially sensitivedata of the elementis enabled. If this isset to true, theelement's potentiallysensitive data is notlogged.

Terminates the voicestream or DTMFcollection.

#truetrueNoStringTermination Character

The maximum time(in seconds) the

30struetrueYesint ≥ 0Max Input Time

voice input isallowed to last.Possible values arepositive integervalues followed by s(seconds). Forexample, 50s.Default value is 30s.

The interval ofsilence (in seconds

1struetrueYesint > 0Final Silence

or milliseconds) thatindicates the end ofspeech. Possiblevalues are positiveinteger valuesfollowed by either s(seconds) or ms(milliseconds). Forexample, 3s and3000ms. Defaultvalue is 1s.

The current intent tobe processed forparameter extraction.

NonefalsetrueYesstringintent

The variable to beprocessed for a

NonefalsetrueYesstringvariable

particular intentmentioned in intentfield.

DialogflowParam Element3

DialogflowParam ElementSettings

NotesDefaultSubstitutionAllowed

SingleSettingValue

RequiredTypeName (Label)

Variablenameshouldmatch theone definedin GoogleDialogflow.

Note

This indicates end ofparameter capture. If

falsetruetrueYesbooleanLast Parameter

it is set to true, theintent is marked ascomplete.

This is commaseparated string that

NonetruetrueNoStringRecognize.phraseHints

lists the hints forrecognition.

Hints are used torecognize a phrase ora word that ispronounceddifferently.

For example,Savings, Current.

Custom VoiceXML PropertiesNotesTypeName (Label)

Sets the payload to be sent toDialogflow.

JSONDialogflow.queryParams

.payload

Sets the timezone to be sentto Dialogflow.

StringDialogflow.queryParams

.timeZone

For example,America/New_York,Europe/Paris.

Sets the geographical locationto be sent to Dialogflow.

String

(comma separated value)

Dialogflow.queryParams.geoLocation

For example, "50.0,50.0".

DialogflowParam Element4

DialogflowParam ElementCustom VoiceXML Properties

NotesTypeName (Label)

Sets the additional entity typesto be sent to Dialogflow.

JSONDialogflow.queryParams.

sessionEntityTypes

For example, [{'name':'class','entityOverrideMode':

'ENTITY_OVERRIDE_MODE_OVERRIDE','entities':

[{'value':

'economy','synonyms':

['eco', 'economy']}]}].

Configures the type ofsentiment analysis to perform.

BooleanDialogflow.queryParams

.sentimentAnalysisRequestConfig If not provided, sentimentanalysis is not performed.

SentimentAnalysis iscurrently availableonly for EnterpriseEdition agents.

Note

Element DataThe following table lists the data that is stored in element after processing the DialogflowParam element.

DescriptionElement Data

This is the action parameter from Dialogflow.action

This is fulfillment text from Dialogflow.fulillment_text

Indicates the type of input captured (dtmf or dtmf+voice).input_type

Indicates the intent of a parameter.intent

Contains JSON response from Dialogflow.json

For response formats, see json details in the Dialogflow ElementData.

Contains JSON response from Speech Recognition.asr_json

Indicates the parameter value as uttered by the user in string.original_value

This is the parameter value returned by Dialogflow if input type isvoice.

value

If input type is dtmf, it contains the DTMF key that is pressed by theuser.

DialogflowParam Element5

DialogflowParam ElementElement Data

DescriptionElement Data

The Speech recognition confidence between 0.0 and 1.0. A highernumber indicates a greater probability that the recognized words are

confidence

correct. The default of 0.0 is a sentinel value indicating that confidencewas not set.

Sentiment score of the user input.sentiment_score

Exit StatesDescriptionExit State

This is returned when the configured parameter is filled.Done

This is returned when Dialogflow switches to a different intent whosefilling slot is based on user utterance.

Intent_Change

This state is encountered when there is no input from the user for aspecified duration as configured in the setting.

MAX_NoInput

This state is returned when the variable or parameter mentioned inelement setting is not matched for specified number of times asmentioned in settings.

MAX_NoMatch

If the input type is dtmf+voice, this state is encountered when theDTMF input does not match regex grammar for the specified numberof times as mentioned in settings.

Audio Group

Form Data CaptureNotesMax1RequiredName (Label)

Played when the voiceelement begins.

YesYesinitial_audio_group

(Initial)

Played when a NoMatchevent occurs.

NoNonomatch_audio_group

(NoMatch)

This is applicable onlywhen the input type isdtmf+voice.

Played when a NoInputevent occurs.

NoNonoinput_audio_group

(NoInput)

DialogflowParam Element6

DialogflowParam ElementExit States

EndNotesMax1RequiredName (Label)

Played when the formdata capture is completed

YesNodone_audio_group

(Done)and the voice elementexits with the Done exitstate.

Folder and Class InformationClass NameStudio Element Folder Name

com.audium.server.voiceElement.formForm

EventsNotesName (Label)

You can select Java Exception, VXML Event, or Hotlink as the eventhandler for this element.

Event Type

DialogflowParam Element7

DialogflowParam ElementEnd

DialogflowParam Element8

DialogflowParam ElementEvents