google-cloud-dialogflow-v2 1.6.0 → 1.8.0

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

@@ -67,10 +67,57 @@ module Google
         #     {::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}.
+        # @!attribute [r] telephony_connection_info
+        #   @return [::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo]
+        #     Output only. The telephony connection information.
         class Conversation
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # The information about phone calls connected via phone gateway to the
+          # conversation.
+          # @!attribute [r] dialed_number
+          #   @return [::String]
+          #     Output only. The number dialed to connect this call in E.164 format.
+          # @!attribute [rw] sdp
+          #   @return [::String]
+          #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
+          #     but maybe later updated for the purpose of making the link active, etc.
+          # @!attribute [r] sip_headers
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
+          #     Output only. The SIP headers from the initial SIP INVITE.
+          # @!attribute [r] extra_mime_contents
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
+          #     Output only. The mime content from the initial SIP INVITE.
+          class TelephonyConnectionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The SIP headers from the initial SIP INVITE.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     Optional. The name of the header.
+            # @!attribute [rw] value
+            #   @return [::String]
+            #     Optional. The value of the header.
+            class SipHeader
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The mime content from the initial SIP INVITE.
+            # @!attribute [rw] mime_type
+            #   @return [::String]
+            #     Optional. The mime type of the content.
+            # @!attribute [rw] content
+            #   @return [::String]
+            #     Optional. The content payload.
+            class MimeContent
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Enumeration of the completion status of the conversation.
           module LifecycleState
             # Unknown.
@@ -85,7 +132,7 @@ module Google
 
           # Enumeration of the different conversation stages a conversation can be in.
           # Reference:
-          # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
+          # https://cloud.google.com/agent-assist/docs/basics#conversation_stages
           module ConversationStage
             # Unknown. Should never be used after a conversation is successfully
             # created.
@@ -241,6 +288,9 @@ module Google
 
         # Represents a phone number for telephony integration. It allows for connecting
         # a particular conversation over telephony.
+        # @!attribute [r] country_code
+        #   @return [::Integer]
+        #     Output only. Desired country code for the phone number.
         # @!attribute [r] phone_number
         #   @return [::String]
         #     Output only. The phone number to connect to this conversation.
@@ -439,10 +489,14 @@ module Google
         #   @return [::Google::Cloud::Dialogflow::V2::Generator]
         #     Uncreated generator. It should be a complete generator that includes all
         #     information about the generator.
+        #
+        #     Note: The following fields are mutually exclusive: `generator`, `generator_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] generator_name
         #   @return [::String]
         #     The resource name of the existing created generator. Format:
         #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
+        #
+        #     Note: The following fields are mutually exclusive: `generator_name`, `generator`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] conversation_context
         #   @return [::Google::Cloud::Dialogflow::V2::ConversationContext]
         #     Optional. Context of the conversation, including transcripts.
@@ -536,9 +590,18 @@ module Google
           # @!attribute [rw] boost_specs
           #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
           #     Optional. Boost specifications for data stores.
+          #
+          #     Maps from datastore name to their boost configuration. Do not specify
+          #     more than one BoostSpecs for each datastore name. If multiple BoostSpecs
+          #     are provided for the same datastore name, the behavior is undefined.
           # @!attribute [rw] filter_specs
           #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
           #     Optional. Filter specification for data store queries.
+          #
+          #     TMaps from datastore name to the filter expression for that datastore. Do
+          #     not specify more than one FilterSpecs for each datastore name. If
+          #     multiple FilterSpecs are provided for the same datastore name, the
+          #     behavior is undefined.
           class SearchConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -564,7 +627,7 @@ module Google
               # @!attribute [rw] condition_boost_specs
               #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
               #     Optional. Condition boost specifications. If a document matches
-              #     multiple conditions in the specifictions, boost scores from these
+              #     multiple conditions in the specifications, boost scores from these
               #     specifications are all applied and combined in a non-linear way.
               #     Maximum number of specifications is 20.
               class BoostSpec
@@ -642,6 +705,18 @@ module Google
                     # The control points used to define the curve. The curve defined
                     # through these control points can only be monotonically increasing
                     # or decreasing(constant values are acceptable).
