Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::Agent::RemoteDialogflowAgent (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::Agent::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#agent

def agent() -> ::String
Returns
  • (::String) — Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}

#agent=

def agent=(value) -> ::String
Parameter
  • value (::String) — Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}
Returns
  • (::String) — Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}

#environment_id

def environment_id() -> ::String
Returns
  • (::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.

#environment_id=

def environment_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#flow_id

def flow_id() -> ::String
Returns
  • (::String) — Optional. The flow ID of the flow in the Dialogflow agent.

#flow_id=

def flow_id=(value) -> ::String
Parameter
  • value (::String) — Optional. The flow ID of the flow in the Dialogflow agent.
Returns
  • (::String) — Optional. The flow ID of the flow in the Dialogflow agent.

#input_variable_mapping

def input_variable_mapping() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

#input_variable_mapping=

def input_variable_mapping=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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

def output_variable_mapping() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#output_variable_mapping=

def output_variable_mapping=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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

def respect_response_interruption_settings() -> ::Boolean
Returns
  • (::Boolean) —

    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.

#respect_response_interruption_settings=

def respect_response_interruption_settings=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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
  • (::Boolean) —

    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.