Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::TransitionRoute (v1.3.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::TransitionRoute.

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

  • If there is a trigger_fulfillment associated with the transition, it will be called.
  • If there is a target_page associated with the transition, the session will transition into the specified page.
  • If there is a target_flow associated with the transition, the session will transition into the specified flow.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#condition

def condition() -> ::String
Returns
  • (::String) — The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

#condition=

def condition=(value) -> ::String
Parameter
  • value (::String) — The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Returns
  • (::String) — The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the transition route. The maximum length is 500 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the transition route. The maximum length is 500 characters.
Returns
  • (::String) — Optional. The description of the transition route. The maximum length is 500 characters.

#intent

def intent() -> ::String
Returns
  • (::String) — The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

#intent=

def intent=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.
Returns
  • (::String) — The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The unique identifier of this transition route.

#target_flow

def target_flow() -> ::String
Returns
  • (::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

#target_flow=

def target_flow=(value) -> ::String
Parameter
  • value (::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
Returns
  • (::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

#target_page

def target_page() -> ::String
Returns
  • (::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

#target_page=

def target_page=(value) -> ::String
Parameter
  • value (::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
Returns
  • (::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

#trigger_fulfillment

def trigger_fulfillment() -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.

#trigger_fulfillment=

def trigger_fulfillment=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.