+                    # @!attribute [rw] attribute_value
+                    #   @return [::String]
+                    #     Optional. Can be one of:
+                    #     1. The numerical field value.
+                    #     2. The duration spec for freshness:
+                    #     The value must be formatted as an XSD `dayTimeDuration` value
+                    #     (a restricted subset of an ISO 8601 duration value). The
+                    #     pattern for this is: `[nD][T[nH][nM][nS]]`.
+                    # @!attribute [rw] boost_amount
+                    #   @return [::Float]
+                    #     Optional. The value between -1 to 1 by which to boost the score
+                    #     if the attribute_value evaluates to the value specified above.
                     class ControlPoint
                       include ::Google::Protobuf::MessageExts
                       extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -38,9 +38,13 @@ module Google
         # @!attribute [rw] new_message_payload
         #   @return [::Google::Cloud::Dialogflow::V2::Message]
         #     Payload of NEW_MESSAGE event.
+        #
+        #     Note: The following fields are mutually exclusive: `new_message_payload`, `new_recognition_result_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] new_recognition_result_payload
         #   @return [::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult]
         #     Payload of NEW_RECOGNITION_RESULT event.
+        #
+        #     Note: The following fields are mutually exclusive: `new_recognition_result_payload`, `new_message_payload`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class ConversationEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -49,9 +49,13 @@ module Google
         # @!attribute [rw] article_suggestion_model_metadata
         #   @return [::Google::Cloud::Dialogflow::V2::ArticleSuggestionModelMetadata]
         #     Metadata for article suggestion models.
+        #
+        #     Note: The following fields are mutually exclusive: `article_suggestion_model_metadata`, `smart_reply_model_metadata`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] smart_reply_model_metadata
         #   @return [::Google::Cloud::Dialogflow::V2::SmartReplyModelMetadata]
         #     Metadata for smart reply models.
+        #
+        #     Note: The following fields are mutually exclusive: `smart_reply_model_metadata`, `article_suggestion_model_metadata`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] satisfies_pzs
         #   @return [::Boolean]
         #     Output only. A read only boolean field reflecting Zone Separation
@@ -130,7 +134,7 @@ module Google
         # @!attribute [r] raw_human_eval_template_csv
         #   @return [::String]
         #     Output only. Human eval template in csv format.
-        #     It tooks real-world conversations provided through input dataset, generates
+        #     It takes real-world conversations provided through input dataset, generates
         #     example suggestions for customer to verify quality of the model.
         #     For Smart Reply, the generated csv file contains columns of
         #     Context, (Suggestions,Q1,Q2)*3, Actual reply.
@@ -155,10 +159,14 @@ module Google
         #     Required. Datasets used for evaluation.
         # @!attribute [rw] smart_reply_config
         #   @return [::Google::Cloud::Dialogflow::V2::EvaluationConfig::SmartReplyConfig]
-        #     Configuration for smart reply model evalution.
+        #     Configuration for smart reply model evaluation.
+        #
+        #     Note: The following fields are mutually exclusive: `smart_reply_config`, `smart_compose_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] smart_compose_config
         #   @return [::Google::Cloud::Dialogflow::V2::EvaluationConfig::SmartComposeConfig]
-        #     Configuration for smart compose model evalution.
+        #     Configuration for smart compose model evaluation.
+        #
+        #     Note: The following fields are mutually exclusive: `smart_compose_config`, `smart_reply_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class EvaluationConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -340,13 +340,19 @@ module Google
           #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::KnowledgeBaseQuerySource]
           #     Query from knowledgebase. It is used by:
           #     ARTICLE_SUGGESTION, FAQ.
+          #
+          #     Note: The following fields are mutually exclusive: `knowledge_base_query_source`, `document_query_source`, `dialogflow_query_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!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.
+          #
+          #     Note: The following fields are mutually exclusive: `document_query_source`, `knowledge_base_query_source`, `dialogflow_query_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] dialogflow_query_source
           #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::DialogflowQuerySource]
           #     Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST.
