google-cloud-dialogflow-cx-v3 0.1.0

data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb

@@ -0,0 +1,438 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Represents an experiment in an environment.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the experiment.
+          #     Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/experiments/<Experiment ID>..
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the experiment (unique in an environment). Limit
+          #     of 64 characters.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The human-readable description of the experiment.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::State]
+          #     The current state of the experiment.
+          #     Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING.
+          #     Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or
+          #     RUNNING->DONE.
+          # @!attribute [rw] definition
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Definition]
+          #     The definition of the experiment.
+          # @!attribute [rw] rollout_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::RolloutConfig]
+          #     The configuration for auto rollout. If set, there should be exactly two
+          #     variants in the experiment (control variant being the default version of
+          #     the flow), the traffic allocation for the non-control variant will
+          #     gradually increase to 100% when conditions are met, and eventually
+          #     replace the control variant to become the default version of the flow.
+          # @!attribute [rw] rollout_state
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::RolloutState]
+          #     State of the auto rollout process.
+          # @!attribute [rw] rollout_failure_reason
+          #   @return [::String]
+          #     The reason why rollout has failed. Should only be set when state is
+          #     ROLLOUT_FAILED.
+          # @!attribute [rw] result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result]
+          #     Inference result of the experiment.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Creation time of this experiment.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Start time of this experiment.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     End time of this experiment.
+          # @!attribute [rw] last_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Last update time of this experiment.
+          # @!attribute [rw] experiment_length
+          #   @return [::Google::Protobuf::Duration]
+          #     Maximum number of days to run the experiment/rollout. If auto-rollout is
+          #     not enabled, default value and maximum will be 30 days. If auto-rollout is
+          #     enabled, default value and maximum will be 6 days.
+          # @!attribute [rw] variants_history
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::VariantsHistory>]
+          #     The history of updates to the experiment variants.
+          class Experiment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Definition of the experiment.
+            # @!attribute [rw] condition
+            #   @return [::String]
+            #     The condition defines which subset of sessions are selected for
+            #     this experiment. If not specified, all sessions are eligible. E.g.
+            #     "query_input.language_code=en" See the [conditions
+            #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+            # @!attribute [rw] version_variants
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
+            #     The flow versions as the variants of this experiment.
+            class Definition
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The inference result which includes an objective metric to optimize and the
+            # confidence interval.
+            # @!attribute [rw] version_metrics
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::VersionMetrics>]
+            #     Version variants and metrics.
+            # @!attribute [rw] last_update_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     The last time the experiment's stats data was updated. Will have default
+            #     value if stats have never been computed for this experiment.
+            class Result
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # A confidence interval is a range of possible values for the experiment
+              # objective you are trying to measure.
+              # @!attribute [rw] confidence_level
+              #   @return [::Float]
+              #     The confidence level used to construct the interval, i.e. there is X%
+              #     chance that the true value is within this interval.
+              # @!attribute [rw] ratio
+              #   @return [::Float]
+              #     The percent change between an experiment metric's value and the value
+              #     for its control.
+              # @!attribute [rw] lower_bound
+              #   @return [::Float]
+              #     Lower bound of the interval.
+              # @!attribute [rw] upper_bound
+              #   @return [::Float]
+              #     Upper bound of the interval.
+              class ConfidenceInterval
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Metric and corresponding confidence intervals.
+              # @!attribute [rw] type
+              #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::MetricType]
+              #     Ratio-based metric type. Only one of type or count_type is specified in
+              #     each Metric.
+              # @!attribute [rw] count_type
+              #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::CountType]
+              #     Count-based metric type. Only one of type or count_type is specified in
+              #     each Metric.
+              # @!attribute [rw] ratio
+              #   @return [::Float]
+              #     Ratio value of a metric.
+              # @!attribute [rw] count
+              #   @return [::Float]
+              #     Count value of a metric.
+              # @!attribute [rw] confidence_interval
+              #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::ConfidenceInterval]
+              #     The probability that the treatment is better than all other treatments
+              #     in the experiment
+              class Metric
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Version variant and associated metrics.
+              # @!attribute [rw] version
+              #   @return [::String]
+              #     The name of the flow {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
+              #     Format: `projects/<Project ID>/locations/<Location
+              #     ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
+              # @!attribute [rw] metrics
+              #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment::Result::Metric>]
+              #     The metrics and corresponding confidence intervals in the inference
+              #     result.
+              # @!attribute [rw] session_count
+              #   @return [::Integer]
+              #     Number of sessions that were allocated to this version.
+              class VersionMetrics
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Types of ratio-based metric for Dialogflow experiment.
+              module MetricType
+                # Metric unspecified.
+                METRIC_UNSPECIFIED = 0
+
+                # Percentage of contained sessions without user calling back in 24 hours.
+                CONTAINED_SESSION_NO_CALLBACK_RATE = 1
+
+                # Percentage of sessions that were handed to a human agent.
+                LIVE_AGENT_HANDOFF_RATE = 2
+
+                # Percentage of sessions with the same user calling back.
+                CALLBACK_SESSION_RATE = 3
+
+                # Percentage of sessions where user hung up.
+                ABANDONED_SESSION_RATE = 4
+
+                # Percentage of sessions reached Dialogflow 'END_PAGE' or
+                # 'END_SESSION'.
+                SESSION_END_RATE = 5
+              end
+
+              # Types of count-based metric for Dialogflow experiment.
+              module CountType
+                # Count type unspecified.
+                COUNT_TYPE_UNSPECIFIED = 0
+
+                # Total number of occurrences of a 'NO_MATCH'.
+                TOTAL_NO_MATCH_COUNT = 1
+
+                # Total number of turn counts.
+                TOTAL_TURN_COUNT = 2
+
+                # Average turn count in a session.
+                AVERAGE_TURN_COUNT = 3
+              end
+            end
+
+            # The state of the experiment.
+            module State
+              # State unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # The experiment is created but not started yet.
+              DRAFT = 1
+
+              # The experiment is running.
+              RUNNING = 2
+
+              # The experiment is done.
+              DONE = 3
+
+              # The experiment with auto-rollout enabled has failed.
+              ROLLOUT_FAILED = 4
+            end
+          end
+
+          # A list of flow version variants.
+          # @!attribute [rw] variants
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::VersionVariants::Variant>]
+          #     A list of flow version variants.
+          class VersionVariants
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A single flow version with specified traffic allocation.
+            # @!attribute [rw] version
+            #   @return [::String]
+            #     The name of the flow version.
+            #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+            #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+            # @!attribute [rw] traffic_allocation
+            #   @return [::Float]
+            #     Percentage of the traffic which should be routed to this
+            #     version of flow. Traffic allocation for a single flow must sum up to 1.0.
+            # @!attribute [rw] is_control_group
+            #   @return [::Boolean]
+            #     Whether the variant is for the control group.
+            class Variant
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The history of variants update.
+          # @!attribute [rw] version_variants
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::VersionVariants]
+          #     The flow versions as the variants.
+          # @!attribute [rw] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Update time of the variants.
+          class VariantsHistory
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The configuration for auto rollout.
+          # @!attribute [rw] rollout_steps
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::RolloutConfig::RolloutStep>]
+          #     Steps to roll out a flow version. Steps should be sorted by percentage in
+          #     ascending order.
+          # @!attribute [rw] rollout_condition
+          #   @return [::String]
+          #     The conditions that are used to evaluate the success of a rollout
+          #     step. If not specified, all rollout steps will proceed to the next one
+          #     unless failure conditions are met. E.g. "containment_rate > 60% AND
+          #     callback_rate < 20%". See the [conditions
+          #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+          # @!attribute [rw] failure_condition
+          #   @return [::String]
+          #     The conditions that are used to evaluate the failure of a rollout
+          #     step. If not specified, no rollout steps will fail. E.g. "containment_rate
+          #     < 10% OR average_turn_count < 3". See the [conditions
+          #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+          class RolloutConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A single rollout step with specified traffic allocation.
+            # @!attribute [rw] display_name
+            #   @return [::String]
+            #     The name of the rollout step;
+            # @!attribute [rw] traffic_percent
+            #   @return [::Integer]
+            #     The percentage of traffic allocated to the flow version of this rollout
+            #     step. (0%, 100%].
+            # @!attribute [rw] min_duration
+            #   @return [::Google::Protobuf::Duration]
+            #     The minimum time that this step should last. Should be longer than 1
+            #     hour. If not set, the default minimum duration for each step will be 1
+            #     hour.
+            class RolloutStep
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # State of the auto-rollout process.
+          # @!attribute [rw] step
+          #   @return [::String]
+          #     Display name of the current auto rollout step.
+          # @!attribute [rw] step_index
+          #   @return [::Integer]
+          #     Index of the current step in the auto rollout steps list.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Start time of the current step.
+          class RolloutState
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to list all environments for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 20 and
+          #     at most 100.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          class ListExperimentsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#list_experiments Experiments.ListExperiments}.
+          # @!attribute [rw] experiments
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Experiment>]
+          #     The list of experiments. There will be a maximum number of items
+          #     returned based on the page_size field in the request. The list may in some
+          #     cases be empty or contain fewer entries than page_size even if this isn't
+          #     the last page.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListExperimentsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#get_experiment Experiments.GetExperiment}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
+          class GetExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#create_experiment Experiments.CreateExperiment}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>`.
+          # @!attribute [rw] experiment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+          #     Required. The experiment to create.
+          class CreateExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#update_experiment Experiments.UpdateExperiment}.
+          # @!attribute [rw] experiment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+          #     Required. The experiment to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The mask to control which fields get updated.
+          class UpdateExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#delete_experiment Experiments.DeleteExperiment}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
+          class DeleteExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#start_experiment Experiments.StartExperiment}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Resource name of the experiment to start.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
+          class StartExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Experiments::Client#stop_experiment Experiments.StopExperiment}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Resource name of the experiment to stop.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/experiments/<Experiment ID>`.
+          class StopExperimentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb

