Extends

• ArchBaseActionDialogflow

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallDialogflowBot'.

readonly _actionTypeId :string

Returns the action type identifier string from actionTypes.js

readonly dialogflowOutputsFailure :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.

Inherited From:

• ArchBaseActionDialogflow#dialogflowOutputsFailure

environment :string

Returns the environment selected to be used when calling the selected Agent.

Inherited From:

• ArchBaseActionDialogflow#environment

readonly eventName :ArchValueString

The initial event name to pass in to the Dialogflow agent.

Inherited From:

• ArchBaseActionDialogflow#eventName

integrationName :string

Returns the integration name for the currently selected Dialogflow agent.

Inherited From:

• ArchBaseActionDialogflow#integrationName

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 intentProbability :ArchValueDecimal

The confidence of the detected intent. If detected, the value will be >= 0.0 and <= 1.0. If no intent was detected, the value of the variable bound to this setting will remain untouched.

readonly isArchActionCallDialogflowBot :boolean

Returns true indicating that this is an ArchActionCallDialogflowBot instance.

readonly isArchBaseActionDialogflow :boolean

Returns true indicating that this is an ArchBaseActionDialogflow instance.

Inherited From:

• ArchBaseActionDialogflow#isArchBaseActionDialogflow

readonly sessionVariableOutputs :ArchBaseNameValuePairs

Returns the output Session Variables configured on the action. If you are looking for the input Session Variables, see ArchBaseActionBot#sessionVariables.

Methods

addLiveAgentHandoffMetadataNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output Live Agent Handoff Metadata name value pair to the Call Dialogflow CX Bot action that is used to specify the output Live Agent Handoff Metadata property name to retrieve and the corresponding output variable where the value should be stored at runtime. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the Live Agent Handoff Metadata property whose value you want to retrieve
• the value property is an output string value property that specifies the string variable where the runtime value of the output Live Agent Handoff Metadata property will be stored.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the output Live Agent Handoff Metadata property to retrieve.
outputVariable	string | ArchBaseVariable	<optional>	the variable that should hold the value of the Live Agent Handoff Metadata output variable at runtime. For example -> "Flow.MyStringVar"

Returns:

ArchBaseNameValuePair

addSessionParameterOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output session parameter name value pair to the Call Dialogflow CX Bot action that is used to specify the output session property name to retrieve and the corresponding output variable where the value should be stored at runtime. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the output session property whose value you want to retrieve
• the value property is an output string value property that specifies the string variable where the runtime value of the output session property will be stored.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the output session parameter property to retrieve.
outputVariable	string | ArchBaseVariable	<optional>	the variable that should hold the value of the session output variable at runtime. For example -> "Flow.MyStringVar"

Returns:

ArchBaseNameValuePair

addSessionVariableOutputNameValuePair(nameLiteralopt, outputVariableopt) → {ArchBaseNameValuePair}

This adds an output session name value pair to the Call Dialogflow Bot action that is used to specify the output session property name to retrieve and the corresponding output variable where the value should be stored at runtime. On the returned ArchBaseNameValuePair:

• the name property specifies the name of the output session property whose value you want to retrieve
• the value property is an output string value property that specifies the string variable where the runtime value of the output session property will be stored.

Parameters:

Name	Type	Attributes	Description
nameLiteral	string	<optional>	a string that specifies the name of the output session property to retrieve.
outputVariable	string | ArchBaseVariable	<optional>	the variable that should hold the value of the session output variable at runtime. For example -> "Flow.MyStringVar"

Returns:

ArchBaseNameValuePair

setDialogflowAgentByIdAsync(dialogflowAgentId, callbackFunctionopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its identifier. The Draft environment will be selected when calling this function.

Parameters:

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

Returns:

Promise.<ArchBaseActionDialogflow>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByIdAsync

setDialogflowAgentByIdWithEnvironmentAsync(dialogflowAgentId, environmentName, callbackFunctionopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its identifier and sets the environment to use by its name.

Parameters:

Name	Type	Attributes	Description
dialogflowAgentId	string		the identifier of the Dialogflow agent
environmentName	string		the name of the Dialogflow agent's environment to use. If no value is passed, 'Draft' will be used.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.

Returns:

Promise.<ArchBaseActionDialogflow>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByIdWithEnvironmentAsync

setDialogflowAgentByNameAsync(agentName, projectIdopt, callbackFunctionopt, integrationNameopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its name. The Draft environment will be selected when calling this function.

Parameters:

Name	Type	Attributes	Description
agentName	string		the name of the Dialogflow agent to set.
projectId	string	<optional>	optional parameter for filtering by the agent's project ID.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.
integrationName	string	<optional>	optional parameter for filtering by the agent's integration name.

Returns:

Promise.<ArchBaseActionDialogflow>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByNameAsync

setDialogflowAgentByNameWithEnvironmentAsync(agentName, environmentName, projectIdopt, callbackFunctionopt, integrationNameopt) → {Promise.<ArchBaseActionDialogflow>}

This sets the Dialogflow agent to call at runtime by its name and sets the environment to use by its name.

Parameters:

Name	Type	Attributes	Description
agentName	string		the name of the Dialogflow agent to set.
environmentName	string		the name of the Dialogflow agent's environment to use. If no value is passed, 'Draft' will be used.
projectId	string	<optional>	optional parameter for filtering by the agent's project ID.
callbackFunction	callbackArchBaseActionDialogflow	<optional>	a callback function to call if the Dialogflow agent is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect Call Dialogflow Bot action instance.
integrationName	string	<optional>	optional parameter for filtering by the agent's integration name.

Returns:

Promise.<ArchBaseActionDialogflow>

Inherited From:

• ArchBaseActionDialogflow#setDialogflowAgentByNameWithEnvironmentAsync