+          #
+          #     Note: The following fields are mutually exclusive: `dialogflow_query_source`, `knowledge_base_query_source`, `document_query_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] max_results
           #   @return [::Integer]
           #     Maximum number of results to return. Currently, if unset, defaults to 10.
@@ -593,9 +599,13 @@ module Google
         # @!attribute [rw] live_person_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::LivePersonConfig]
         #     Uses [LivePerson](https://www.liveperson.com).
+        #
+        #     Note: The following fields are mutually exclusive: `live_person_config`, `salesforce_live_agent_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] salesforce_live_agent_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::SalesforceLiveAgentConfig]
         #     Uses Salesforce Live Agent.
+        #
+        #     Note: The following fields are mutually exclusive: `salesforce_live_agent_config`, `live_person_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class HumanAgentHandoffConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -707,6 +717,9 @@ module Google
             # Run smart reply model for chat.
             SMART_REPLY = 3
 
+            # Run conversation summarization model for chat.
+            CONVERSATION_SUMMARIZATION = 8
+
             # Run knowledge search with text input from agent or text generated query.
             KNOWLEDGE_SEARCH = 14
 

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

@@ -56,10 +56,14 @@ module Google
         #     be indexed by Google Search. In particular, URLs for showing documents in
         #     Google Cloud Storage (i.e. the URL in your browser) are not supported.
         #     Instead use the `gs://` format URI described above.
+        #
+        #     Note: The following fields are mutually exclusive: `content_uri`, `raw_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] raw_content
         #   @return [::String]
         #     The raw content of the document. This field is only permitted for
         #     EXTRACTIVE_QA and FAQ knowledge types.
+        #
+        #     Note: The following fields are mutually exclusive: `raw_content`, `content_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] enable_auto_reload
         #   @return [::Boolean]
         #     Optional. If true, we try to automatically reload the document every day

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

@@ -245,9 +245,13 @@ module Google
         #     or create. The file format can either be a serialized proto (of
         #     EntityBatch type) or a JSON object. Note: The URI must start with
         #     "gs://".
+        #
+        #     Note: The following fields are mutually exclusive: `entity_type_batch_uri`, `entity_type_batch_inline`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] entity_type_batch_inline
         #   @return [::Google::Cloud::Dialogflow::V2::EntityTypeBatch]
         #     The collection of entity types to update or create.
+        #
+        #     Note: The following fields are mutually exclusive: `entity_type_batch_inline`, `entity_type_batch_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] language_code
         #   @return [::String]
         #     Optional. The language used to access language-specific data.

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

@@ -277,45 +277,73 @@ module Google
           # @!attribute [rw] text
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Text]
           #     The text response.
+          #
+          #     Note: The following fields are mutually exclusive: `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] image
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Image]
           #     The image response.
+          #
+          #     Note: The following fields are mutually exclusive: `image`, `text`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] quick_replies
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::QuickReplies]
           #     The quick replies response.
+          #
+          #     Note: The following fields are mutually exclusive: `quick_replies`, `text`, `image`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] card
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Card]
           #     The card response.
+          #
+          #     Note: The following fields are mutually exclusive: `card`, `text`, `image`, `quick_replies`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] payload
           #   @return [::Google::Protobuf::Struct]
           #     A custom platform-specific response.
+          #
+          #     Note: The following fields are mutually exclusive: `payload`, `text`, `image`, `quick_replies`, `card`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] simple_responses
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::SimpleResponses]
           #     The voice and text-only responses for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `simple_responses`, `text`, `image`, `quick_replies`, `card`, `payload`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] basic_card
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::BasicCard]
           #     The basic card response for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `basic_card`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] suggestions
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Suggestions]
           #     The suggestion chips for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `suggestions`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] link_out_suggestion
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::LinkOutSuggestion]
           #     The link out suggestion chip for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `link_out_suggestion`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] list_select
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::ListSelect]
           #     The list card response for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `list_select`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `carousel_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] carousel_select
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::CarouselSelect]
           #     The carousel card response for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `carousel_select`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `browse_carousel_card`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] browse_carousel_card
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard]
           #     Browse carousel card for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `browse_carousel_card`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `table_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] table_card
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::TableCard]
           #     Table card for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `table_card`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `media_content`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] media_content
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::MediaContent]
           #     The media content card for Actions on Google.
