Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Flow (v1.0.0)

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

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.

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 flow. 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 flow. 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 flow. 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 flow. The maximum length is 500 characters. If exceeded, the request is rejected.

#description=

def description=(value) -> ::String

Parameter

value (::String) — The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns

(::String) — The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The human-readable name of the flow.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The human-readable name of the flow.

Returns

(::String) — Required. The human-readable name of the flow.

#event_handlers

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

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::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.

#event_handlers=

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

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::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.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::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.

#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 flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#name=

def name=(value) -> ::String

Parameter

value (::String) — The unique identifier of the flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns

(::String) — The unique identifier of the flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#nlu_settings

def nlu_settings() -> ::Google::Cloud::Dialogflow::CX::V3::NluSettings

Returns

(::Google::Cloud::Dialogflow::CX::V3::NluSettings) — NLU related settings of the flow.

#nlu_settings=

def nlu_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::NluSettings

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::NluSettings) — NLU related settings of the flow.

Returns

(::Google::Cloud::Dialogflow::CX::V3::NluSettings) — NLU related settings of the flow.

#transition_route_groups

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

Returns

(::Array<::String>) — 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<TransitionRouteGroup ID> for agent-level groups.

#transition_route_groups=

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

Parameter

value (::Array<::String>) — 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<TransitionRouteGroup ID> for agent-level groups.

Returns

(::Array<::String>) — 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<TransitionRouteGroup ID> 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 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 evalauted in the following order:
- TransitionRoutes with intent specified.
- TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.

#transition_routes=

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

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::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 evalauted in the following order:
- TransitionRoutes with intent specified.
- TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::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 evalauted in the following order:
- TransitionRoutes with intent specified.
- TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.