google-cloud-dialogflow-cx-v3 0.1.0

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

@@ -0,0 +1,126 @@
+# 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
+          # A fulfillment can do one or more of the following actions at the same time:
+          #
+          #   * Generate rich message responses.
+          #   * Set parameter values.
+          #   * Call the webhook.
+          #
+          # Fulfillments can be called at various stages in the {::Google::Cloud::Dialogflow::CX::V3::Page Page} or
+          # {::Google::Cloud::Dialogflow::CX::V3::Form Form} lifecycle. For example, when a {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest DetectIntentRequest} drives a
+          # session to enter a new page, the page's entry fulfillment can add a static
+          # response to the {::Google::Cloud::Dialogflow::CX::V3::QueryResult QueryResult} in the returning {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse DetectIntentResponse},
+          # call the webhook (for example, to load user data from a database), or both.
+          # @!attribute [rw] messages
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
+          #     The list of rich message responses to present to the user.
+          # @!attribute [rw] webhook
+          #   @return [::String]
+          #     The webhook to call.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/webhooks/<Webhook ID>`.
+          # @!attribute [rw] return_partial_responses
+          #   @return [::Boolean]
+          #     Whether Dialogflow should return currently queued fulfillment response
+          #     messages in streaming APIs. If a webhook is specified, it happens before
+          #     Dialogflow invokes webhook.
+          #     Warning:
+          #     1) This flag only affects streaming API. Responses are still queued
+          #     and returned once in non-streaming API.
+          #     2) The flag can be enabled in any fulfillment but only the first 3 partial
+          #     responses will be returned. You may only want to apply it to fulfillments
+          #     that have slow webhooks.
+          # @!attribute [rw] tag
+          #   @return [::String]
+          #     The tag used by the webhook to identify which fulfillment is being called.
+          #     This field is required if `webhook` is specified.
+          # @!attribute [rw] set_parameter_actions
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Fulfillment::SetParameterAction>]
+          #     Set parameter values before executing the webhook.
+          # @!attribute [rw] conditional_cases
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Fulfillment::ConditionalCases>]
+          #     Conditional cases for this fulfillment.
+          class Fulfillment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Setting a parameter value.
+            # @!attribute [rw] parameter
+            #   @return [::String]
+            #     Display name of the parameter.
+            # @!attribute [rw] value
+            #   @return [::Google::Protobuf::Value]
+            #     The new value of the parameter. A null value clears the parameter.
+            class SetParameterAction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A list of cascading if-else conditions. Cases are mutually exclusive.
+            # The first one with a matching condition is selected, all the rest ignored.
+            # @!attribute [rw] cases
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Fulfillment::ConditionalCases::Case>]
+            #     A list of cascading if-else conditions.
+            class ConditionalCases
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Each case has a Boolean condition. When it is evaluated to be True, the
+              # corresponding messages will be selected and evaluated recursively.
+              # @!attribute [rw] condition
+              #   @return [::String]
+              #     The condition to activate and select this case. Empty means the
+              #     condition is always true. The condition is evaluated against [form
+              #     parameters][Form.parameters] or [session
+              #     parameters][SessionInfo.parameters].
+              #
+              #     See the [conditions
+              #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+              # @!attribute [rw] case_content
+              #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Fulfillment::ConditionalCases::Case::CaseContent>]
+              #     A list of case content.
+              class Case
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # The list of messages or conditional cases to activate for this case.
+                # @!attribute [rw] message
+                #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage]
+                #     Returned message.
+                # @!attribute [rw] additional_cases
+                #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment::ConditionalCases]
+                #     Additional cases to be evaluated.
+                class CaseContent
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,318 @@
+# 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
+          # An intent represents a user's intent to interact with a conversational agent.
+          #
+          # You can provide information for the Dialogflow API to use to match user input
+          # to an intent by adding training phrases (i.e., examples of user input) to
+          # your intent.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the intent.
+          #     Required for the {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent} method. {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}
+          #     populates the name automatically.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the intent, unique within the agent.
+          # @!attribute [rw] training_phrases
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase>]
+          #     The collection of training phrases the agent is trained on to identify the
+          #     intent.
+          # @!attribute [rw] parameters
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter>]
+          #     The collection of parameters associated with the intent.
+          # @!attribute [rw] priority
+          #   @return [::Integer]
+          #     The priority of this intent. Higher numbers represent higher
+          #     priorities.
+          #
+          #     - If the supplied value is unspecified or 0, the service
+          #       translates the value to 500,000, which corresponds to the
+          #       `Normal` priority in the console.
+          #     - If the supplied value is negative, the intent is ignored
+          #       in runtime detect intent requests.
+          # @!attribute [rw] is_fallback
+          #   @return [::Boolean]
+          #     Indicates whether this is a fallback intent. Currently only default
+          #     fallback intent is allowed in the agent, which is added upon agent
+          #     creation.
+          #     Adding training phrases to fallback intent is useful in the case of
+          #     requests that are mistakenly matched, since training phrases assigned to
+          #     fallback intents act as negative examples that triggers no-match event.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     The key/value metadata to label an intent. Labels can contain
+          #     lowercase letters, digits and the symbols '-' and '_'. International
+          #     characters are allowed, including letters from unicase alphabets. Keys must
+          #     start with a letter. Keys and values can be no longer than 63 characters
+          #     and no more than 128 bytes.
+          #
+          #     Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
+          #     Dialogflow defined labels include:
+          #     * sys-head
+          #     * sys-contextual
+          #     The above labels do not require value. "sys-head" means the intent is a
+          #     head intent. "sys.contextual" means the intent is a contextual intent.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     Human readable description for better understanding an intent like its
+          #     scope, content, result etc. Maximum character limit: 140 characters.
+          class Intent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents an example that the agent is trained on to identify the intent.
+            # @!attribute [rw] id
+            #   @return [::String]
+            #     Output only. The unique identifier of the training phrase.
+            # @!attribute [rw] parts
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part>]
+            #     Required. The ordered list of training phrase parts.
+            #     The parts are concatenated in order to form the training phrase.
+            #
+            #     Note: The API does not automatically annotate training phrases like the
+            #     Dialogflow Console does.
+            #
+            #     Note: Do not forget to include whitespace at part boundaries, so the
+            #     training phrase is well formatted when the parts are concatenated.
+            #
+            #     If the training phrase does not need to be annotated with parameters,
+            #     you just need a single part with only the {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part#text Part.text} field set.
+            #
+            #     If you want to annotate the training phrase, you must create multiple
+            #     parts, where the fields of each part are populated in one of two ways:
+            #
+            #     -   `Part.text` is set to a part of the phrase that has no parameters.
+            #     -   `Part.text` is set to a part of the phrase that you want to annotate,
+            #         and the `parameter_id` field is set.
+            # @!attribute [rw] repeat_count
+            #   @return [::Integer]
+            #     Indicates how many times this example was added to the intent.
+            class TrainingPhrase
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Represents a part of a training phrase.
+              # @!attribute [rw] text
+              #   @return [::String]
+              #     Required. The text for this part.
+              # @!attribute [rw] parameter_id
+              #   @return [::String]
+              #     The {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} used to annotate this part of the
+              #     training phrase. This field is required for annotated parts of the
+              #     training phrase.
+              class Part
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Represents an intent parameter.
+            # @!attribute [rw] id
+            #   @return [::String]
+            #     Required. The unique identifier of the parameter. This field
+            #     is used by {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase training phrases} to annotate their
+            #     {::Google::Cloud::Dialogflow::CX::V3::Intent::TrainingPhrase::Part parts}.
+            # @!attribute [rw] entity_type
+            #   @return [::String]
+            #     Required. The entity type of the parameter.
+            #     Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
+            #     ID>` for system entity types (for example,
+            #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
+            #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+            #     ID>/entityTypes/<Entity Type ID>` for developer entity types.
+            # @!attribute [rw] is_list
+            #   @return [::Boolean]
+            #     Indicates whether the parameter represents a list of values.
+            # @!attribute [rw] redact
+            #   @return [::Boolean]
+            #     Indicates whether the parameter content should be redacted in log. If
+            #     redaction is enabled, the parameter content will be replaced by parameter
+            #     name during logging.
+            #     Note: the parameter content is subject to redaction if either parameter
+            #     level redaction or {::Google::Cloud::Dialogflow::CX::V3::EntityType#redact entity type level redaction} is
+            #     enabled.
+            class Parameter
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to list all intents for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list intents for. The following fields are language
+          #     dependent:
+          #
+          #     *   `Intent.training_phrases.parts.text`
+          #
+          #     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.
+          # @!attribute [rw] intent_view
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::IntentView]
+          #     The resource view to apply to the returned intent.
+          # @!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.
+          class ListIntentsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#list_intents Intents.ListIntents}.
+          # @!attribute [rw] intents
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Intent>]
+          #     The list of intents. 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 ListIntentsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#get_intent Intents.GetIntent}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the intent.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to retrieve the intent for. The following fields are language
+          #     dependent:
+          #
+          #     *   `Intent.training_phrases.parts.text`
+          #
+          #     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 GetIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#create_intent Intents.CreateIntent}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to create an intent for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] intent
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
+          #     Required. The intent to create.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `intent`:
+          #
+          #     *   `Intent.training_phrases.parts.text`
+          #
+          #     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 CreateIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#update_intent Intents.UpdateIntent}.
+          # @!attribute [rw] intent
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
+          #     Required. The intent to update.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `intent`:
+          #
+          #     *   `Intent.training_phrases.parts.text`
+          #
+          #     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.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The mask to control which fields get updated. If the mask is not present,
+          #     all fields will be updated.
+          class UpdateIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Intents::Client#delete_intent Intents.DeleteIntent}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the intent to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          class DeleteIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the options for views of an intent.
+          # An intent can be a sizable object. Therefore, we provide a resource view that
+          # does not return training phrases in the response.
+          module IntentView
+            # Not specified. Treated as INTENT_VIEW_FULL.
+            INTENT_VIEW_UNSPECIFIED = 0
+
+            # Training phrases field is not populated in the response.
+            INTENT_VIEW_PARTIAL = 1
+
+            # All fields are populated.
+            INTENT_VIEW_FULL = 2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,478 @@
+# 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
+          # A Dialogflow CX conversation (session) can be described and visualized as a
+          # state machine. The states of a CX session are represented by pages.
+          #
+          # For each flow, you define many pages, where your combined pages can handle a
+          # complete conversation on the topics the flow is designed for. At any given
+          # moment, exactly one page is the current page, the current page is considered
+          # active, and the flow associated with that page is considered active. Every
+          # flow has a special start page. When a flow initially becomes active, the
+          # start page page becomes the current page. For each conversational turn, the
+          # current page will either stay the same or transition to another page.
+          #
+          # You configure each page to collect information from the end-user that is
+          # relevant for the conversational state represented by the page.
+          #
+          # For more information, see the
+          # [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the page.
+          #     Required for the {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage} method. {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}
+          #     populates the name automatically.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the page, unique within the agent.
+          # @!attribute [rw] entry_fulfillment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
+          #     The fulfillment to call when the session is entering the page.
+          # @!attribute [rw] form
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Form]
+          #     The form associated with the page, used for collecting parameters
+          #     relevant to the page.
+          # @!attribute [rw] transition_route_groups
+          #   @return [::Array<::String>]
+          #     Ordered list of {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup `TransitionRouteGroups`} associated
+          #     with the page. Transition route groups must be unique within a page.
+          #
+          #     *   If multiple transition routes within a page scope refer to the same
+          #         intent, then the precedence order is: page's transition route -> page's
+          #         transition route group -> flow's transition routes.
+          #
+          #     *   If multiple transition route groups within a page contain the same
+          #         intent, then the first group in the ordered list takes precedence.
+          #
+          #     Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`.
+          # @!attribute [rw] transition_routes
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>]
+          #     A list of transitions for the transition rules of this page.
+          #     They route the conversation to another page in the same flow, or another
+          #     flow.
+          #
+          #     When we are in a certain page, the TransitionRoutes are evalauted in the
+          #     following order:
+          #
+          #     *   TransitionRoutes defined in the page with intent specified.
+          #     *   TransitionRoutes defined in the
+          #         {::Google::Cloud::Dialogflow::CX::V3::Page#transition_route_groups transition route groups} with intent
+          #         specified.
+          #     *   TransitionRoutes defined in flow with intent specified.
+          #     *   TransitionRoutes defined in the
+          #         {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_route_groups transition route groups} with intent
+          #         specified.
+          #     *   TransitionRoutes defined in the page with only condition specified.
+          #     *   TransitionRoutes defined in the
+          #         {::Google::Cloud::Dialogflow::CX::V3::Page#transition_route_groups transition route groups} with only
+          #         condition specified.
+          # @!attribute [rw] event_handlers
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>]
+          #     Handlers associated with the page to handle events such as webhook errors,
+          #     no match or no input.
+          class Page
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A form is a data model that groups related parameters that can be collected
+          # from the user. The process in which the agent prompts the user and collects
+          # parameter values from the user is called form filling. A form can be added to
+          # a {::Google::Cloud::Dialogflow::CX::V3::Page page}. When form filling is done, the filled parameters will be
+          # written to the {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session}.
+          # @!attribute [rw] parameters
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Form::Parameter>]
+          #     Parameters to collect from the user.
+          class Form
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents a form parameter.
+            # @!attribute [rw] display_name
+            #   @return [::String]
+            #     Required. The human-readable name of the parameter, unique within the
+            #     form.
+            # @!attribute [rw] required
+            #   @return [::Boolean]
+            #     Indicates whether the parameter is required. Optional parameters will not
+            #     trigger prompts; however, they are filled if the user specifies them.
+            #     Required parameters must be filled before form filling concludes.
+            # @!attribute [rw] entity_type
+            #   @return [::String]
+            #     Required. The entity type of the parameter.
+            #     Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
+            #     ID>` for system entity types (for example,
+            #     `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
+            #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+            #     ID>/entityTypes/<Entity Type ID>` for developer entity types.
+            # @!attribute [rw] is_list
+            #   @return [::Boolean]
+            #     Indicates whether the parameter represents a list of values.
+            # @!attribute [rw] fill_behavior
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior]
+            #     Required. Defines fill behavior for the parameter.
+            # @!attribute [rw] default_value
+            #   @return [::Google::Protobuf::Value]
+            #     The default value of an optional parameter. If the parameter is required,
+            #     the default value will be ignored.
+            # @!attribute [rw] redact
+            #   @return [::Boolean]
+            #     Indicates whether the parameter content should be redacted in log.  If
+            #     redaction is enabled, the parameter content will be replaced by parameter
+            #     name during logging.
+            #     Note: the parameter content is subject to redaction if either parameter
+            #     level redaction or {::Google::Cloud::Dialogflow::CX::V3::EntityType#redact entity type level redaction} is
+            #     enabled.
+            class Parameter
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Configuration for how the filling of a parameter should be handled.
+              # @!attribute [rw] initial_prompt_fulfillment
+              #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
+              #     Required. The fulfillment to provide the initial prompt that the agent
+              #     can present to the user in order to fill the parameter.
+              # @!attribute [rw] reprompt_event_handlers
+              #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>]
+              #     The handlers for parameter-level events, used to provide reprompt for
+              #     the parameter or transition to a different page/flow. The supported
+              #     events are:
+              #     *   `sys.no-match-<N>`, where N can be from 1 to 6
+              #     *   `sys.no-match-default`
+              #     *   `sys.no-input-<N>`, where N can be from 1 to 6
+              #     *   `sys.no-input-default`
+              #     *   `sys.invalid-parameter`
+              #
+              #     `initial_prompt_fulfillment` provides the first prompt for the
+              #     parameter.
+              #
+              #     If the user's response does not fill the parameter, a
+              #     no-match/no-input event will be triggered, and the fulfillment
+              #     associated with the `sys.no-match-1`/`sys.no-input-1` handler (if
+              #     defined) will be called to provide a prompt. The
+              #     `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to
+              #     the next no-match/no-input event, and so on.
+              #
+              #     A `sys.no-match-default` or `sys.no-input-default` handler will be used
+              #     to handle all following no-match/no-input events after all numbered
+              #     no-match/no-input handlers for the parameter are consumed.
+              #
+              #     A `sys.invalid-parameter` handler can be defined to handle the case
+              #     where the parameter values have been `invalidated` by webhook. For
+              #     example, if the user's response fill the parameter, however the
+              #     parameter was invalidated by webhook, the fulfillment associated with
+              #     the `sys.invalid-parameter` handler (if defined) will be called to
+              #     provide a prompt.
+              #
+              #     If the event handler for the corresponding event can't be found on the
+              #     parameter, `initial_prompt_fulfillment` will be re-prompted.
+              class FillBehavior
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+
+          # An event handler specifies an {::Google::Cloud::Dialogflow::CX::V3::EventHandler#event event} that can be handled
+          # during a session. When the specified event happens, the following actions are
+          # taken in order:
+          #
+          # *   If there is a
+          # {::Google::Cloud::Dialogflow::CX::V3::EventHandler#trigger_fulfillment `trigger_fulfillment`} associated with
+          # the event, it will be called.
+          # *   If there is a {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_page `target_page`} associated
+          # with the event, the session will transition into the specified page.
+          # *   If there is a {::Google::Cloud::Dialogflow::CX::V3::EventHandler#target_flow `target_flow`} associated
+          # with the event, the session will transition into the specified flow.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The unique identifier of this event handler.
+          # @!attribute [rw] event
+          #   @return [::String]
+          #     Required. The name of the event to handle.
+          # @!attribute [rw] trigger_fulfillment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
+          #     The fulfillment to call when the event occurs.
+          #     Handling webhook errors with a fulfillment enabled with webhook could
+          #     cause infinite loop. It is invalid to specify such fulfillment for a
+          #     handler handling webhooks.
+          # @!attribute [rw] target_page
+          #   @return [::String]
+          #     The target page to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] target_flow
+          #   @return [::String]
+          #     The target flow to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          class EventHandler
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A transition route specifies a {::Google::Cloud::Dialogflow::CX::V3::Intent intent} that can be matched and/or a
+          # data condition that can be evaluated during a session. When a specified
+          # transition is matched, the following actions are taken in order:
+          #
+          # *   If there is a
+          # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#trigger_fulfillment `trigger_fulfillment`} associated with
+          # the transition, it will be called.
+          # *   If there is a {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_page `target_page`} associated
+          # with the transition, the session will transition into the specified page.
+          # *   If there is a {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute#target_flow `target_flow`} associated
+          # with the transition, the session will transition into the specified flow.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The unique identifier of this transition route.
+          # @!attribute [rw] intent
+          #   @return [::String]
+          #     The unique identifier of an {::Google::Cloud::Dialogflow::CX::V3::Intent Intent}.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          #     Indicates that the transition can only happen when the given intent is
+          #     matched.
+          #     At least one of `intent` or `condition` must be specified. When both
+          #     `intent` and `condition` are specified, the transition can only happen
+          #     when both are fulfilled.
+          # @!attribute [rw] condition
+          #   @return [::String]
+          #     The condition to evaluate against {::Google::Cloud::Dialogflow::CX::V3::Form#parameters form parameters} or
+          #     {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session parameters}.
+          #
+          #     See the [conditions
+          #     reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
+          #     At least one of `intent` or `condition` must be specified. When both
+          #     `intent` and `condition` are specified, the transition can only happen
+          #     when both are fulfilled.
+          # @!attribute [rw] trigger_fulfillment
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
+          #     The fulfillment to call when the condition is satisfied. At least one of
+          #     `trigger_fulfillment` and `target` must be specified. When both are
+          #     defined, `trigger_fulfillment` is executed first.
+          # @!attribute [rw] target_page
+          #   @return [::String]
+          #     The target page to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] target_flow
+          #   @return [::String]
+          #     The target flow to transition to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          class TransitionRoute
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The flow to list all pages for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list pages for. The following fields are language
+          #     dependent:
+          #
+          #     *  `Page.entry_fulfillment.messages`
+          #     *  `Page.entry_fulfillment.conditional_cases`
+          #     *  `Page.event_handlers.trigger_fulfillment.messages`
+          #     *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
+          #     *  `Page.transition_routes.trigger_fulfillment.messages`
+          #     *  `Page.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.
+          # @!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.
+          class ListPagesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#list_pages Pages.ListPages}.
+          # @!attribute [rw] pages
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Page>]
+          #     The list of pages. 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 ListPagesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#get_page Pages.GetPage}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the page.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to retrieve the page for. The following fields are language
+          #     dependent:
+          #
+          #     *  `Page.entry_fulfillment.messages`
+          #     *  `Page.entry_fulfillment.conditional_cases`
+          #     *  `Page.event_handlers.trigger_fulfillment.messages`
+          #     *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
+          #     *  `Page.transition_routes.trigger_fulfillment.messages`
+          #     *  `Page.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 GetPageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#create_page Pages.CreatePage}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The flow to create a page for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] page
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+          #     Required. The page to create.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `page`:
+          #
+          #     *  `Page.entry_fulfillment.messages`
+          #     *  `Page.entry_fulfillment.conditional_cases`
+          #     *  `Page.event_handlers.trigger_fulfillment.messages`
+          #     *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
+          #     *  `Page.transition_routes.trigger_fulfillment.messages`
+          #     *  `Page.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 CreatePageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#update_page Pages.UpdatePage}.
+          # @!attribute [rw] page
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+          #     Required. The page to update.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `page`:
+          #
+          #     *  `Page.entry_fulfillment.messages`
+          #     *  `Page.entry_fulfillment.conditional_cases`
+          #     *  `Page.event_handlers.trigger_fulfillment.messages`
+          #     *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
+          #     *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
+          #     *
+          #     `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
+          #     *  `Page.transition_routes.trigger_fulfillment.messages`
+          #     *  `Page.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.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The mask to control which fields get updated. If the mask is not present,
+          #     all fields will be updated.
+          class UpdatePageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Pages::Client#delete_page Pages.DeletePage}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the page to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/Flows/<flow ID>/pages/<Page ID>`.
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     This field has no effect for pages with no incoming transitions.
+          #     For pages 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 page, as well as
+          #        any transitions to the page (i.e. [Target
+          #        page][EventHandler.target_page] in event handlers or [Target
+          #        page][TransitionRoute.target_page] in transition routes that point to
+          #        this page will be cleared).
+          class DeletePageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end