Google Cloud Dialogflow Cx V3 Client - Class Page (0.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.

Generated from protobuf message google.cloud.dialogflow.cx.v3.Page

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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>.
↳ display_name string

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

The description of the page. The maximum length is 500 characters.
↳ entry_fulfillment Fulfillment

The fulfillment to call when the session is entering the page.
↳ form Form

The form associated with the page, used for collecting parameters relevant to the page.
↳ transition_route_groups array

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 array<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 with intent specified. * * TransitionRoutes defined in flow with intent specified. * * TransitionRoutes defined in the transition route groups with intent specified. * * TransitionRoutes defined in the page with only condition specified. * * TransitionRoutes defined in the transition route groups with only condition specified.
↳ event_handlers array<EventHandler>

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

Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
↳ knowledge_connector_settings KnowledgeConnectorSettings

Optional. Knowledge connector configuration.

getName

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
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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

Returns
Type Description
string

setDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$this

getEntryFulfillment

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

Returns
Type Description
Fulfillment|null

hasEntryFulfillment

clearEntryFulfillment

setEntryFulfillment

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

Parameter
Name Description
var Fulfillment
Returns
Type Description
$this

getForm

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

Returns
Type Description
Form|null

hasForm

clearForm

setForm

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

Parameter
Name Description
var Form
Returns
Type Description
$this

getTransitionRouteGroups

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
Type Description
Google\Protobuf\Internal\RepeatedField

setTransitionRouteGroups

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.
Parameter
Name Description
var string[]
Returns
Type Description
$this

getTransitionRoutes

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 with intent specified.
  • TransitionRoutes defined in flow with intent specified.
  • TransitionRoutes defined in the transition route groups with intent specified.
  • TransitionRoutes defined in the page with only condition specified.
  • TransitionRoutes defined in the transition route groups with only condition specified.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTransitionRoutes

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 with intent specified.
  • TransitionRoutes defined in flow with intent specified.
  • TransitionRoutes defined in the transition route groups with intent specified.
  • TransitionRoutes defined in the page with only condition specified.
  • TransitionRoutes defined in the transition route groups with only condition specified.
Parameter
Name Description
var array<TransitionRoute>
Returns
Type Description
$this

getEventHandlers

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEventHandlers

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

Parameter
Name Description
var array<EventHandler>
Returns
Type Description
$this

getAdvancedSettings

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

Returns
Type Description
AdvancedSettings|null

hasAdvancedSettings

clearAdvancedSettings

setAdvancedSettings

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

Parameter
Name Description
var AdvancedSettings
Returns
Type Description
$this

getKnowledgeConnectorSettings

Optional. Knowledge connector configuration.

Returns
Type Description
KnowledgeConnectorSettings|null

hasKnowledgeConnectorSettings

clearKnowledgeConnectorSettings

setKnowledgeConnectorSettings

Optional. Knowledge connector configuration.

Parameter
Name Description
var KnowledgeConnectorSettings
Returns
Type Description
$this