+          #
+          #     Note: The following fields are mutually exclusive: `media_content`, `text`, `image`, `quick_replies`, `card`, `payload`, `simple_responses`, `basic_card`, `suggestions`, `link_out_suggestion`, `list_select`, `carousel_select`, `browse_carousel_card`, `table_card`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] platform
           #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Platform]
           #     Optional. The platform that this message is intended for.
@@ -589,9 +617,13 @@ module Google
               # @!attribute [rw] large_image
               #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Image]
               #     Optional. Image to display above media content.
+              #
+              #     Note: The following fields are mutually exclusive: `large_image`, `icon`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] icon
               #   @return [::Google::Cloud::Dialogflow::V2::Intent::Message::Image]
               #     Optional. Icon to display above media content.
+              #
+              #     Note: The following fields are mutually exclusive: `icon`, `large_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] content_url
               #   @return [::String]
               #     Required. Url where the media is stored.
@@ -982,9 +1014,13 @@ module Google
         #     The URI to a Google Cloud Storage file containing intents to update or
         #     create. The file format can either be a serialized proto (of IntentBatch
         #     type) or JSON object. Note: The URI must start with "gs://".
+        #
+        #     Note: The following fields are mutually exclusive: `intent_batch_uri`, `intent_batch_inline`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] intent_batch_inline
         #   @return [::Google::Cloud::Dialogflow::V2::IntentBatch]
         #     The collection of intents to update or create.
+        #
+        #     Note: The following fields are mutually exclusive: `intent_batch_inline`, `intent_batch_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] language_code
         #   @return [::String]
         #     Optional. The language used to access language-specific data.

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

@@ -145,7 +145,8 @@ module Google
         #     Output only. The time when the message was created in Contact Center AI.
         # @!attribute [rw] send_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Optional. The time when the message was sent.
+        #     Optional. The time when the message was sent. For voice messages, this is
+        #     the time when an utterance started.
         # @!attribute [r] message_annotation
         #   @return [::Google::Cloud::Dialogflow::V2::MessageAnnotation]
         #     Output only. The annotation for the message.
@@ -241,12 +242,23 @@ module Google
         # @!attribute [rw] text_input
         #   @return [::Google::Cloud::Dialogflow::V2::TextInput]
         #     The natural language text to be processed.
+        #
+        #     Note: The following fields are mutually exclusive: `text_input`, `audio_input`, `event_input`, `suggestion_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] audio_input
+        #   @return [::Google::Cloud::Dialogflow::V2::AudioInput]
+        #     The natural language speech audio to be processed.
+        #
+        #     Note: The following fields are mutually exclusive: `audio_input`, `text_input`, `event_input`, `suggestion_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] event_input
         #   @return [::Google::Cloud::Dialogflow::V2::EventInput]
         #     An input event to send to Dialogflow.
+        #
+        #     Note: The following fields are mutually exclusive: `event_input`, `text_input`, `audio_input`, `suggestion_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] suggestion_input
         #   @return [::Google::Cloud::Dialogflow::V2::SuggestionInput]
         #     An input representing the selection of a suggestion.
+        #
+        #     Note: The following fields are mutually exclusive: `suggestion_input`, `text_input`, `audio_input`, `event_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] reply_audio_config
         #   @return [::Google::Cloud::Dialogflow::V2::OutputAudioConfig]
         #     Speech synthesis configuration.
@@ -396,9 +408,13 @@ module Google
         # @!attribute [rw] audio_config
         #   @return [::Google::Cloud::Dialogflow::V2::InputAudioConfig]
         #     Instructs the speech recognizer how to process the speech audio.
+        #
+        #     Note: The following fields are mutually exclusive: `audio_config`, `text_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] text_config
         #   @return [::Google::Cloud::Dialogflow::V2::InputTextConfig]
         #     The natural language text to be processed.
+        #
+        #     Note: The following fields are mutually exclusive: `text_config`, `audio_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] reply_audio_config
         #   @return [::Google::Cloud::Dialogflow::V2::OutputAudioConfig]
         #     Speech synthesis configuration.
