Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AdvancedSettings
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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EventHandler>
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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
The Knowledge Connector settings for this page or flow.
-
#multi_language_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings
Settings for multi-lingual agents.
-
#name ⇒ String
The unique identifier of the flow.
-
#nlu_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1NluSettings
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::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRoute>
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) ⇒ GoogleCloudDialogflowCxV3beta1Flow
constructor
A new instance of GoogleCloudDialogflowCxV3beta1Flow.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Flow
Returns a new instance of GoogleCloudDialogflowCxV3beta1Flow.
6786 6787 6788 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6786 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AdvancedSettings
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
6716 6717 6718 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6716 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
6722 6723 6724 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6722 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the flow.
Corresponds to the JSON property displayName
6727 6728 6729 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6727 def display_name @display_name end |
#event_handlers ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EventHandler>
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
6738 6739 6740 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6738 def event_handlers @event_handlers end |
#knowledge_connector_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
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
6745 6746 6747 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6745 def knowledge_connector_settings @knowledge_connector_settings end |
#multi_language_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings
Settings for multi-lingual agents.
Corresponds to the JSON property multiLanguageSettings
6750 6751 6752 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6750 def multi_language_settings @multi_language_settings end |
#name ⇒ String
The unique identifier of the flow. Format: projects//locations//agents//flows/
.
Corresponds to the JSON property name
6756 6757 6758 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6756 def name @name end |
#nlu_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1NluSettings
Settings related to NLU.
Corresponds to the JSON property nluSettings
6761 6762 6763 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6761 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
6771 6772 6773 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6771 def transition_route_groups @transition_route_groups end |
#transition_routes ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRoute>
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
6784 6785 6786 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6784 def transition_routes @transition_routes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 |
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 6791 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) @multi_language_settings = args[:multi_language_settings] if args.key?(:multi_language_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 |