Extends

• ArchBaseActionBot

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallDialogEngineBot'.

readonly _actionTypeId :string

Returns the action type identifier string from actionTypes.js

readonly dialogEngineOutputsFailure :ArchNamedValueList

The contents of this named value list come from the Failure Outputs schema. It will contain two values: errorType and errorMessage. These values will be returned by the server if the action takes the Failure path.

readonly followupResponseTimeout :ArchValueDuration

Specifies the amount of time to wait for a user's response to a bot prompt. A negative or NOT_SET duration will be treated as immediate.

Inherited From:

• ArchBaseActionBot#followupResponseTimeout

readonly inputText :ArchValueString

The input text for the bot. This is usually only set in flows when chaining bot actions together.

Inherited From:

• ArchBaseActionBot#inputText

readonly intentNames :Array.<string>

Returns a unique array of names of intents that are configured for the selected bot. This array contains intent names for the bot that will be executed at flow runtime. As such, for some bots like Lex bots, this requires selecting the Lex bot alias since intents are defined on the alias prior to this array being populated.

Inherited From:

• ArchBaseActionBot#intentNames

readonly intentParameters :ArchNamedValueList

The collection of intents and their parameters into which variables can be assigned. To access an intent, you can use the getNamedValueByName function on this property and pass in the name of the intent you want to access. That intent will contain its parameters, which you can access also via getNamedValueByName.

readonly isArchActionCallDialogEngineBot :boolean

Returns true indicating that this is an ArchActionCallDialogEngineBot instance.

readonly outputKnowledge :ArchActionOutput

The Knowledge output for this action. This output will be available if the currently selected Dialog Engine bot has Knowledge enabled on it.

readonly outputNoIntent :ArchActionOutput

The No Intent output for this action.

readonly terminationState :ArchValueString

The termination state for the Dialog Engine bot runtime invocation. Possible runtime output string values are 'AgentEscalation', 'Error', 'Expired', 'Failure' or 'GoalReached'.

Methods

addSessionParameterNameValuePair(nameLiteralopt, valueExpressionopt) → {ArchBaseNameValuePair}

This adds a session parameter name value pair to the Call Dialogflow CX Bot action that is used to specify the session parameter''s name and corresponding value that should be assigned to it. This function functions the same as ArchBaseActionBot#addSessionVariableNameValuePair and exists because Session Variables are called Session Parameters in Dialogflow CX. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the session parameter whose value you want to set
• the value property is the value to set on the session parameter at runtime.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the session parameter to set.
valueExpression	string	<optional>	a string expression that specifies the value to set on the session parameter.

Returns:

ArchBaseNameValuePair

Inherited From:

• ArchBaseActionBot#addSessionParameterNameValuePair

getOutputByIntentName(intentName) → {ArchActionOutput}

This gets an action output for this action that matches an intent name. It will not return the built-in Failure output.

Parameters:

Name	Type	Description
intentName	string	the name of the intent whose matching output to find

Returns:

ArchActionOutput

Inherited From:

• ArchBaseActionBot#getOutputByIntentName

setDialogEngineBotByIdAsync(dialogEngineBotId, callbackFunctionopt) → {Promise.<ArchActionCallDialogEngineBot>}

This sets the Dialog Engine bot to call at runtime by its identifier.

Parameters:

Name	Type	Attributes	Description
dialogEngineBotId	string		the identifier of the Dialog Engine bot
callbackFunction	callbackArchActionCallDialogEngineBot	<optional>	a callback function to call if the Dialog Engine bot is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialog Engine Bot action instance.

Returns:

Promise.<ArchActionCallDialogEngineBot>

setDialogEngineBotByNameAsync(botName, callbackFunctionopt) → {Promise.<ArchActionCallDialogEngineBot>}

This sets the Dialog Engine bot to call at runtime by its name.

Parameters:

Name	Type	Attributes	Description
botName	string		the name of the Dialog Engine bot to set.
callbackFunction	callbackArchActionCallDialogEngineBot	<optional>	a callback function to call if the Dialog Engine bot is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialog Engine Bot action instance.

Returns:

Promise.<ArchActionCallDialogEngineBot>