google-cloud-dialogflow-cx-v3 0.1.0

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

@@ -0,0 +1,220 @@
+# 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 a response message that can be returned by a conversational agent.
+          #
+          # Response messages are also used for output audio synthesis. The approach is
+          # as follows:
+          #
+          # * If at least one OutputAudioText response is present, then all
+          #   OutputAudioText responses are linearly concatenated, and the result is used
+          #   for output audio synthesis.
+          # * If the OutputAudioText responses are a mixture of text and SSML, then the
+          #   concatenated result is treated as SSML; otherwise, the result is treated as
+          #   either text or SSML as appropriate. The agent designer should ideally use
+          #   either text or SSML consistently throughout the bot design.
+          # * Otherwise, all Text responses are linearly concatenated, and the result is
+          #   used for output audio synthesis.
+          #
+          # This approach allows for more sophisticated user experience scenarios, where
+          # the text displayed to the user may differ from what is heard.
+          # @!attribute [rw] text
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text]
+          #     Returns a text response.
+          # @!attribute [rw] payload
+          #   @return [::Google::Protobuf::Struct]
+          #     Returns a response containing a custom, platform-specific payload.
+          # @!attribute [rw] conversation_success
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess]
+          #     Indicates that the conversation succeeded.
+          # @!attribute [rw] output_audio_text
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::OutputAudioText]
+          #     A text or ssml response that is preferentially used for TTS output audio
+          #     synthesis, as described in the comment on the ResponseMessage message.
+          # @!attribute [rw] live_agent_handoff
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::LiveAgentHandoff]
+          #     Hands off conversation to a human agent.
+          # @!attribute [r] end_interaction
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::EndInteraction]
+          #     Output only. A signal that indicates the interaction with the Dialogflow agent has
+          #     ended.
+          #     This message is generated by Dialogflow only when the conversation
+          #     reaches `END_SESSION` page. It is not supposed to be defined by the user.
+          #
+          #     It's guaranteed that there is at most one such message in each response.
+          # @!attribute [rw] play_audio
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::PlayAudio]
+          #     Signal that the client should play an audio clip hosted at a
+          #     client-specific URI. Dialogflow uses this to construct
+          #     {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#mixed_audio mixed_audio}. However, Dialogflow itself
+          #     does not try to read or process the URI in any way.
+          # @!attribute [r] mixed_audio
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio]
+          #     Output only. An audio response message composed of both the synthesized Dialogflow
+          #     agent responses and responses defined via
+          #     {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#play_audio play_audio}.
+          #     This message is generated by Dialogflow only and not supposed to be
+          #     defined by the user.
+          class ResponseMessage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The text response message.
+            # @!attribute [rw] text
+            #   @return [::Array<::String>]
+            #     Required. A collection of text responses.
+            # @!attribute [r] allow_playback_interruption
+            #   @return [::Boolean]
+            #     Output only. Whether the playback of this message can be interrupted by the end
+            #     user's speech and the client can then starts the next Dialogflow
+            #     request.
+            class Text
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Indicates that the conversation should be handed off to a live agent.
+            #
+            # Dialogflow only uses this to determine which conversations were handed off
+            # to a human agent for measurement purposes. What else to do with this signal
+            # is up to you and your handoff procedures.
+            #
+            # You may set this, for example:
+            # * In the {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment} of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
+            #   entering the page indicates something went extremely wrong in the
+            #   conversation.
+            # * In a webhook response when you determine that the customer issue can only
+            #   be handled by a human.
+            # @!attribute [rw] metadata
+            #   @return [::Google::Protobuf::Struct]
+            #     Custom metadata for your handoff procedure. Dialogflow doesn't impose
+            #     any structure on this.
+            class LiveAgentHandoff
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Indicates that the conversation succeeded, i.e., the bot handled the issue
+            # that the customer talked to it about.
+            #
+            # Dialogflow only uses this to determine which conversations should be
+            # counted as successful and doesn't process the metadata in this message in
+            # any way. Note that Dialogflow also considers conversations that get to the
+            # conversation end page as successful even if they don't return
+            # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::ConversationSuccess ConversationSuccess}.
+            #
+            # You may set this, for example:
+            # * In the {::Google::Cloud::Dialogflow::CX::V3::Page#entry_fulfillment entry_fulfillment} of a {::Google::Cloud::Dialogflow::CX::V3::Page Page} if
+            #   entering the page indicates that the conversation succeeded.
+            # * In a webhook response when you determine that you handled the customer
+            #   issue.
+            # @!attribute [rw] metadata
+            #   @return [::Google::Protobuf::Struct]
+            #     Custom metadata. Dialogflow doesn't impose any structure on this.
+            class ConversationSuccess
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A text or ssml response that is preferentially used for TTS output audio
+            # synthesis, as described in the comment on the ResponseMessage message.
+            # @!attribute [rw] text
+            #   @return [::String]
+            #     The raw text to be synthesized.
+            # @!attribute [rw] ssml
+            #   @return [::String]
+            #     The SSML text to be synthesized. For more information, see
+            #     [SSML](/speech/text-to-speech/docs/ssml).
+            # @!attribute [r] allow_playback_interruption
+            #   @return [::Boolean]
+            #     Output only. Whether the playback of this message can be interrupted by the end
+            #     user's speech and the client can then starts the next Dialogflow
+            #     request.
+            class OutputAudioText
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Indicates that interaction with the Dialogflow agent has ended.
+            # This message is generated by Dialogflow only and not supposed to be
+            # defined by the user.
+            class EndInteraction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specifies an audio clip to be played by the client as part of the response.
+            # @!attribute [rw] audio_uri
+            #   @return [::String]
+            #     Required. URI of the audio clip. Dialogflow does not impose any validation on this
+            #     value. It is specific to the client that reads it.
+            # @!attribute [r] allow_playback_interruption
+            #   @return [::Boolean]
+            #     Output only. Whether the playback of this message can be interrupted by the end
+            #     user's speech and the client can then starts the next Dialogflow
+            #     request.
+            class PlayAudio
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Represents an audio message that is composed of both segments
+            # synthesized from the Dialogflow agent prompts and ones hosted externally
+            # at the specified URIs.
+            # The external URIs are specified via
+            # {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage#play_audio play_audio}.
+            # This message is generated by Dialogflow only and not supposed to be
+            # defined by the user.
+            # @!attribute [rw] segments
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::MixedAudio::Segment>]
+            #     Segments this audio response is composed of.
+            class MixedAudio
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Represents one segment of audio.
+              # @!attribute [rw] audio
+              #   @return [::String]
+              #     Raw audio synthesized from the Dialogflow agent's response using
+              #     the output config specified in the request.
+              # @!attribute [rw] uri
+              #   @return [::String]
+              #     Client-specific URI that points to an audio clip accessible to the
+              #     client. Dialogflow does not impose any validation on it.
+              # @!attribute [r] allow_playback_interruption
+              #   @return [::Boolean]
+              #     Output only. Whether the playback of this segment can be interrupted by the end
+              #     user's speech and the client should then start the next Dialogflow
+              #     request.
+              class Segment
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,222 @@
+# 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
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#get_security_settings SecuritySettingsService.GetSecuritySettings}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Resource name of the settings.
+          #     Format: `projects/<Project ID>/locations/<Location
+          #     ID>/securitySettings/<security settings ID>`.
+          class GetSecuritySettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client#update_security_settings SecuritySettingsService.UpdateSecuritySettings}.
+          # @!attribute [rw] security_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
+          #     Required. [SecuritySettings] object that contains values for each of the
+          #     fields to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The mask to control which fields get updated. If the mask is not present,
+          #     all fields will be updated.
+          class UpdateSecuritySettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for [SecuritySettings.ListSecuritySettings][].
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The location to list all security settings for.
+          #     Format: `projects/<Project ID>/locations/<Location 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 ListSecuritySettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for [SecuritySettings.ListSecuritySettings][].
+          # @!attribute [rw] security_settings
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings>]
+          #     The list of security settings.
+          # @!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 ListSecuritySettingsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for [SecuritySettings.CreateSecuritySettings][].
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The location to create an {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>`.
+          # @!attribute [rw] security_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings]
+          #     Required. The security settings to create.
+          class CreateSecuritySettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for [SecuritySettings.DeleteSecuritySettings][].
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::SecuritySettings SecuritySettings} to delete.
+          #     Format: `projects/<Project ID>/locations/<Location
+          #     ID>/securitySettings/<Security Settings ID>`.
+          class DeleteSecuritySettingsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the settings related to security issues, such as data redaction
+          # and data retention. It may take hours for updates on the settings to
+          # propagate to all the related components and take effect.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Resource name of the settings.
+          #     Format: `projects/<Project ID>/locations/<Location
+          #     ID>/securitySettings/<Security Settings ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the security settings, unique within the
+          #     location.
+          # @!attribute [rw] redaction_strategy
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionStrategy]
+          #     Strategy that defines how we do redaction.
+          # @!attribute [rw] redaction_scope
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::RedactionScope]
+          #     Defines the data for which Dialogflow applies redaction. Dialogflow does
+          #     not redact data that it does not have access to – for example, Cloud
+          #     logging.
+          # @!attribute [rw] inspect_template
+          #   @return [::String]
+          #     [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
+          #     template to define inspect base settings.
+          #
+          #     If empty, we use the default DLP inspect config.
+          #
+          #     The template name will have one of the following formats:
+          #     `projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template
+          #     ID>` OR `organizations/<Organization ID>/locations/<Location
+          #     ID>/inspectTemplates/<Template ID>`
+          #
+          #     Note: `inspect_template` must be located in the same region as the
+          #     `SecuritySettings`.
+          # @!attribute [rw] deidentify_template
+          #   @return [::String]
+          #     [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
+          #     template to define de-identification configuration for the content.
+          #
+          #     If empty, Dialogflow replaces sensitive info with `[redacted]` text.
+          #
+          #     The template name will have one of the following formats:
+          #     `projects/<Project ID>/locations/<Location
+          #     ID>/deidentifyTemplates/<Template ID>` OR `organizations/<Organization
+          #     ID>/locations/<Location ID>/deidentifyTemplates/<Template ID>`
+          #
+          #     Note: `deidentify_template` must be located in the same region as the
+          #     `SecuritySettings`.
+          # @!attribute [rw] retention_window_days
+          #   @return [::Integer]
+          #     Retains data in interaction logging for the specified number of days.
+          #     This does not apply to Cloud logging, which is owned by the user - not
+          #     Dialogflow.
+          #     User must Set a value lower than Dialogflow's default 30d TTL. Setting a
+          #     value higher than that has no effect.
+          #     A missing value or setting to 0 also means we use Dialogflow's default
+          #     TTL.
+          #     Note: Interaction logging is a limited access feature. Talk to your
+          #     Google representative to check availability for you.
+          # @!attribute [rw] purge_data_types
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::PurgeDataType>]
+          #     List of types of data to remove when retention settings triggers purge.
+          # @!attribute [rw] insights_export_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SecuritySettings::InsightsExportSettings]
+          #     Controls conversation exporting settings to Insights after conversation is
+          #     completed.
+          #
+          #     If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION,
+          #     Insights export is disabled no matter what you configure here.
+          class SecuritySettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Settings for exporting conversations to
+            # [Insights](https://cloud.google.com/dialogflow/priv/docs/insights).
+            # @!attribute [rw] enable_insights_export
+            #   @return [::Boolean]
+            #     If enabled, we will automatically exports
+            #     conversations to Insights and Insights runs its analyzers.
+            class InsightsExportSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Defines how we redact data.
+            module RedactionStrategy
+              # Do not redact.
+              REDACTION_STRATEGY_UNSPECIFIED = 0
+
+              # Call redaction service to clean up the data to be persisted.
+              REDACT_WITH_SERVICE = 1
+            end
+
+            # Defines what types of data to redact.
+            module RedactionScope
+              # Don't redact any kind of data.
+              REDACTION_SCOPE_UNSPECIFIED = 0
+
+              # On data to be written to disk or similar devices that are capable of
+              # holding data even if power is disconnected. This includes data that are
+              # temporarily saved on disk.
+              REDACT_DISK_STORAGE = 2
+            end
+
+            # Type of data we purge after retention settings triggers purge.
+            module PurgeDataType
+              # Unspecified. Do not use.
+              PURGE_DATA_TYPE_UNSPECIFIED = 0
+
+              # Dialogflow history. This does not include Cloud logging, which is
+              # owned by the user - not Dialogflow.
+              DIALOGFLOW_HISTORY = 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,798 @@
+# 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
+          # The request to detect user's intent.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Required. The name of the session this query is sent to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
+          #     If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          #     It's up to the API caller to choose an appropriate `Session ID`. It can be
+          #     a random number or some type of session identifiers (preferably hashed).
+          #     The length of the `Session ID` must not exceed 36 characters.
+          #
+          #     For more information, see the [sessions
+          #     guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
+          #
+          #     Note: Always use agent versions for production traffic.
+          #     See [Versions and
+          #     environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
+          # @!attribute [rw] query_params
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryParameters]
+          #     The parameters of this query.
+          # @!attribute [rw] query_input
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
+          #     Required. The input specification.
+          # @!attribute [rw] output_audio_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig]
+          #     Instructs the speech synthesizer how to generate the output audio.
+          class DetectIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The message returned from the DetectIntent method.
+          # @!attribute [rw] response_id
+          #   @return [::String]
+          #     Output only. The unique identifier of the response. It can be used to
+          #     locate a response in the training example set or for reporting issues.
+          # @!attribute [rw] query_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryResult]
+          #     The result of the conversational query.
+          # @!attribute [rw] output_audio
+          #   @return [::String]
+          #     The audio data bytes encoded as specified in the request.
+          #     Note: The output audio is generated based on the values of default platform
+          #     text responses found in the
+          #     {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`} field. If
+          #     multiple default text responses exist, they will be concatenated when
+          #     generating audio. If no default platform text responses exist, the
+          #     generated audio content will be empty.
+          #
+          #     In some scenarios, multiple output audio fields may be present in the
+          #     response structure. In these cases, only the top-most-level audio output
+          #     has content.
+          # @!attribute [rw] output_audio_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig]
+          #     The config used by the speech synthesizer to generate the output audio.
+          # @!attribute [rw] response_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse::ResponseType]
+          #     Response type.
+          # @!attribute [rw] allow_cancellation
+          #   @return [::Boolean]
+          #     Indicates whether the partial response can be cancelled when a later
+          #     response arrives. e.g. if the agent specified some music as partial
+          #     response, it can be cancelled.
+          class DetectIntentResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents different DetectIntentResponse types.
+            module ResponseType
+              # Not specified. This should never happen.
+              RESPONSE_TYPE_UNSPECIFIED = 0
+
+              # Partial response. e.g. Aggregated responses in a Fulfillment that enables
+              # `return_partial_response` can be returned as partial response.
+              # WARNING: partial response is not eligible for barge-in.
+              PARTIAL = 1
+
+              # Final response.
+              FINAL = 2
+            end
+          end
+
+          # The top-level message sent by the client to the
+          # {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent Sessions.StreamingDetectIntent} method.
+          #
+          # Multiple request messages should be sent in order:
+          #
+          # 1.  The first message must contain
+          # {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
+          #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} plus optionally
+          #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}. If the client
+          #     wants to receive an audio response, it should also contain
+          #     {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#output_audio_config output_audio_config}.
+          #
+          # 2.  If {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} was set to
+          #     {::Google::Cloud::Dialogflow::CX::V3::AudioInput#config query_input.audio.config}, all subsequent messages
+          #     must contain {::Google::Cloud::Dialogflow::CX::V3::AudioInput#audio query_input.audio.audio} to continue with
+          #     Speech recognition.
+          #     If you decide to rather detect an intent from text
+          #     input after you already started Speech recognition, please send a message
+          #     with {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text query_input.text}.
+          #
+          #     However, note that:
+          #
+          #     * Dialogflow will bill you for the audio duration so far.
+          #     * Dialogflow discards all Speech recognition results in favor of the
+          #       input text.
+          #     * Dialogflow will use the language code from the first message.
+          #
+          # After you sent all input, you must half-close or abort the request stream.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     The name of the session this query is sent to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
+          #     If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          #     It's up to the API caller to choose an appropriate `Session ID`. It can be
+          #     a random number or some type of session identifiers (preferably hashed).
+          #     The length of the `Session ID` must not exceed 36 characters.
+          #     Note: session must be set in the first request.
+          #
+          #     For more information, see the [sessions
+          #     guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
+          #
+          #     Note: Always use agent versions for production traffic.
+          #     See [Versions and
+          #     environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
+          # @!attribute [rw] query_params
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryParameters]
+          #     The parameters of this query.
+          # @!attribute [rw] query_input
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
+          #     Required. The input specification.
+          # @!attribute [rw] output_audio_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig]
+          #     Instructs the speech synthesizer how to generate the output audio.
+          # @!attribute [rw] enable_partial_response
+          #   @return [::Boolean]
+          #     Enable partial detect intent response. If this flag is not enabled,
+          #     response stream still contains only one final `DetectIntentResponse` even
+          #     if some `Fulfillment`s in the agent have been configured to return partial
+          #     responses.
+          class StreamingDetectIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The top-level message returned from the `StreamingDetectIntent` method.
+          #
+          # Multiple response messages can be returned in order:
+          #
+          # 1.  If the input was set to streaming audio, the first one or more messages
+          #     contain `recognition_result`. Each `recognition_result` represents a more
+          #     complete transcript of what the user said. The last `recognition_result`
+          #     has `is_final` set to `true`.
+          #
+          # 2.  If `enable_partial_response` is true, the following N messages
+          #     (currently 1 <= N <= 4) contain `detect_intent_response`. The first (N-1)
+          #     `detect_intent_response`s will have `response_type` set to `PARTIAL`.
+          #     The last `detect_intent_response` has `response_type` set to `FINAL`.
+          #     If `response_type` is false, response stream only contains
+          #     the final `detect_intent_response`.
+          # @!attribute [rw] recognition_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
+          #     The result of speech recognition.
+          # @!attribute [rw] detect_intent_response
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse]
+          #     The response from detect intent.
+          class StreamingDetectIntentResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Contains a speech recognition result corresponding to a portion of the audio
+          # that is currently being processed or an indication that this is the end
+          # of the single requested utterance.
+          #
+          # Example:
+          #
+          # 1.  transcript: "tube"
+          #
+          # 2.  transcript: "to be a"
+          #
+          # 3.  transcript: "to be"
+          #
+          # 4.  transcript: "to be or not to be"
+          #     is_final: true
+          #
+          # 5.  transcript: " that's"
+          #
+          # 6.  transcript: " that is"
+          #
+          # 7.  message_type: `END_OF_SINGLE_UTTERANCE`
+          #
+          # 8.  transcript: " that is the question"
+          #     is_final: true
+          #
+          # Only two of the responses contain final results (#4 and #8 indicated by
+          # `is_final: true`). Concatenating these generates the full transcript: "to be
+          # or not to be that is the question".
+          #
+          # In each response we populate:
+          #
+          # *  for `TRANSCRIPT`: `transcript` and possibly `is_final`.
+          #
+          # *  for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
+          # @!attribute [rw] message_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult::MessageType]
+          #     Type of the result message.
+          # @!attribute [rw] transcript
+          #   @return [::String]
+          #     Transcript text representing the words that the user spoke.
+          #     Populated if and only if `message_type` = `TRANSCRIPT`.
+          # @!attribute [rw] is_final
+          #   @return [::Boolean]
+          #     If `false`, the `StreamingRecognitionResult` represents an
+          #     interim result that may change. If `true`, the recognizer will not return
+          #     any further hypotheses about this piece of the audio. May only be populated
+          #     for `message_type` = `TRANSCRIPT`.
+          # @!attribute [rw] confidence
+          #   @return [::Float]
+          #     The Speech confidence between 0.0 and 1.0 for the current portion of audio.
+          #     A higher number indicates an estimated greater likelihood that the
+          #     recognized words are correct. The default of 0.0 is a sentinel value
+          #     indicating that confidence was not set.
+          #
+          #     This field is typically only provided if `is_final` is true and you should
+          #     not rely on it being accurate or even set.
+          # @!attribute [rw] stability
+          #   @return [::Float]
+          #     An estimate of the likelihood that the speech recognizer will
+          #     not change its guess about this interim recognition result:
+          #     * If the value is unspecified or 0.0, Dialogflow didn't compute the
+          #       stability. In particular, Dialogflow will only provide stability for
+          #       `TRANSCRIPT` results with `is_final = false`.
+          #     * Otherwise, the value is in (0.0, 1.0] where 0.0 means completely
+          #       unstable and 1.0 means completely stable.
+          # @!attribute [rw] speech_word_info
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SpeechWordInfo>]
+          #     Word-specific information for the words recognized by Speech in
+          #     {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult#transcript transcript}. Populated if and only if `message_type` = `TRANSCRIPT` and
+          #     [InputAudioConfig.enable_word_info] is set.
+          # @!attribute [rw] speech_end_offset
+          #   @return [::Google::Protobuf::Duration]
+          #     Time offset of the end of this Speech recognition result relative to the
+          #     beginning of the audio. Only populated for `message_type` =
+          #     `TRANSCRIPT`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Detected language code for the transcript.
+          class StreamingRecognitionResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Type of the response message.
+            module MessageType
+              # Not specified. Should never be used.
+              MESSAGE_TYPE_UNSPECIFIED = 0
+
+              # Message contains a (possibly partial) transcript.
+              TRANSCRIPT = 1
+
+              # Event indicates that the server has detected the end of the user's speech
+              # utterance and expects no additional speech. Therefore, the server will
+              # not process additional audio (although it may subsequently return
+              # additional results). The client should stop sending additional audio
+              # data, half-close the gRPC connection, and wait for any additional results
+              # until the server closes the gRPC connection. This message is only sent if
+              # {::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig#single_utterance `single_utterance`} was set to
+              # `true`, and is not used otherwise.
+              END_OF_SINGLE_UTTERANCE = 2
+            end
+          end
+
+          # Represents the parameters of a conversational query.
+          # @!attribute [rw] time_zone
+          #   @return [::String]
+          #     The time zone of this conversational query from the [time zone
+          #     database](https://www.iana.org/time-zones), e.g., America/New_York,
+          #     Europe/Paris. If not provided, the time zone specified in the agent is
+          #     used.
+          # @!attribute [rw] geo_location
+          #   @return [::Google::Type::LatLng]
+          #     The geo location of this conversational query.
+          # @!attribute [rw] session_entity_types
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SessionEntityType>]
+          #     Additional session entity types to replace or extend developer entity types
+          #     with. The entity synonyms apply to all languages and persist for the
+          #     session of this query.
+          # @!attribute [rw] payload
+          #   @return [::Google::Protobuf::Struct]
+          #     This field can be used to pass custom data into the webhook associated with
+          #     the agent. Arbitrary JSON objects are supported.
+          #     Some integrations that query a Dialogflow agent may provide additional
+          #     information in the payload.
+          #     In particular, for the Dialogflow Phone Gateway integration, this field has
+          #     the form:
+          #     ```
+          #     {
+          #      "telephony": {
+          #        "caller_id": "+18558363987"
+          #      }
+          #     }
+          #     ```
+          # @!attribute [rw] parameters
+          #   @return [::Google::Protobuf::Struct]
+          #     Additional parameters to be put into [session
+          #     parameters][SessionInfo.parameters]. To remove a
+          #     parameter from the session, clients should explicitly set the parameter
+          #     value to null.
+          #
+          #     You can reference the session parameters in the agent with the following
+          #     format: $session.params.parameter-id.
+          #
+          #     Depending on your protocol or client library language, this is a
+          #     map, associative array, symbol table, dictionary, or JSON object
+          #     composed of a collection of (MapKey, MapValue) pairs:
+          #
+          #     -   MapKey type: string
+          #     -   MapKey value: parameter name
+          #     -   MapValue type:
+          #         -   If parameter's entity type is a composite entity: map
+          #         -   Else: depending on parameter value type, could be one of string,
+          #             number, boolean, null, list or map
+          #     -   MapValue value:
+          #         -   If parameter's entity type is a composite entity:
+          #             map from composite entity property names to property values
+          #         -   Else: parameter value
+          # @!attribute [rw] current_page
+          #   @return [::String]
+          #     The unique identifier of the {::Google::Cloud::Dialogflow::CX::V3::Page page} to override the [current
+          #     page][QueryResult.current_page] in the session.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/pages/<Page ID>`.
+          #
+          #     If `current_page` is specified, the previous state of the session will be
+          #     ignored by Dialogflow, including the [previous
+          #     page][QueryResult.current_page] and the [previous session
+          #     parameters][QueryResult.parameters].
+          #     In most cases, {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#current_page current_page} and
+          #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#parameters parameters} should be configured together to
+          #     direct a session to a specific state.
+          # @!attribute [rw] disable_webhook
+          #   @return [::Boolean]
+          #     Whether to disable webhook calls for this request.
+          # @!attribute [rw] analyze_query_text_sentiment
+          #   @return [::Boolean]
+          #     Configures whether sentiment analysis should be performed. If not
+          #     provided, sentiment analysis is not performed.
+          # @!attribute [rw] webhook_headers
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     This field can be used to pass HTTP headers for a webhook
+          #     call. These headers will be sent to webhook along with the headers that
+          #     have been configured through Dialogflow web console. The headers defined
+          #     within this field will overwrite the headers configured through Dialogflow
+          #     console if there is a conflict. Header names are case-insensitive.
+          #     Google's specified headers are not allowed. Including: "Host",
+          #     "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
+          #     "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
+          # @!attribute [rw] flow_versions
+          #   @return [::Array<::String>]
+          #     A list of flow versions to override for the request.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+          #
+          #     If version 1 of flow X is included in this list, the traffic of
+          #     flow X will go through version 1 regardless of the version configuration in
+          #     the environment. Each flow can have at most one version specified in this
+          #     list.
+          class QueryParameters
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class WebhookHeadersEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Represents the query input. It can contain one of:
+          #
+          # 1.  A conversational query in the form of text.
+          #
+          # 2.  An intent query that specifies which intent to trigger.
+          #
+          # 3.  Natural language speech audio to be processed.
+          #
+          # 4.  An event to be triggered.
+          # @!attribute [rw] text
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TextInput]
+          #     The natural language text to be processed.
+          # @!attribute [rw] intent
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::IntentInput]
+          #     The intent to be triggered.
+          # @!attribute [rw] audio
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::AudioInput]
+          #     The natural language speech audio to be processed.
+          # @!attribute [rw] event
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::EventInput]
+          #     The event to be triggered.
+          # @!attribute [rw] dtmf
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::DtmfInput]
+          #     The DTMF event to be handled.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     Required. The language of the input. See [Language
+          #     Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     for a list of the currently supported language codes. Note that queries in
+          #     the same session do not necessarily need to specify the same language.
+          class QueryInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the result of a conversational query.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was provided as input, this field
+          #     will contain a copy of the text.
+          # @!attribute [rw] trigger_intent
+          #   @return [::String]
+          #     If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as input, this field will
+          #     contain a copy of the intent identifier.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          # @!attribute [rw] transcript
+          #   @return [::String]
+          #     If {::Google::Cloud::Dialogflow::CX::V3::AudioInput natural language speech audio} was provided as input,
+          #     this field will contain the transcript for the audio.
+          # @!attribute [rw] trigger_event
+          #   @return [::String]
+          #     If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will contain
+          #     the name of the event.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language that was triggered during intent detection.
+          #     See [Language
+          #     Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     for a list of the currently supported language codes.
+          # @!attribute [rw] parameters
+          #   @return [::Google::Protobuf::Struct]
+          #     The collected {::Google::Cloud::Dialogflow::CX::V3::SessionInfo#parameters session parameters}.
+          #
+          #     Depending on your protocol or client library language, this is a
+          #     map, associative array, symbol table, dictionary, or JSON object
+          #     composed of a collection of (MapKey, MapValue) pairs:
+          #
+          #     -   MapKey type: string
+          #     -   MapKey value: parameter name
+          #     -   MapValue type:
+          #         -   If parameter's entity type is a composite entity: map
+          #         -   Else: depending on parameter value type, could be one of string,
+          #             number, boolean, null, list or map
+          #     -   MapValue value:
+          #         -   If parameter's entity type is a composite entity:
+          #             map from composite entity property names to property values
+          #         -   Else: parameter value
+          # @!attribute [rw] response_messages
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
+          #     The list of rich messages returned to the client. Responses vary from
+          #     simple text messages to more sophisticated, structured payloads used
+          #     to drive complex logic.
+          # @!attribute [rw] webhook_statuses
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     The list of webhook call status in the order of call sequence.
+          # @!attribute [rw] webhook_payloads
+          #   @return [::Array<::Google::Protobuf::Struct>]
+          #     The list of webhook payload in {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse#payload WebhookResponse.payload}, in
+          #     the order of call sequence. If some webhook call fails or doesn't return
+          #     any payload, an empty `Struct` would be used instead.
+          # @!attribute [rw] current_page
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+          #     The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all fields are filled in this message,
+          #     including but not limited to `name` and `display_name`.
+          # @!attribute [rw] intent
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
+          #     The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the conversational query. Some, not all fields
+          #     are filled in this message, including but not limited to: `name` and
+          #     `display_name`.
+          #     This field is deprecated, please use {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match} instead.
+          # @!attribute [rw] intent_detection_confidence
+          #   @return [::Float]
+          #     The intent detection confidence. Values range from 0.0 (completely
+          #     uncertain) to 1.0 (completely certain).
+          #     This value is for informational purpose only and is only used to
+          #     help match the best intent within the classification threshold.
+          #     This value may change for the same end-user expression at any time due to a
+          #     model retraining or change in implementation.
+          #     This field is deprecated, please use {::Google::Cloud::Dialogflow::CX::V3::QueryResult#match QueryResult.match} instead.
+          # @!attribute [rw] match
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Match]
+          #     Intent match result, could be an intent or an event.
+          # @!attribute [rw] diagnostic_info
+          #   @return [::Google::Protobuf::Struct]
+          #     The free-form diagnostic info. For example, this field could contain
+          #     webhook call latency. The string keys of the Struct's fields map can change
+          #     without notice.
+          # @!attribute [rw] sentiment_analysis_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult]
+          #     The sentiment analyss result, which depends on
+          #     [`analyze_query_text_sentiment`]
+          #     [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.
+          class QueryResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the natural language text to be processed.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     Required. The UTF-8 encoded natural language text to be processed. Text length must
+          #     not exceed 256 characters.
+          class TextInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the intent to trigger programmatically rather than as a result of
+          # natural language processing.
+          # @!attribute [rw] intent
+          #   @return [::String]
+          #     Required. The unique identifier of the intent.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          class IntentInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the natural speech audio to be processed.
+          # @!attribute [rw] config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::InputAudioConfig]
+          #     Required. Instructs the speech recognizer how to process the speech audio.
+          # @!attribute [rw] audio
+          #   @return [::String]
+          #     The natural language speech audio to be processed.
+          #     A single request can contain up to 1 minute of speech audio data.
+          #     The {::Google::Cloud::Dialogflow::CX::V3::QueryResult#transcript transcribed text} cannot contain more than 256
+          #     bytes.
+          #
+          #     For non-streaming audio detect intent, both `config` and `audio` must be
+          #     provided.
+          #     For streaming audio detect intent, `config` must be provided in
+          #     the first request and `audio` must be provided in all following requests.
+          class AudioInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the event to trigger.
+          # @!attribute [rw] event
+          #   @return [::String]
+          #     Name of the event.
+          class EventInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the input for dtmf event.
+          # @!attribute [rw] digits
+          #   @return [::String]
+          #     The dtmf digits.
+          # @!attribute [rw] finish_digit
+          #   @return [::String]
+          #     The finish digit (if any).
+          class DtmfInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents one match result of [MatchIntent][].
+          # @!attribute [rw] intent
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
+          #     The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that matched the query. Some, not all fields are filled in
+          #     this message, including but not limited to: `name` and `display_name`. Only
+          #     filled for {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `INTENT`} match type.
+          # @!attribute [rw] event
+          #   @return [::String]
+          #     The event that matched the query. Only filled for
+          #     {::Google::Cloud::Dialogflow::CX::V3::Match::MatchType `EVENT`} match type.
+          # @!attribute [rw] parameters
+          #   @return [::Google::Protobuf::Struct]
+          #     The collection of parameters extracted from the query.
+          #
+          #     Depending on your protocol or client library language, this is a
+          #     map, associative array, symbol table, dictionary, or JSON object
+          #     composed of a collection of (MapKey, MapValue) pairs:
+          #
+          #     -   MapKey type: string
+          #     -   MapKey value: parameter name
+          #     -   MapValue type:
+          #         -   If parameter's entity type is a composite entity: map
+          #         -   Else: depending on parameter value type, could be one of string,
+          #             number, boolean, null, list or map
+          #     -   MapValue value:
+          #         -   If parameter's entity type is a composite entity:
+          #             map from composite entity property names to property values
+          #         -   Else: parameter value
+          # @!attribute [rw] resolved_input
+          #   @return [::String]
+          #     Final text input which was matched during MatchIntent. This value can be
+          #     different from original input sent in request because of spelling
+          #     correction or other processing.
+          # @!attribute [rw] match_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Match::MatchType]
+          #     Type of this {::Google::Cloud::Dialogflow::CX::V3::Match Match}.
+          # @!attribute [rw] confidence
+          #   @return [::Float]
+          #     The confidence of this match. Values range from 0.0 (completely uncertain)
+          #     to 1.0 (completely certain).
+          #     This value is for informational purpose only and is only used to help match
+          #     the best intent within the classification threshold. This value may change
+          #     for the same end-user expression at any time due to a model retraining or
+          #     change in implementation.
+          class Match
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Type of a Match.
+            module MatchType
+              # Not specified. Should never be used.
+              MATCH_TYPE_UNSPECIFIED = 0
+
+              # The query was matched to an intent.
+              INTENT = 1
+
+              # The query directly triggered an intent.
+              DIRECT_INTENT = 2
+
+              # The query was used for parameter filling.
+              PARAMETER_FILLING = 3
+
+              # No match was found for the query.
+              NO_MATCH = 4
+
+              # Indicates an empty query.
+              NO_INPUT = 5
+
+              # The query directly triggered an event.
+              EVENT = 6
+            end
+          end
+
+          # Request of [MatchIntent][].
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Required. The name of the session this query is sent to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
+          #     If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          #     It's up to the API caller to choose an appropriate `Session ID`. It can be
+          #     a random number or some type of session identifiers (preferably hashed).
+          #     The length of the `Session ID` must not exceed 36 characters.
+          #
+          #     For more information, see the [sessions
+          #     guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
+          # @!attribute [rw] query_params
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryParameters]
+          #     The parameters of this query.
+          # @!attribute [rw] query_input
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
+          #     Required. The input specification.
+          class MatchIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response of [MatchIntent][].
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     If {::Google::Cloud::Dialogflow::CX::V3::TextInput natural language text} was provided as input, this field
+          #     will contain a copy of the text.
+          # @!attribute [rw] trigger_intent
+          #   @return [::String]
+          #     If an {::Google::Cloud::Dialogflow::CX::V3::IntentInput intent} was provided as input, this field will
+          #     contain a copy of the intent identifier.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/intents/<Intent ID>`.
+          # @!attribute [rw] transcript
+          #   @return [::String]
+          #     If {::Google::Cloud::Dialogflow::CX::V3::AudioInput natural language speech audio} was provided as input,
+          #     this field will contain the transcript for the audio.
+          # @!attribute [rw] trigger_event
+          #   @return [::String]
+          #     If an {::Google::Cloud::Dialogflow::CX::V3::EventInput event} was provided as input, this field will
+          #     contain a copy of the event name.
+          # @!attribute [rw] matches
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Match>]
+          #     Match results, if more than one, ordered descendingly by the confidence
+          #     we have that the particular intent matches the query.
+          # @!attribute [rw] current_page
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+          #     The current {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Some, not all fields are filled in this message,
+          #     including but not limited to `name` and `display_name`.
+          class MatchIntentResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request of [FulfillIntent][]
+          # @!attribute [rw] match_intent_request
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::MatchIntentRequest]
+          #     Must be same as the corresponding MatchIntent request, otherwise the
+          #     behavior is undefined.
+          # @!attribute [rw] match
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Match]
+          #     The matched intent/event to fulfill.
+          # @!attribute [rw] output_audio_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig]
+          #     Instructs the speech synthesizer how to generate output audio.
+          class FulfillIntentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response of [FulfillIntent][]
+          # @!attribute [rw] response_id
+          #   @return [::String]
+          #     Output only. The unique identifier of the response. It can be used to
+          #     locate a response in the training example set or for reporting issues.
+          # @!attribute [rw] query_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryResult]
+          #     The result of the conversational query.
+          # @!attribute [rw] output_audio
+          #   @return [::String]
+          #     The audio data bytes encoded as specified in the request.
+          #     Note: The output audio is generated based on the values of default platform
+          #     text responses found in the
+          #     {::Google::Cloud::Dialogflow::CX::V3::QueryResult#response_messages `query_result.response_messages`} field. If
+          #     multiple default text responses exist, they will be concatenated when
+          #     generating audio. If no default platform text responses exist, the
+          #     generated audio content will be empty.
+          #
+          #     In some scenarios, multiple output audio fields may be present in the
+          #     response structure. In these cases, only the top-most-level audio output
+          #     has content.
+          # @!attribute [rw] output_audio_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig]
+          #     The config used by the speech synthesizer to generate the output audio.
+          class FulfillIntentResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The result of sentiment analysis. Sentiment analysis inspects user input
+          # and identifies the prevailing subjective opinion, especially to determine a
+          # user's attitude as positive, negative, or neutral.
+          # @!attribute [rw] score
+          #   @return [::Float]
+          #     Sentiment score between -1.0 (negative sentiment) and 1.0 (positive
+          #     sentiment).
+          # @!attribute [rw] magnitude
+          #   @return [::Float]
+          #     A non-negative number in the [0, +inf) range, which represents the absolute
+          #     magnitude of sentiment, regardless of score (positive or negative).
+          class SentimentAnalysisResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end