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
-
#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.
-
#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.
1969 1970 1971 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1969 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
1918 1919 1920 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1918 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the flow.
Corresponds to the JSON property displayName
1923 1924 1925 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1923 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
1934 1935 1936 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1934 def event_handlers @event_handlers end |
#name ⇒ String
The unique identifier of the flow. Format: projects//locations//agents//flows/
.
Corresponds to the JSON property name
1940 1941 1942 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1940 def name @name end |
#nlu_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3NluSettings
Settings related to NLU.
Corresponds to the JSON property nluSettings
1945 1946 1947 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1945 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/
.
Corresponds to the JSON property transitionRouteGroups
1954 1955 1956 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1954 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
1967 1968 1969 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1967 def transition_routes @transition_routes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1974 1975 1976 1977 1978 1979 1980 1981 1982 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1974 def update!(**args) @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) @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 |