Class: Google::Cloud::Dialogflow::CX::V3::Flow

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/flow.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.

Defined Under Namespace

Classes: MultiLanguageSettings

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns 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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the flow.

Returns:

  • (::String) —

    Required. The human-readable name of the flow.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#event_handlers ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>

Returns 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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#knowledge_connector_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings

Returns Optional. Knowledge connector configuration.

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#locked ⇒ ::Boolean

Returns Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.

Returns:

  • (::Boolean) —

    Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#multi_language_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings

Returns Optional. Multi-lingual agent settings for this flow.

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Returns:

  • (::String) —

    The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#nlu_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::NluSettings

Returns NLU related settings of the flow.

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transition_route_groups ⇒ ::Array<::String>

Returns 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transition_routes ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>

Returns 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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/flow.rb', line 163

class Flow
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Settings for multi-lingual agents.
  # @!attribute [rw] enable_multi_language_detection
  #   @return [::Boolean]
  #     Optional. Enable multi-language detection for this flow. This can be set
  #     only if [agent level multi language
  #     setting][Agent.enable_multi_language_training] is enabled.
  # @!attribute [rw] supported_response_language_codes
  #   @return [::Array<::String>]
  #     Optional. Agent will respond in the detected language if the detected
  #     language code is in the supported resolved languages for this flow. This
  #     will be used only if multi-language training is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Agent#enable_multi_language_training agent}
  #     and multi-language detection is enabled in the
  #     {::Google::Cloud::Dialogflow::CX::V3::Flow::MultiLanguageSettings#enable_multi_language_detection flow}.
  #     The supported languages must be a subset of the languages supported by
  #     the agent.
  class MultiLanguageSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end