Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
-
#description ⇒ String
The description of the flow.
-
#display_name ⇒ String
Required.
-
#event_handlers ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler>
A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow.
-
#knowledge_connector_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3KnowledgeConnectorSettings
The Knowledge Connector settings for this page or flow.
-
#name ⇒ String
The unique identifier of the flow.
-
#nlu_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3NluSettings
Settings related to NLU.
-
#transition_route_groups ⇒ Array<String>
A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow.
-
#transition_routes ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRoute>
A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Flow
constructor
A new instance of GoogleCloudDialogflowCxV3Flow.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Flow
Returns a new instance of GoogleCloudDialogflowCxV3Flow.
2641 2642 2643 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2641 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
Settings exposed at lower level overrides the settings exposed at higher level.
Overriding occurs at the sub-setting level. For example, the
playback_interruption_settings at fulfillment level only overrides the
playback_interruption_settings at the agent level, leaving other settings at
the agent level unchanged. DTMF settings does not override each other. DTMF
settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
Corresponds to the JSON property advancedSettings
2576 2577 2578 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2576 def advanced_settings @advanced_settings end |
#description ⇒ String
The description of the flow. The maximum length is 500 characters. If exceeded,
the request is rejected.
Corresponds to the JSON property description
2582 2583 2584 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2582 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the flow.
Corresponds to the JSON property displayName
2587 2588 2589 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2587 def display_name @display_name end |
#event_handlers ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler>
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, 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.
Corresponds to the JSON property eventHandlers
2598 2599 2600 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2598 def event_handlers @event_handlers end |
#knowledge_connector_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3KnowledgeConnectorSettings
The Knowledge Connector settings for this page or flow. This includes
information such as the attached Knowledge Bases, and the way to execute
fulfillment.
Corresponds to the JSON property knowledgeConnectorSettings
2605 2606 2607 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2605 def knowledge_connector_settings @knowledge_connector_settings end |
#name ⇒ String
The unique identifier of the flow. Format: projects//locations//agents//flows/
.
Corresponds to the JSON property name
2611 2612 2613 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2611 def name @name end |
#nlu_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3NluSettings
Settings related to NLU.
Corresponds to the JSON property nluSettings
2616 2617 2618 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2616 def nlu_settings @nlu_settings end |
#transition_route_groups ⇒ 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. Transition route groups defined in the
page have higher priority than those defined in the flow. Format:projects//
locations//agents//flows//transitionRouteGroups/
or projects//locations//
agents//transitionRouteGroups/
for agent-level groups.
Corresponds to the JSON property transitionRouteGroups
2626 2627 2628 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2626 def transition_route_groups @transition_route_groups end |
#transition_routes ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRoute>
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 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.
Corresponds to the JSON property transitionRoutes
2639 2640 2641 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2639 def transition_routes @transition_routes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2646 def update!(**args) @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @event_handlers = args[:event_handlers] if args.key?(:event_handlers) @knowledge_connector_settings = args[:knowledge_connector_settings] if args.key?(:knowledge_connector_settings) @name = args[:name] if args.key?(:name) @nlu_settings = args[:nlu_settings] if args.key?(:nlu_settings) @transition_route_groups = args[:transition_route_groups] if args.key?(:transition_route_groups) @transition_routes = args[:transition_routes] if args.key?(:transition_routes) end |