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

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

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#advanced_settings

def advanced_settings() -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.

#advanced_settings=

def advanced_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns

(::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.

#description

def description() -> ::String

Returns

(::String) — The description of the page. The maximum length is 500 characters.

#description=

def description=(value) -> ::String

Parameter

value (::String) — The description of the page. The maximum length is 500 characters.

Returns

(::String) — The description of the page. The maximum length is 500 characters.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The human-readable name of the page, unique within the flow.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — 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.

#entry_fulfillment

def entry_fulfillment() -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns

(::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the session is entering the page.

#entry_fulfillment=

def entry_fulfillment=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the session is entering the page.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Fulfillment) — The fulfillment to call when the session is entering the page.

#event_handlers

def event_handlers() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — Handlers associated with the page to handle events such as webhook errors, no match or no input.

#event_handlers=

def event_handlers=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — Handlers associated with the page to handle events such as webhook errors, no match or no input.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — Handlers associated with the page to handle events such as webhook errors, no match or no input.

#form

def form() -> ::Google::Cloud::Dialogflow::CX::V3::Form

Returns

(::Google::Cloud::Dialogflow::CX::V3::Form) — The form associated with the page, used for collecting parameters relevant to the page.

#form=

def form=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Form

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Form) — The form associated with the page, used for collecting parameters relevant to the page.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Form) — The form associated with the page, used for collecting parameters relevant to the page.

#knowledge_connector_settings

def knowledge_connector_settings() -> ::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings) — Optional. Knowledge connector configuration.

#knowledge_connector_settings=

def knowledge_connector_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings) — Optional. Knowledge connector configuration.

Returns

(::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings) — Optional. Knowledge connector configuration.

#name

def name() -> ::String

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>.

#name=

def name=(value) -> ::String

Parameter

value (::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>.

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>.

#transition_route_groups

def transition_route_groups() -> ::Array<::String>

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.

#transition_route_groups=

def transition_route_groups=(value) -> ::Array<::String>

Parameter

value (::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.

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.

#transition_routes

def transition_routes() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>

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.

#transition_routes=

def transition_routes=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>

Parameter

value (::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.

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.