Google Cloud Ces V1 Client - Class RemoteDialogflowAgent (0.2.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class RemoteDialogflowAgent.

The agent which will transfer execution to a remote Dialogflow CX agent.

The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.

Generated from protobuf message google.cloud.ces.v1.Agent.RemoteDialogflowAgent

Namespace

Google \ Cloud \ Ces \ V1 \ Agent

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ agent
string

Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}

↳ flow_id
string

Optional. The flow ID of the flow in the Dialogflow agent.

↳ environment_id
string

Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.

↳ input_variable_mapping
array| Google\Protobuf\Internal\MapField

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

↳ output_variable_mapping
array| Google\Protobuf\Internal\MapField

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

↳ respect_response_interruption_settings
bool

Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * * If true: only response messages with allow_playback_interruption set to true will be interruptable, all other messages follow the app-level barge-in settings.

getAgent

Required. The Dialogflow agent resource name.

Format: projects/{project}/locations/{location}/agents/{agent}

Returns
Type
Description
string

setAgent

Required. The Dialogflow agent resource name.

Format: projects/{project}/locations/{location}/agents/{agent}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFlowId

Optional. The flow ID of the flow in the Dialogflow agent.

Returns
Type
Description
string

setFlowId

Optional. The flow ID of the flow in the Dialogflow agent.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEnvironmentId

Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.

Returns
Type
Description
string

setEnvironmentId

Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInputVariableMapping

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

Returns
Type
Description

setInputVariableMapping

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

Parameter
Name
Description
Returns
Type
Description
$this

getOutputVariableMapping

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

Returns
Type
Description

setOutputVariableMapping

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

Parameter
Name
Description
Returns
Type
Description
$this

getRespectResponseInterruptionSettings

Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent.

  • If false: all response messages from the Dialogflow agent follow the app-level barge-in settings.
  • If true: only response messages with allow_playback_interruption set to true will be interruptable, all other messages follow the app-level barge-in settings.
Returns
Type
Description
bool

setRespectResponseInterruptionSettings

Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent.

  • If false: all response messages from the Dialogflow agent follow the app-level barge-in settings.
  • If true: only response messages with allow_playback_interruption set to true will be interruptable, all other messages follow the app-level barge-in settings.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: