Class Page (0.8.0)

Page(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 <https://cloud.google.com/dialogflow/cx/docs/concept/page>__.

Attributes: name (str): The unique identifier of the page. Required for the [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. display_name (str): Required. The human-readable name of the page, unique within the agent. entry_fulfillment (google.cloud.dialogflowcx_v3.types.Fulfillment): The fulfillment to call when the session is entering the page. form (google.cloud.dialogflowcx_v3.types.Form): The form associated with the page, used for collecting parameters relevant to the page. transition_route_groups (Sequence[str]): Ordered list of [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page. Transition route groups must be unique within a page.

    -  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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>``.
transition_routes (Sequence[google.cloud.dialogflowcx_v3.types.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.
event_handlers (Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]):
    Handlers associated with the page to handle
    events such as webhook errors, no match or no
    input.

Inheritance

builtins.object > proto.message.Message > Page