@@ -411,18 +427,24 @@ module Google
         #     The input audio content to be recognized. Must be sent if `audio_config`
         #     is set in the first message. The complete audio over all streaming
         #     messages must not exceed 1 minute.
+        #
+        #     Note: The following fields are mutually exclusive: `input_audio`, `input_text`, `input_dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] input_text
         #   @return [::String]
         #     The UTF-8 encoded natural language text to be processed. Must be sent if
         #     `text_config` is set in the first message. Text length must not exceed
         #     256 bytes for virtual agent interactions. The `input_text` field can be
         #     only sent once, and would cancel the speech recognition if any ongoing.
+        #
+        #     Note: The following fields are mutually exclusive: `input_text`, `input_audio`, `input_dtmf`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] input_dtmf
         #   @return [::Google::Cloud::Dialogflow::V2::TelephonyDtmfEvents]
         #     The DTMF digits used to invoke intent and fill in parameter value.
         #
         #     This input is ignored if the previous response indicated that DTMF input
         #     is not accepted.
+        #
+        #     Note: The following fields are mutually exclusive: `input_dtmf`, `input_audio`, `input_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] query_params
         #   @return [::Google::Cloud::Dialogflow::V2::QueryParameters]
         #     Parameters for a Dialogflow virtual-agent query.
@@ -461,10 +483,10 @@ module Google
         #     https://cloud.google.com/agent-assist/docs/extended-streaming
         # @!attribute [rw] enable_partial_automated_agent_reply
         #   @return [::Boolean]
-        #     Enable partial virtual agent responses. If this flag is not enabled,
-        #     response stream still contains only one final response even if some
-        #     `Fulfillment`s in Dialogflow virtual agent have been configured to return
-        #     partial responses.
+        #     Optional. Enable partial responses from Dialogflow CX agent. If this flag
+        #     is not enabled, response stream still contains only one final response even
+        #     if some `Fulfillment`s in Dialogflow CX agent have been configured to
+        #     return partial responses.
         # @!attribute [rw] enable_debugging_info
         #   @return [::Boolean]
         #     If true, `StreamingAnalyzeContentResponse.debugging_info` will get
@@ -546,6 +568,9 @@ module Google
         #   @return [::Google::Cloud::Dialogflow::V2::CloudConversationDebuggingInfo]
         #     Debugging info that would get populated when
         #     `StreamingAnalyzeContentRequest.enable_debugging_info` is set to true.
+        # @!attribute [rw] speech_model
+        #   @return [::String]
+        #     The name of the actual Cloud speech model used for speech recognition.
         class StreamingAnalyzeContentResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -712,6 +737,21 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Represents the natural language speech audio to be processed.
+        # @!attribute [rw] config
+        #   @return [::Google::Cloud::Dialogflow::V2::InputAudioConfig]
+        #     Required. Instructs the speech recognizer how to process the speech audio.
+        # @!attribute [rw] audio
+        #   @return [::String]
+        #     Required. The natural language speech audio to be processed.
+        #     A single request can contain up to 2 minutes of speech audio data.
+        #     The transcribed text cannot contain more than 256 bytes for virtual agent
+        #     interactions.
+        class AudioInput
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Represents the natural language speech audio to be played to the end user.
         # @!attribute [rw] config
         #   @return [::Google::Cloud::Dialogflow::V2::OutputAudioConfig]
@@ -885,9 +925,13 @@ module Google
         # @!attribute [rw] query_result
         #   @return [::Google::Cloud::Dialogflow::V2::QueryResult]
         #     Result from v2 agent.
+        #
+        #     Note: The following fields are mutually exclusive: `query_result`, `intent_suggestion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] intent_suggestion
         #   @return [::Google::Cloud::Dialogflow::V2::IntentSuggestion]
         #     An intent suggestion generated from conversation.
+        #
+        #     Note: The following fields are mutually exclusive: `intent_suggestion`, `query_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] answer_record
         #   @return [::String]
         #     The name of answer record, in the format of
@@ -908,18 +952,28 @@ module Google
         # @!attribute [rw] error
         #   @return [::Google::Rpc::Status]
         #     Error status if the request failed.
