Class: Google::Cloud::Dialogflow::CX::V3::Page

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/page.rb

Overview

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the Page guide.

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns:



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns The description of the page. The maximum length is 500 characters.

Returns:

  • (::String) —

    The description of the page. The maximum length is 500 characters.



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the page, unique within the flow.

Returns:

  • (::String) —

    Required. The human-readable name of the page, unique within the flow.



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entry_fulfillment ⇒ ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns The fulfillment to call when the session is entering the page.

Returns:



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#event_handlers ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>

Returns Handlers associated with the page to handle events such as webhook errors, no match or no input.

Returns:



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#form ⇒ ::Google::Cloud::Dialogflow::CX::V3::Form

Returns The form associated with the page, used for collecting parameters relevant to the page.

Returns:



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#knowledge_connector_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings

Returns Optional. Knowledge connector configuration.

Returns:



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Returns:

  • (::String) —

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transition_route_groups ⇒ ::Array<::String>

Returns Ordered list of TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones.

  • If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes.

  • If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence.

Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.

Returns:

  • (::Array<::String>) —

    Ordered list of TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones.

    • If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes.

    • If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence.

    Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.



118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transition_routes ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>

Returns A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow.

When we are in a certain page, the TransitionRoutes are evalauted in the following order:

  • TransitionRoutes defined in the page with intent specified.
  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with intent specified.
  • TransitionRoutes defined in flow with intent specified.
  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Flow.transition_route_groups] with intent specified.
  • TransitionRoutes defined in the page with only condition specified.
  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with only condition specified.

Returns:

  • (::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>) —

    A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow.

    When we are in a certain page, the TransitionRoutes are evalauted in the following order:

    • TransitionRoutes defined in the page with intent specified.
    • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with intent specified.
    • TransitionRoutes defined in flow with intent specified.
    • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Flow.transition_route_groups] with intent specified.
    • TransitionRoutes defined in the page with only condition specified.
    • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with only condition specified.


118
119
120
121
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 118

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end