@@ -0,0 +1,438 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Settings related to NLU.
+          # @!attribute [rw] model_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings::ModelType]
+          #     Indicates the type of NLU model.
+          # @!attribute [rw] classification_threshold
+          #   @return [::Float]
+          #     To filter out false positive results and still get variety in matched
+          #     natural language inputs for your agent, you can tune the machine learning
+          #     classification threshold. If the returned score value is less than the
+          #     threshold value, then a no-match event will be triggered. The score values
+          #     range from 0.0 (completely uncertain) to 1.0 (completely certain). If set
+          #     to 0.0, the default of 0.3 is used.
+          # @!attribute [rw] model_training_mode
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings::ModelTrainingMode]
+          #     Indicates NLU model training mode.
+          class NluSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # NLU model type.
+            module ModelType
+              # Not specified. `MODEL_TYPE_STANDARD` will be used.
+              MODEL_TYPE_UNSPECIFIED = 0
+
+              # Use standard NLU model.
+              MODEL_TYPE_STANDARD = 1
+
+              # Use advanced NLU model.
+              MODEL_TYPE_ADVANCED = 3
+            end
+
+            # NLU model training mode.
+            module ModelTrainingMode
+              # Not specified. `MODEL_TRAINING_MODE_AUTOMATIC` will be used.
+              MODEL_TRAINING_MODE_UNSPECIFIED = 0
+
+              # NLU model training is automatically triggered when a flow gets modified.
+              # User can also manually trigger model training in this mode.
+              MODEL_TRAINING_MODE_AUTOMATIC = 1
+
+              # User needs to manually trigger NLU model training. Best for large flows
+              # whose models take long time to train.
+              MODEL_TRAINING_MODE_MANUAL = 2
+            end
+          end
+
+          # 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.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the flow.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the flow.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The description of the flow. The maximum length is 500 characters. If
+          #     exceeded, the request is rejected.
+          # @!attribute [rw] transition_routes
+          #   @return [::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.
+          # @!attribute [rw] event_handlers
+          #   @return [::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 {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_routes 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.
+          # @!attribute [rw] transition_route_groups
+          #   @return [::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>`.
+          # @!attribute [rw] nlu_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings]
+          #     NLU related settings of the flow.
+          class Flow
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#create_flow Flows.CreateFlow}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to create a flow for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] flow
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
+          #     Required. The flow to create.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `flow`:
+          #
+          #     *  `Flow.event_handlers.trigger_fulfillment.messages`
+          #     *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Flow.transition_routes.trigger_fulfillment.messages`
+          #     *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class CreateFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#delete_flow Flows.DeleteFlow}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the flow to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     This field has no effect for flows with no incoming transitions.
+          #     For flows with incoming transitions:
+          #
+          #     *  If `force` is set to false, an error will be returned with message
+          #        indicating the incoming transitions.
+          #     *  If `force` is set to true, Dialogflow will remove the flow, as well as
+          #        any transitions to the flow (i.e. [Target
+          #        flow][EventHandler.target_flow] in event handlers or [Target
+          #        flow][TransitionRoute.target_flow] in transition routes that point to
+          #        this flow will be cleared).
+          class DeleteFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent containing the flows.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 100 and
+          #     at most 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list flows for. The following fields are language
+          #     dependent:
+          #
+          #     *  `Flow.event_handlers.trigger_fulfillment.messages`
+          #     *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Flow.transition_routes.trigger_fulfillment.messages`
+          #     *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class ListFlowsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}.
+          # @!attribute [rw] flows
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Flow>]
+          #     The list of flows. There will be a maximum number of items returned based
+          #     on the page_size field in the request.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListFlowsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow Flows.GetFlow}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the flow to get.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to retrieve the flow for. The following fields are language
+          #     dependent:
+          #
+          #     *  `Flow.event_handlers.trigger_fulfillment.messages`
+          #     *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Flow.transition_routes.trigger_fulfillment.messages`
+          #     *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class GetFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#update_flow Flows.UpdateFlow}.
+          # @!attribute [rw] flow
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
+          #     Required. The flow to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The mask to control which fields get updated. If `update_mask` is not
+          #     specified, an error will be returned.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `flow`:
+          #
+          #     *  `Flow.event_handlers.trigger_fulfillment.messages`
+          #     *  `Flow.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Flow.transition_routes.trigger_fulfillment.messages`
+          #     *  `Flow.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class UpdateFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#train_flow Flows.TrainFlow}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The flow to train.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          class TrainFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#validate_flow Flows.ValidateFlow}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The flow to validate.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     If not specified, the agent's default language is used.
+          class ValidateFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The flow name.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/validationResult`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     If not specified, the agent's default language is used.
+          class GetFlowValidationResultRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the flow validation result.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/validationResult`.
+          # @!attribute [rw] validation_messages
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ValidationMessage>]
+          #     Contains all validation messages.
+          # @!attribute [rw] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Last time the flow was validated.
+          class FlowValidationResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to import the flow into.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] flow_uri
+          #   @return [::String]
+          #     The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
+          #     to import flow from. The format of this URI must be
+          #     `gs://<bucket-name>/<object-name>`.
+          # @!attribute [rw] flow_content
+          #   @return [::String]
+          #     Uncompressed raw byte content for flow.
+          # @!attribute [rw] import_option
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest::ImportOption]
+          #     Flow import mode. If not specified, `KEEP` is assumed.
+          class ImportFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Import option.
+            module ImportOption
+              # Unspecified. Treated as `KEEP`.
+              IMPORT_OPTION_UNSPECIFIED = 0
+
+              # Always respect settings in exported flow content. It may cause a
+              # import failure if some settings (e.g. custom NLU) are not supported in
+              # the agent to import into.
+              KEEP = 1
+
+              # Fallback to default settings if some settings are not supported in the
+              # agent to import into. E.g. Standard NLU will be used if custom NLU is
+              # not available.
+              FALLBACK = 2
+            end
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}.
+          # @!attribute [rw] flow
+          #   @return [::String]
+          #     The unique identifier of the new flow.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          class ImportFlowResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the flow to export.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] flow_uri
+          #   @return [::String]
+          #     Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
+          #     export the flow to. The format of this URI must be
+          #     `gs://<bucket-name>/<object-name>`.
+          #     If left unspecified, the serialized flow is returned inline.
+          # @!attribute [rw] include_referenced_flows
+          #   @return [::Boolean]
+          #     Optional. Whether to export flows referenced by the specified flow.
+          class ExportFlowRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}.
+          # @!attribute [rw] flow_uri
+          #   @return [::String]
+          #     The URI to a file containing the exported flow. This field is populated
+          #     only if `flow_uri` is specified in {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}.
+          # @!attribute [rw] flow_content
+          #   @return [::String]
+          #     Uncompressed raw byte content for flow.
+          class ExportFlowResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end