Class Flow (1.42.0) 

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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Attributes
Name Description
name str
The unique identifier of the flow. Format: projects/.
display_name str
Required. The human-readable name of the flow.
description str
The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
transition_routes MutableSequence[google.cloud.dialogflowcx_v3beta1.types.TransitionRoute]
A flow's transition routes serve two purposes: - They are responsible for matching the user's first utterances in the flow. - They are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evaluated in the following order: - TransitionRoutes with intent specified. - TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.
event_handlers MutableSequence[google.cloud.dialogflowcx_v3beta1.types.EventHandler]
A flow's event handlers serve two purposes: - They are responsible for handling events (e.g. no match, webhook errors) in the flow. - They are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
transition_route_groups MutableSequence[str]
A flow's transition route group serve two purposes: - They are responsible for matching the user's first utterances in the flow. - They are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow. Format:\ projects/ or projects/ for agent-level groups.
nlu_settings google.cloud.dialogflowcx_v3beta1.types.NluSettings
NLU related settings of the flow.
advanced_settings google.cloud.dialogflowcx_v3beta1.types.AdvancedSettings
Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
knowledge_connector_settings google.cloud.dialogflowcx_v3beta1.types.KnowledgeConnectorSettings
Optional. Knowledge connector configuration.
multi_language_settings google.cloud.dialogflowcx_v3beta1.types.Flow.MultiLanguageSettings
Optional. Multi-lingual agent settings for this flow.
locked bool
Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.

Classes

MultiLanguageSettings

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

Settings for multi-lingual agents.