google-cloud-dialogflow-v2 0.6.4 → 0.7.0

data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb

@@ -29,6 +29,7 @@ module Google
         #     recognizer should recognize with higher likelihood.
         #
         #     This list can be used to:
+        #
         #     * improve accuracy for words and phrases you expect the user to say,
         #       e.g. typical commands for your Dialogflow agent
         #     * add additional words to the speech recognizer vocabulary
@@ -152,6 +153,12 @@ module Google
         #     Note: This setting is relevant only for streaming methods.
         #     Note: When specified, InputAudioConfig.single_utterance takes precedence
         #     over StreamingDetectIntentRequest.single_utterance.
+        # @!attribute [rw] disable_no_speech_recognized_event
+        #   @return [::Boolean]
+        #     Only used in {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} and
+        #     [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent].
+        #     If `false` and recognition doesn't return any result, trigger
+        #     `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.
         class InputAudioConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -231,6 +238,18 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Configures speech transcription for {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
+        # @!attribute [rw] speech_model_variant
+        #   @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
+        #     Optional. The speech model used in speech to text.
+        #     `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
+        #     `USE_ENHANCED`. It can be overridden in {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest} and
+        #     [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest] request.
+        class SpeechToTextConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Audio encoding of the audio content sent in the conversational query request.
         # Refer to the
         # [Cloud Speech API
@@ -352,11 +371,17 @@ module Google
           # MP3 audio at 32kbps.
           OUTPUT_AUDIO_ENCODING_MP3 = 2
 
+          # MP3 audio at 64kbps.
+          OUTPUT_AUDIO_ENCODING_MP3_64_KBPS = 4
+
           # Opus encoded audio wrapped in an ogg container. The result will be a
           # file which can be played natively on Android, and in browsers (at least
           # Chrome and Firefox). The quality of the encoding is considerably higher
           # than MP3 while using approximately the same bitrate.
           OUTPUT_AUDIO_ENCODING_OGG_OPUS = 3
+
+          # 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
+          OUTPUT_AUDIO_ENCODING_MULAW = 5
         end
       end
     end

data/proto_docs/google/cloud/dialogflow/v2/context.rb

@@ -21,7 +21,21 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        # Represents a context.
+        # Dialogflow contexts are similar to natural language context. If a person says
+        # to you "they are orange", you need context in order to understand what "they"
+        # is referring to. Similarly, for Dialogflow to handle an end-user expression
+        # like that, it needs to be provided with context in order to correctly match
+        # an intent.
+        #
+        # Using contexts, you can control the flow of a conversation. You can configure
+        # contexts for an intent by setting input and output contexts, which are
+        # identified by string names. When an intent is matched, any configured output
+        # contexts for that intent become active. While any contexts are active,
+        # Dialogflow is more likely to match intents that are configured with input
+        # contexts that correspond to the currently active contexts.
+        #
+        # For more information about context, see the
+        # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The unique identifier of the context. Format:
@@ -59,7 +73,8 @@ module Google
         #     -   MapKey value: parameter name
         #     -   MapValue type:
         #         -   If parameter's entity type is a composite entity: map
-        #         -   Else: string or number, depending on parameter value type
+        #         -   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

data/proto_docs/google/cloud/dialogflow/v2/conversation.rb

@@ -0,0 +1,253 @@
+# 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 V2
+        # Represents a conversation.
+        # A conversation is an interaction between an agent, including live agents
+        # and Dialogflow agents, and a support customer. Conversations can
+        # include phone calls and text-based chat sessions.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The unique identifier of this conversation.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversations/<Conversation ID>`.
+        # @!attribute [r] lifecycle_state
+        #   @return [::Google::Cloud::Dialogflow::V2::Conversation::LifecycleState]
+        #     Output only. The current state of the Conversation.
+        # @!attribute [rw] conversation_profile
+        #   @return [::String]
+        #     Required. The Conversation Profile to be used to configure this
+        #     Conversation. This field cannot be updated.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversationProfiles/<Conversation Profile ID>`.
+        # @!attribute [r] phone_number
+        #   @return [::Google::Cloud::Dialogflow::V2::ConversationPhoneNumber]
+        #     Output only. It will not be empty if the conversation is to be connected over
+        #     telephony.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the conversation was started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the conversation was finished.
+        # @!attribute [rw] conversation_stage
+        #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage]
+        #     The stage of a conversation. It indicates whether the virtual agent or a
+        #     human agent is handling the conversation.
+        #
+        #     If the conversation is created with the conversation profile that has
+        #     Dialogflow config set, defaults to
+        #     {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE}; Otherwise, defaults to
+        #     {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}.
+        #
+        #     If the conversation is created with the conversation profile that has
+        #     Dialogflow config set but explicitly sets conversation_stage to
+        #     {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}, it skips
+        #     {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::VIRTUAL_AGENT_STAGE ConversationStage.VIRTUAL_AGENT_STAGE} stage and directly goes to
+        #     {::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage::HUMAN_ASSIST_STAGE ConversationStage.HUMAN_ASSIST_STAGE}.
+        class Conversation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enumeration of the completion status of the conversation.
+          module LifecycleState
+            # Unknown.
+            LIFECYCLE_STATE_UNSPECIFIED = 0
+
+            # Conversation is currently open for media analysis.
+            IN_PROGRESS = 1
+
+            # Conversation has been completed.
+            COMPLETED = 2
+          end
+
+          # Enumeration of the different conversation stages a conversation can be in.
+          # Reference:
+          # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
+          module ConversationStage
+            # Unknown. Should never be used after a conversation is successfully
+            # created.
+            CONVERSATION_STAGE_UNSPECIFIED = 0
+
+            # The conversation should return virtual agent responses into the
+            # conversation.
+            VIRTUAL_AGENT_STAGE = 1
+
+            # The conversation should not provide responses, just listen and provide
+            # suggestions.
+            HUMAN_ASSIST_STAGE = 2
+          end
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#create_conversation Conversations.CreateConversation}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Resource identifier of the project creating the conversation.
+        #     Format: `projects/<Project ID>/locations/<Location ID>`.
+        # @!attribute [rw] conversation
+        #   @return [::Google::Cloud::Dialogflow::V2::Conversation]
+        #     Required. The conversation to create.
+        # @!attribute [rw] conversation_id
+        #   @return [::String]
+        #     Optional. Identifier of the conversation. Generally it's auto generated by Google.
+        #     Only set it if you cannot wait for the response to return a
+        #     auto-generated one to you.
+        #
+        #     The conversation ID must be compliant with the regression fomula
+        #     "[a-zA-Z][a-zA-Z0-9_-]*" with the characters length in range of [3,64].
+        #     If the field is provided, the caller is resposible for
+        #     1. the uniqueness of the ID, otherwise the request will be rejected.
+        #     2. the consistency for whether to use custom ID or not under a project to
+        #     better ensure uniqueness.
+        class CreateConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project from which to list all conversation.
+        #     Format: `projects/<Project ID>/locations/<Location ID>`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of items to return in a single page. By
+        #     default 100 and at most 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The next_page_token value returned from a previous list request.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     A filter expression that filters conversations listed in the response. In
+        #     general, the expression must specify the field name, a comparison operator,
+        #     and the value to use for filtering:
+        #     <ul>
+        #       <li>The value must be a string, a number, or a boolean.</li>
+        #       <li>The comparison operator must be either `=`,`!=`, `>`, or `<`.</li>
+        #       <li>To filter on multiple expressions, separate the
+        #           expressions with `AND` or `OR` (omitting both implies `AND`).</li>
+        #       <li>For clarity, expressions can be enclosed in parentheses.</li>
+        #     </ul>
+        #     Only `lifecycle_state` can be filtered on in this way. For example,
+        #     the following expression only returns `COMPLETED` conversations:
+        #
+        #     `lifecycle_state = "COMPLETED"`
+        #
+        #     For more information about filtering, see
+        #     [API Filtering](https://aip.dev/160).
+        class ListConversationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_conversations Conversations.ListConversations}.
+        # @!attribute [rw] conversations
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation>]
+        #     The list of conversations. 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 ListConversationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#get_conversation Conversations.GetConversation}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the conversation. Format:
+        #     `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation
+        #     ID>`.
+        class GetConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#complete_conversation Conversations.CompleteConversation}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Resource identifier of the conversation to close.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversations/<Conversation ID>`.
+        class CompleteConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the conversation to list messages for.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversations/<Conversation ID>`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter on message fields. Currently predicates on `create_time`
+        #     and `create_time_epoch_microseconds` are supported. `create_time` only
+        #     support milliseconds accuracy. E.g.,
+        #     `create_time_epoch_microseconds > 1551790877964485` or
+        #     `create_time > 2017-01-15T01:30:15.01Z`.
+        #
+        #     For more information about filtering, see
+        #     [API Filtering](https://aip.dev/160).
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of items to return in a single page. By
+        #     default 100 and at most 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The next_page_token value returned from a previous list request.
+        class ListMessagesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages}.
+        # @!attribute [rw] messages
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::Message>]
+        #     The list of messages. There will be a maximum number of items
+        #     returned based on the page_size field in the request.
+        #     `messages` is sorted by `create_time` in descending order.
+        # @!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 ListMessagesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a phone number for telephony integration. It allows for connecting
+        # a particular conversation over telephony.
+        # @!attribute [r] phone_number
+        #   @return [::String]
+        #     Output only. The phone number to connect to this conversation.
+        class ConversationPhoneNumber
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/v2/conversation_event.rb

@@ -0,0 +1,83 @@
+# 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 V2
+        # Represents a notification sent to Pub/Sub subscribers for conversation
+        # lifecycle events.
+        # @!attribute [rw] conversation
+        #   @return [::String]
+        #     The unique identifier of the conversation this notification
+        #     refers to.
+        #     Format: `projects/<Project ID>/conversations/<Conversation ID>`.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Dialogflow::V2::ConversationEvent::Type]
+        #     The type of the event that this notification refers to.
+        # @!attribute [rw] error_status
+        #   @return [::Google::Rpc::Status]
+        #     More detailed information about an error. Only set for type
+        #     UNRECOVERABLE_ERROR_IN_PHONE_CALL.
+        # @!attribute [rw] new_message_payload
+        #   @return [::Google::Cloud::Dialogflow::V2::Message]
+        #     Payload of NEW_MESSAGE event.
+        class ConversationEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enumeration of the types of events available.
+          module Type
+            # Type not set.
+            TYPE_UNSPECIFIED = 0
+
+            # A new conversation has been opened. This is fired when a telephone call
+            # is answered, or a conversation is created via the API.
+            CONVERSATION_STARTED = 1
+
+            # An existing conversation has closed. This is fired when a telephone call
+            # is terminated, or a conversation is closed via the API.
+            CONVERSATION_FINISHED = 2
+
+            # An existing conversation has received notification from Dialogflow that
+            # human intervention is required.
+            HUMAN_INTERVENTION_NEEDED = 3
+
+            # An existing conversation has received a new message, either from API or
+            # telephony. It is configured in
+            # {::Google::Cloud::Dialogflow::V2::ConversationProfile#new_message_event_notification_config ConversationProfile.new_message_event_notification_config}
+            NEW_MESSAGE = 5
+
+            # Unrecoverable error during a telephone call.
+            #
+            # In general non-recoverable errors only occur if something was
+            # misconfigured in the ConversationProfile corresponding to the call. After
+            # a non-recoverable error, Dialogflow may stop responding.
+            #
+            # We don't fire this event:
+            #
+            # * in an API call because we can directly return the error, or,
+            # * when we can recover from an error.
+            UNRECOVERABLE_ERROR = 4
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb

@@ -0,0 +1,510 @@
+# 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 V2
+        # Defines the services to connect to incoming Dialogflow conversations.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Optional. The unique identifier of this conversation profile.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversationProfiles/<Conversation Profile ID>`.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Human readable name for this profile. Max length 1024 bytes.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time of the conversation profile.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time of the conversation profile.
+        # @!attribute [rw] automated_agent_config
+        #   @return [::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig]
+        #     Configuration for an automated agent to use with this profile.
+        # @!attribute [rw] human_agent_assistant_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig]
+        #     Configuration for agent assistance to use with this profile.
+        # @!attribute [rw] human_agent_handoff_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig]
+        #     Configuration for connecting to a live agent.
+        # @!attribute [rw] notification_config
+        #   @return [::Google::Cloud::Dialogflow::V2::NotificationConfig]
+        #     Configuration for publishing conversation lifecycle events.
+        # @!attribute [rw] logging_config
+        #   @return [::Google::Cloud::Dialogflow::V2::LoggingConfig]
+        #     Configuration for logging conversation lifecycle events.
+        # @!attribute [rw] new_message_event_notification_config
+        #   @return [::Google::Cloud::Dialogflow::V2::NotificationConfig]
+        #     Configuration for publishing new message events. Event will be sent in
+        #     format of {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent}
+        # @!attribute [rw] stt_config
+        #   @return [::Google::Cloud::Dialogflow::V2::SpeechToTextConfig]
+        #     Settings for speech transcription.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Language which represents the conversationProfile.
+        #     If unspecified, the default language code en-us applies. Users need to
+        #     create a ConversationProfile for each language they want to support.
+        class ConversationProfile
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project to list all conversation profiles from.
+        #     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 100 and at most 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The next_page_token value returned from a previous list request.
+        class ListConversationProfilesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#list_conversation_profiles ConversationProfiles.ListConversationProfiles}.
+        # @!attribute [rw] conversation_profiles
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::ConversationProfile>]
+        #     The list of project conversation profiles. There is 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 ListConversationProfilesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#get_conversation_profile ConversationProfiles.GetConversationProfile}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the conversation profile.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversationProfiles/<Conversation Profile ID>`.
+        class GetConversationProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#create_conversation_profile ConversationProfiles.CreateConversationProfile}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project to create a conversation profile for.
+        #     Format: `projects/<Project ID>/locations/<Location ID>`.
+        # @!attribute [rw] conversation_profile
+        #   @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
+        #     Required. The conversation profile to create.
+        class CreateConversationProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#update_conversation_profile ConversationProfiles.UpdateConversationProfile}.
+        # @!attribute [rw] conversation_profile
+        #   @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
+        #     Required. The conversation profile to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The mask to control which fields to update.
+        class UpdateConversationProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#delete_conversation_profile ConversationProfiles.DeleteConversationProfile}.
+        #
+        # This operation fails if the conversation profile is still referenced from
+        # a phone number.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the conversation profile to delete.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/conversationProfiles/<Conversation Profile ID>`.
+        class DeleteConversationProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines the Automated Agent to connect to a conversation.
+        # @!attribute [rw] agent
+        #   @return [::String]
+        #     Required. ID of the Dialogflow agent environment to use.
+        #
+        #     This project needs to either be the same project as the conversation or you
+        #     need to grant `service-<Conversation Project
+        #     Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
+        #     Service Agent` role in this project.
+        #
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/agent/environments/<Environment ID or '-'>`. If environment is not
+        #     specified, the default `draft` environment is used. Refer to
+        #     [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
+        #     for more details.
+        class AutomatedAgentConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines the Human Agent Assist to connect to a conversation.
+        # @!attribute [rw] notification_config
+        #   @return [::Google::Cloud::Dialogflow::V2::NotificationConfig]
+        #     Pub/Sub topic on which to publish new agent assistant events.
+        # @!attribute [rw] human_agent_suggestion_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig]
+        #     Configuration for agent assistance of human agent participant.
+        # @!attribute [rw] end_user_suggestion_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig]
+        #     Configuration for agent assistance of end user participant.
+        # @!attribute [rw] message_analysis_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::MessageAnalysisConfig]
+        #     Configuration for message analysis.
+        class HumanAgentAssistantConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Settings of suggestion trigger.
+          # @!attribute [rw] no_smalltalk
+          #   @return [::Boolean]
+          #     Do not trigger if last utterance is small talk.
+          # @!attribute [rw] only_end_user
+          #   @return [::Boolean]
+          #     Only trigger suggestion if participant role of last utterance is
+          #     END_USER.
+          class SuggestionTriggerSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Config for suggestion features.
+          # @!attribute [rw] suggestion_feature
+          #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature]
+          #     The suggestion feature.
+          # @!attribute [rw] enable_event_based_suggestion
+          #   @return [::Boolean]
+          #     Automatically iterates all participants and tries to compile
+          #     suggestions.
+          #
+          #     Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST.
+          # @!attribute [rw] suggestion_trigger_settings
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionTriggerSettings]
+          #     Settings of suggestion trigger.
+          #
+          #     Currently, only ARTICLE_SUGGESTION and FAQ will use this field.
+          # @!attribute [rw] query_config
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig]
+          #     Configs of query.
+          # @!attribute [rw] conversation_model_config
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
+          #     Configs of custom conversation model.
+          class SuggestionFeatureConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Detail human agent assistant config.
+          # @!attribute [rw] feature_configs
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>]
+          #     Configuration of different suggestion features. One feature can have only
+          #     one config.
+          # @!attribute [rw] group_suggestion_responses
+          #   @return [::Boolean]
+          #     If `group_suggestion_responses` is false, and there are multiple
+          #     `feature_configs` in `event based suggestion` or
+          #     StreamingAnalyzeContent, we will try to deliver suggestions to customers
+          #     as soon as we get new suggestion. Different type of suggestions based on
+          #     the same context will be in  separate Pub/Sub event or
+          #     `StreamingAnalyzeContentResponse`.
+          #
+          #     If `group_suggestion_responses` set to true. All the suggestions to the
+          #     same participant based on the same context will be grouped into a single
+          #     Pub/Sub event or StreamingAnalyzeContentResponse.
+          class SuggestionConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Config for suggestion query.
+          # @!attribute [rw] knowledge_base_query_source
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
+          #     Query from knowledgebase. It is used by:
+          #     ARTICLE_SUGGESTION, FAQ.
+          # @!attribute [rw] document_query_source
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DocumentQuerySource]
+          #     Query from knowledge base document. It is used by:
+          #     SMART_REPLY, SMART_COMPOSE.
+          # @!attribute [rw] dialogflow_query_source
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
+          #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
+          # @!attribute [rw] max_results
+          #   @return [::Integer]
+          #     Maximum number of results to return. Currently, if unset, defaults to 10.
+          #     And the max number is 20.
+          # @!attribute [rw] confidence_threshold
+          #   @return [::Float]
+          #     Confidence threshold of query result.
+          #
+          #     Agent Assist gives each suggestion a score in the range [0.0, 1.0], based
+          #     on the relevance between the suggestion and the current conversation
+          #     context. A score of 0.0 has no relevance, while a score of 1.0 has high
+          #     relevance. Only suggestions with a score greater than or equal to the
+          #     value of this field are included in the results.
+          #
+          #     For a baseline model (the default), the recommended value is in the range
+          #     [0.05, 0.1].
+          #
+          #     For a custom model, there is no recommended value. Tune this value by
+          #     starting from a very low value and slowly increasing until you have
+          #     desired results.
+          #
+          #     If this field is not set, it defaults to 0.0, which means that all
+          #     suggestions are returned.
+          #
+          #     Supported features: ARTICLE_SUGGESTION.
+          # @!attribute [rw] context_filter_settings
+          #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
+          #     Determines how recent conversation context is filtered when generating
+          #     suggestions. If unspecified, no messages will be dropped.
+          class SuggestionQueryConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Knowledge base source settings.
+            #
+            # Supported features: ARTICLE_SUGGESTION, FAQ.
+            # @!attribute [rw] knowledge_bases
+            #   @return [::Array<::String>]
+            #     Required. Knowledge bases to query. Format:
+            #     `projects/<Project ID>/locations/<Location
+            #     ID>/knowledgeBases/<Knowledge Base ID>`. Currently, at most 5 knowledge
+            #     bases are supported.
+            class KnowledgeBaseQuerySource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Document source settings.
+            #
+            # Supported features: SMART_REPLY, SMART_COMPOSE.
+            # @!attribute [rw] documents
+            #   @return [::Array<::String>]
+            #     Required. Knowledge documents to query from. Format:
+            #     `projects/<Project ID>/locations/<Location
+            #     ID>/knowledgeBases/<KnowledgeBase ID>/documents/<Document ID>`.
+            #     Currently, at most 5 documents are supported.
+            class DocumentQuerySource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Dialogflow source setting.
+            #
+            # Supported feature: DIALOGFLOW_ASSIST.
+            # @!attribute [rw] agent
+            #   @return [::String]
+            #     Required. The name of a Dialogflow virtual agent used for end user side intent
+            #     detection and suggestion. Format: `projects/<Project Number/
+            #     ID>/locations/<Location ID>/agent`. When multiple agents are allowed in
+            #     the same Dialogflow project.
+            class DialogflowQuerySource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Settings that determine how to filter recent conversation context when
+            # generating suggestions.
+            # @!attribute [rw] drop_handoff_messages
+            #   @return [::Boolean]
+            #     If set to true, the last message from virtual agent (hand off message)
+            #     and the message before it (trigger message of hand off) are dropped.
+            # @!attribute [rw] drop_virtual_agent_messages
+            #   @return [::Boolean]
+            #     If set to true, all messages from virtual agent are dropped.
+            # @!attribute [rw] drop_ivr_messages
+            #   @return [::Boolean]
+            #     If set to true, all messages from ivr stage are dropped.
+            class ContextFilterSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Custom conversation models used in agent assist feature.
+          #
+          # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
+          # @!attribute [rw] model
+          #   @return [::String]
+          #     Required. Conversation model resource name. Format: `projects/<Project
+          #     ID>/conversationModels/<Model ID>`.
+          class ConversationModelConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for analyses to run on each conversation message.
+          # @!attribute [rw] enable_entity_extraction
+          #   @return [::Boolean]
+          #     Enable entity extraction in conversation messages on [agent assist
+          #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
+          #     If unspecified, defaults to false.
+          # @!attribute [rw] enable_sentiment_analysis
+          #   @return [::Boolean]
+          #     Enable sentiment analysis in conversation messages on [agent assist
+          #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
+          #     If unspecified, defaults to false. Sentiment analysis inspects user input
+          #     and identifies the prevailing subjective opinion, especially to determine
+          #     a user's attitude as positive, negative, or neutral:
+          #     https://cloud.google.com/natural-language/docs/basics#sentiment_analysis
+          #     For [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent] method, result will be in
+          #     [StreamingAnalyzeContentResponse.message.SentimentAnalysisResult][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.message].
+          #     For {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content Participants.AnalyzeContent} method, result will be in
+          #     {::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse#message AnalyzeContentResponse.message.SentimentAnalysisResult}
+          #     For {::Google::Cloud::Dialogflow::V2::Conversations::Client#list_messages Conversations.ListMessages} method, result will be in
+          #     {::Google::Cloud::Dialogflow::V2::ListMessagesResponse#messages ListMessagesResponse.messages.SentimentAnalysisResult}
+          #     If Pub/Sub notification is configured, result will be in
+          #     {::Google::Cloud::Dialogflow::V2::ConversationEvent#new_message_payload ConversationEvent.new_message_payload.SentimentAnalysisResult}.
+          class MessageAnalysisConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Defines the hand off to a live agent, typically on which external agent
+        # service provider to connect to a conversation.
+        # @!attribute [rw] live_person_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::LivePersonConfig]
+        #     Uses LivePerson (https://www.liveperson.com).
+        # @!attribute [rw] salesforce_live_agent_config
+        #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::SalesforceLiveAgentConfig]
+        #     Uses Salesforce Live Agent.
+        class HumanAgentHandoffConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration specific to LivePerson (https://www.liveperson.com).
+          # @!attribute [rw] account_number
+          #   @return [::String]
+          #     Required. Account number of the LivePerson account to connect. This is
+          #     the account number you input at the login page.
+          class LivePersonConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration specific to Salesforce Live Agent.
+          # @!attribute [rw] organization_id
+          #   @return [::String]
+          #     Required. The organization ID of the Salesforce account.
+          # @!attribute [rw] deployment_id
+          #   @return [::String]
+          #     Required. Live Agent deployment ID.
+          # @!attribute [rw] button_id
+          #   @return [::String]
+          #     Required. Live Agent chat button ID.
+          # @!attribute [rw] endpoint_domain
+          #   @return [::String]
+          #     Required. Domain of the Live Agent endpoint for this agent. You can find
+          #     the endpoint URL in the `Live Agent settings` page. For example if URL
+          #     has the form https://d.la4-c2-phx.salesforceliveagent.com/...,
+          #     you should fill in d.la4-c2-phx.salesforceliveagent.com.
+          class SalesforceLiveAgentConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Defines notification behavior.
+        # @!attribute [rw] topic
+        #   @return [::String]
+        #     Name of the Pub/Sub topic to publish conversation
+        #     events like
+        #     {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED} as
+        #     serialized {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
+        #
+        #     Notification works for phone calls, if this topic either is in the same
+        #     project as the conversation or you grant `service-<Conversation Project
+        #     Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service
+        #     Agent` role in the topic project.
+        #
+        #     Format: `projects/<Project ID>/locations/<Location ID>/topics/<Topic ID>`.
+        # @!attribute [rw] message_format
+        #   @return [::Google::Cloud::Dialogflow::V2::NotificationConfig::MessageFormat]
+        #     Format of message.
+        class NotificationConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Format of cloud pub/sub message.
+          module MessageFormat
+            # If it is unspeified, PROTO will be used.
+            MESSAGE_FORMAT_UNSPECIFIED = 0
+
+            # Pubsub message will be serialized proto.
+            PROTO = 1
+
+            # Pubsub message will be json.
+            JSON = 2
+          end
+        end
+
+        # Defines logging behavior for conversation lifecycle events.
+        # @!attribute [rw] enable_stackdriver_logging
+        #   @return [::Boolean]
+        #     Whether to log conversation events like
+        #     {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED} to
+        #     Stackdriver in the conversation project as JSON format
+        #     {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
+        class LoggingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The type of Human Agent Assistant API suggestion to perform, and the maximum
+        # number of results to return for that type. Multiple `Feature` objects can
+        # be specified in the `features` list.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature::Type]
+        #     Type of Human Agent Assistant API feature to request.
+        class SuggestionFeature
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines the type of Human Agent Assistant feature.
+          module Type
+            # Unspecified feature type.
+            TYPE_UNSPECIFIED = 0
+
+            # Run article suggestion model.
+            ARTICLE_SUGGESTION = 1
+
+            # Run FAQ model.
+            FAQ = 2
+          end
+        end
+      end
+    end
+  end
+end