+        #
+        #     Note: The following fields are mutually exclusive: `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] suggest_articles_response
         #   @return [::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse]
         #     SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.
+        #
+        #     Note: The following fields are mutually exclusive: `suggest_articles_response`, `error`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] suggest_knowledge_assist_response
         #   @return [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
         #     SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST.
+        #
+        #     Note: The following fields are mutually exclusive: `suggest_knowledge_assist_response`, `error`, `suggest_articles_response`, `suggest_faq_answers_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] suggest_faq_answers_response
         #   @return [::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse]
         #     SuggestFaqAnswersResponse if request is for FAQ_ANSWER.
+        #
+        #     Note: The following fields are mutually exclusive: `suggest_faq_answers_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_smart_replies_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] suggest_smart_replies_response
         #   @return [::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse]
         #     SuggestSmartRepliesResponse if request is for SMART_REPLY.
+        #
+        #     Note: The following fields are mutually exclusive: `suggest_smart_replies_response`, `error`, `suggest_articles_response`, `suggest_knowledge_assist_response`, `suggest_faq_answers_response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class SuggestionResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1049,7 +1103,7 @@ module Google
         # @!attribute [rw] previous_suggested_query
         #   @return [::String]
         #     Optional. The previously suggested query for the given conversation. This
-        #     helps identify whether the next suggestion we generate is resonably
+        #     helps identify whether the next suggestion we generate is reasonably
         #     different from the previous one. This is useful to avoid similar
         #     suggestions within the conversation.
         class SuggestKnowledgeAssistRequest
@@ -1114,9 +1168,13 @@ module Google
           # @!attribute [rw] faq_source
           #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::FaqSource]
           #     Populated if the prediction came from FAQ.
+          #
+          #     Note: The following fields are mutually exclusive: `faq_source`, `generative_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] generative_source
           #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
           #     Populated if the prediction was Generative.
+          #
+          #     Note: The following fields are mutually exclusive: `generative_source`, `faq_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class KnowledgeAnswer
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -188,13 +188,19 @@ module Google
         # @!attribute [rw] audio_config
         #   @return [::Google::Cloud::Dialogflow::V2::InputAudioConfig]
         #     Instructs the speech recognizer how to process the speech audio.
+        #
+        #     Note: The following fields are mutually exclusive: `audio_config`, `text`, `event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] text
         #   @return [::Google::Cloud::Dialogflow::V2::TextInput]
         #     The natural language text to be processed. Text length must not exceed
         #     256 character for virtual agent interactions.
+        #
+        #     Note: The following fields are mutually exclusive: `text`, `audio_config`, `event`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] event
         #   @return [::Google::Cloud::Dialogflow::V2::EventInput]
         #     The event to be processed.
+        #
+        #     Note: The following fields are mutually exclusive: `event`, `audio_config`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class QueryInput
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/longrunning/operations.rb

@@ -40,6 +40,8 @@ module Google
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
     #     The error result of the operation in case of failure or cancellation.
+    #
+    #     Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] response
     #   @return [::Google::Protobuf::Any]
     #     The normal, successful response of the operation.  If the original
@@ -50,6 +52,8 @@ module Google
     #     is the original method name.  For example, if the original method name
     #     is `TakeSnapshot()`, the inferred response type is
     #     `TakeSnapshotResponse`.
+    #
+    #     Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     class Operation
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/struct.rb

@@ -53,21 +53,33 @@ module Google
     # @!attribute [rw] null_value
     #   @return [::Google::Protobuf::NullValue]
     #     Represents a null value.
+    #
+    #     Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] number_value
     #   @return [::Float]
     #     Represents a double value.
+    #
+    #     Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] string_value
     #   @return [::String]
     #     Represents a string value.
+    #
+    #     Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] bool_value
     #   @return [::Boolean]
     #     Represents a boolean value.
+    #
+    #     Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] struct_value
     #   @return [::Google::Protobuf::Struct]
     #     Represents a structured value.
+    #
+    #     Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] list_value
     #   @return [::Google::Protobuf::ListValue]
     #     Represents a repeated `Value`.
+    #
+    #     Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     class Value
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods