google-cloud-discovery_engine-v1 0.6.0 → 0.8.0

data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb

@@ -48,10 +48,14 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to
-        #     return. If unspecified, defaults to a reasonable value. The maximum allowed
-        #     value is 100. Values above 100 are coerced to 100.
+        #     return. The maximum allowed value depends on the data type. Values above
+        #     the maximum value are coerced to the maximum value.
         #
-        #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        #     * Websites with basic indexing: Default `10`, Maximum `25`.
+        #     * Websites with advanced indexing: Default `25`, Maximum `50`.
+        #     * Other: Default `50`, Maximum `100`.
+        #
+        #     If this field is negative, an  `INVALID_ARGUMENT` is returned.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token received from a previous
@@ -72,6 +76,12 @@ module Google
         #     unset.
         #
         #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        # @!attribute [rw] data_store_specs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>]
+        #     Specs defining dataStores to filter on in a search call and configurations
+        #     for those dataStores. This is only considered for engines with multiple
+        #     dataStores use case. For single dataStore within an engine, they should
+        #     use the specs at the top level.
         # @!attribute [rw] filter
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
@@ -108,7 +118,9 @@ module Google
         #     The order in which documents are returned. Documents can be ordered by
         #     a field in an {::Google::Cloud::DiscoveryEngine::V1::Document Document} object.
         #     Leave it unset if ordered by relevance. `order_by` expression is
-        #     case-sensitive. For more information on ordering, see
+        #     case-sensitive.
+        #
+        #     For more information on ordering for retail search, see
         #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
         #
         #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -128,7 +140,7 @@ module Google
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec]
         #     Boost specification to boost certain documents.
         #     For more information on boosting, see
-        #     [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        #     [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
         # @!attribute [rw] params
         #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
         #     Additional search parameters.
@@ -137,8 +149,7 @@ module Google
         #
         #     * `user_country_code`: string. Default empty. If set to non-empty, results
         #        are restricted or boosted based on the location provided.
-        #        Example:
-        #        user_country_code: "au"
+        #        For example, `user_country_code: "au"`
         #
         #        For available codes see [Country
         #        Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -146,8 +157,7 @@ module Google
         #     * `search_type`: double. Default empty. Enables non-webpage searching
         #        depending on the value. The only valid non-default value is 1,
         #        which enables image searching.
-        #        Example:
-        #        search_type: 1
+        #        For example, `search_type: 1`
         # @!attribute [rw] query_expansion_spec
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
@@ -212,13 +222,26 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # A struct to define data stores to filter on in a search call and
+          # configurations for those data stores. A maximum of 1 DataStoreSpec per
+          # data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Full resource name of
+          #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, such as
+          #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+          class DataStoreSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # A facet specification to perform faceted search.
           # @!attribute [rw] facet_key
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey]
           #     Required. The facet key specification.
           # @!attribute [rw] limit
           #   @return [::Integer]
-          #     Maximum of facet values that should be returned for this facet. If
+          #     Maximum facet values that are returned for this facet. If
           #     unspecified, defaults to 20. The maximum allowed value is 300. Values
           #     above 300 are coerced to 300.
           #
@@ -315,7 +338,7 @@ module Google
             #     Only supported on textual fields. Maximum is 10.
             # @!attribute [rw] contains
             #   @return [::Array<::String>]
-            #     Only get facet values that contains the given strings. For example,
+            #     Only get facet values that contain the given strings. For example,
             #     suppose "category" has three values "Action > 2022",
             #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
             #     "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
@@ -371,28 +394,29 @@ module Google
             #     Examples:
             #
             #     * To boost documents with document ID "doc_1" or "doc_2", and
-            #     color
-            #       "Red" or "Blue":
-            #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+            #     color "Red" or "Blue":
+            #     `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
             # @!attribute [rw] boost
             #   @return [::Float]
             #     Strength of the condition boost, which should be in [-1, 1]. Negative
             #     boost means demotion. Default is 0.0.
             #
-            #     Setting to 1.0 gives the document a big promotion. However, it does not
-            #     necessarily mean that the boosted document will be the top result at
-            #     all times, nor that other documents will be excluded. Results could
-            #     still be shown even when none of them matches the condition. And
-            #     results that are significantly more relevant to the search query can
-            #     still trump your heavily favored but irrelevant documents.
+            #     Setting to 1.0 gives the document a big promotion. However, it does
+            #     not necessarily mean that the boosted document will be the top result
+            #     at all times, nor that other documents will be excluded. Results
+            #     could still be shown even when none of them matches the condition.
+            #     And results that are significantly more relevant to the search query
+            #     can still trump your heavily favored but irrelevant documents.
             #
             #     Setting to -1.0 gives the document a big demotion. However, results
             #     that are deeply relevant might still be shown. The document will have
-            #     an upstream battle to get a fairly high ranking, but it is not blocked
-            #     out completely.
+            #     an upstream battle to get a fairly high ranking, but it is not
+            #     blocked out completely.
             #
             #     Setting to 0.0 means no boost applied. The boosting condition is
-            #     ignored.
+            #     ignored. Only one of the (condition, boost) combination or the
+            #     boost_control_spec below are set. If both are set then the global boost
+            #     is ignored and the more fine-grained boost_control_spec is applied.
             class ConditionBoostSpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -434,8 +458,8 @@ module Google
           # The specification for query spell correction.
           # @!attribute [rw] mode
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec::Mode]
-          #     The mode under which spell correction should take effect to
-          #     replace the original search query. Default to
+          #     The mode under which spell correction
+          #     replaces the original search query. Defaults to
           #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
           class SpellCorrectionSpec
             include ::Google::Protobuf::MessageExts
@@ -448,10 +472,10 @@ module Google
               # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
               MODE_UNSPECIFIED = 0
 
-              # Search API will try to find a spell suggestion if there
-              # is any and put in the
+              # Search API tries to find a spelling suggestion. If a suggestion is
+              # found, it is put in the
               # {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#corrected_query SearchResponse.corrected_query}.
-              # The spell suggestion will not be used as the search query.
+              # The spelling suggestion won't be used as the search query.
               SUGGESTION_ONLY = 1
 
               # Automatic spell correction built by the Search API. Search will
@@ -469,6 +493,10 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec]
           #     If `summarySpec` is not specified, summaries are not included in the
           #     search response.
+          # @!attribute [rw] extractive_content_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec]
+          #     If there is no extractive_content_spec provided, there will be no
+          #     extractive answer in the search response.
           class ContentSearchSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -503,7 +531,10 @@ module Google
             #     of results returned is less than `summaryResultCount`, the summary is
             #     generated from all of the results.
             #
-            #     At most five results can be used to generate a summary.
+            #     At most 10 results for documents mode, or 50 for chunks mode, can be
+            #     used to generate a summary. The chunks mode is used when
+            #     [SearchRequest.ContentSearchSpec.search_result_mode][] is set to
+            #     [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
             # @!attribute [rw] include_citations
             #   @return [::Boolean]
             #     Specifies whether to include citations in the summary. The default
@@ -561,6 +592,14 @@ module Google
             #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
             #     If specified, the spec will be used to modify the model specification
             #     provided to the LLM.
+            # @!attribute [rw] use_semantic_chunks
+            #   @return [::Boolean]
+            #     If true, answer will be generated from most relevant chunks from top
+            #     search results. This feature will improve summary quality.
+            #     Note that with this feature enabled, not all top search results
+            #     will be referenced and included in the reference list, so the citation
+            #     source index only points to the search results listed in the reference
+            #     list.
             class SummarySpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -583,16 +622,75 @@ module Google
               #     Supported values are:
               #
               #     * `stable`: string. Default value when no value is specified. Uses a
-              #       generally available, fine-tuned version of the text-bison@001
-              #       model.
-              #     * `preview`: string. (Public preview) Uses a fine-tuned version of
-              #       the text-bison@002 model. This model works only for summaries in
-              #       English.
+              #        generally available, fine-tuned model. For more information, see
+              #        [Answer generation model versions and
+              #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              #     * `preview`: string. (Public preview) Uses a preview model. For more
+              #        information, see
+              #        [Answer generation model versions and
+              #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
               class ModelSpec
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
             end
+
+            # A specification for configuring the extractive content in a search
+            # response.
+            # @!attribute [rw] max_extractive_answer_count
+            #   @return [::Integer]
+            #     The maximum number of extractive answers returned in each search
+            #     result.
+            #
+            #     An extractive answer is a verbatim answer extracted from the original
+            #     document, which provides a precise and contextually relevant answer to
+            #     the search query.
+            #
+            #     If the number of matching answers is less than the
+            #     `max_extractive_answer_count`, return all of the answers. Otherwise,
+            #     return the `max_extractive_answer_count`.
+            #
+            #     At most five answers are returned for each
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult SearchResult}.
+            # @!attribute [rw] max_extractive_segment_count
+            #   @return [::Integer]
+            #     The max number of extractive segments returned in each search result.
+            #     Only applied if the
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
+            #     or
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
+            #     is
+            #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
+            #
+            #     An extractive segment is a text segment extracted from the original
+            #     document that is relevant to the search query, and, in general, more
+            #     verbose than an extractive answer. The segment could then be used as
+            #     input for LLMs to generate summaries and answers.
+            #
+            #     If the number of matching segments is less than
+            #     `max_extractive_segment_count`, return all of the segments. Otherwise,
+            #     return the `max_extractive_segment_count`.
+            # @!attribute [rw] return_extractive_segment_score
+            #   @return [::Boolean]
+            #     Specifies whether to return the confidence score from the extractive
+            #     segments in each search result. This feature is available only for new
+            #     or allowlisted data stores. To allowlist your data store,
+            #     contact your Customer Engineer. The default value is `false`.
+            # @!attribute [rw] num_previous_segments
+            #   @return [::Integer]
+            #     Specifies whether to also include the adjacent from each selected
+            #     segments.
+            #     Return at most `num_previous_segments` segments before each selected
+            #     segments.
+            # @!attribute [rw] num_next_segments
+            #   @return [::Integer]
+            #     Return at most `num_next_segments` segments after each selected
+            #     segments.
+            class ExtractiveContentSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # @!attribute [rw] key
@@ -676,7 +774,7 @@ module Google
           # @!attribute [rw] document
           #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
           #     The document data snippet in the search response. Only fields that are
-          #     marked as retrievable are populated.
+          #     marked as `retrievable` are populated.
           class SearchResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -685,7 +783,7 @@ module Google
           # A facet result.
           # @!attribute [rw] key
           #   @return [::String]
-          #     The key for this facet. E.g., "colors" or "price". It matches
+          #     The key for this facet. For example, `"colors"` or `"price"`. It matches
           #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
           # @!attribute [rw] values
           #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue>]
@@ -715,7 +813,7 @@ module Google
             end
           end
 
-          # Summary of the top N search result specified by the summary spec.
+          # Summary of the top N search results specified by the summary spec.
           # @!attribute [rw] summary_text
           #   @return [::String]
           #     The summary content.
@@ -796,9 +894,24 @@ module Google
             # @!attribute [rw] uri
             #   @return [::String]
             #     Cloud Storage or HTTP uri for the document.
+            # @!attribute [rw] chunk_contents
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::Reference::ChunkContent>]
+            #     List of cited chunk contents derived from document content.
             class Reference
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Chunk content.
+              # @!attribute [rw] content
+              #   @return [::String]
+              #     Chunk textual content.
+              # @!attribute [rw] page_identifier
+              #   @return [::String]
+              #     Page identifier.
+              class ChunkContent
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
             end
 
             # Summary with metadata information.

data/proto_docs/google/cloud/discoveryengine/v1/session.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 DiscoveryEngine
+      module V1
+        # External session proto definition.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Session::State]
+        #     The state of the session.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking users.
+        # @!attribute [rw] turns
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>]
+        #     Turns.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session finished.
+        class Session
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents a turn, including a query from the user and a
+          # answer from service.
+          # @!attribute [rw] query
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
+          #     The user query.
+          # @!attribute [rw] answer
+          #   @return [::String]
+          #     The resource name of the answer to the user query.
+          #
+          #     Only set if the answer generation (/answer API call) happened in this
+          #     turn.
+          class Turn
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Enumeration of the state of the session.
+          module State
+            # State is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The session is currently open.
+            IN_PROGRESS = 1
+          end
+        end
+
+        # Defines a user inputed query.
+        # @!attribute [rw] text
+        #   @return [::String]
+        #     Plain text.
+        # @!attribute [rw] query_id
+        #   @return [::String]
+        #     Unique Id for the query.
+        class Query
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb

@@ -57,6 +57,9 @@ module Google
         # @!attribute [r] generated_uri_pattern
         #   @return [::String]
         #     Output only. This is system-generated based on the provided_uri_pattern.
+        # @!attribute [r] root_domain_uri
+        #   @return [::String]
+        #     Output only. Root domain of the provided_uri_pattern.
         # @!attribute [r] site_verification_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SiteVerificationInfo]
         #     Output only. Site ownership and validity verification status.

data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb

@@ -22,7 +22,7 @@ module Google
     module DiscoveryEngine
       module V1
         # UserEvent captures all metadata information Discovery Engine API needs to
-        # know about how end users interact with customers' website.
+        # know about how end users interact with your website.
         # @!attribute [rw] event_type
         #   @return [::String]
         #     Required. User event type. Allowed values are:
@@ -63,6 +63,27 @@ module Google
         #     Analytics [Client
         #     ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
         #     for this field.
+        # @!attribute [rw] engine
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} resource name, in the
+        #     form of
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+        #
+        #     Optional. Only required for
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} produced user events. For
+        #     example, user events from blended search.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} resource full
+        #     name, of the form
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        #
+        #     Optional. Only required for user events whose data store can't by
+        #     determined by
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#engine UserEvent.engine} or
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#documents UserEvent.documents}.
+        #     If data store is set in the parent of write/import/collect user event
+        #     requests, this field can be omitted.
         # @!attribute [rw] event_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Only required for
@@ -105,22 +126,26 @@ module Google
         #     Token to attribute an API response to user action(s) to trigger the event.
         #
         #     Highly recommended for user events that are the result of
-        #     [RecommendationService.Recommend][]. This field enables accurate
-        #     attribution of recommendation model performance.
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client#recommend RecommendationService.Recommend}.
+        #     This field enables accurate attribution of recommendation model
+        #     performance.
         #
         #     The value must be one of:
         #
-        #     * [RecommendResponse.attribution_token][] for events that are the result of
-        #     [RecommendationService.Recommend][].
+        #     * {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse#attribution_token RecommendResponse.attribution_token} for events that are the result of
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client#recommend RecommendationService.Recommend}.
         #     * {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#attribution_token SearchResponse.attribution_token} for events that are the result of
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}.
         #
         #     This token enables us to accurately attribute page view or conversion
         #     completion back to the event and the particular predict response containing
         #     this clicked/purchased product. If user clicks on product K in the
-        #     recommendation results, pass [RecommendResponse.attribution_token][] as a
-        #     URL parameter to product K's page. When recording events on product K's
-        #     page, log the [RecommendResponse.attribution_token][] to this field.
+        #     recommendation results, pass
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse#attribution_token RecommendResponse.attribution_token}
+        #     as a URL parameter to product K's page. When recording events on product
+        #     K's page, log the
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse#attribution_token RecommendResponse.attribution_token}
+        #     to this field.
         # @!attribute [rw] filter
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
@@ -133,9 +158,10 @@ module Google
         #     conforming to https://google.aip.dev/160#filtering.
         #
         #     Similarly, for `view-item-list` events that are generated from a
-        #     [RecommendRequest][], this field may be populated directly from
-        #     [RecommendRequest.filter][] conforming to
-        #     https://google.aip.dev/160#filtering.
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest RecommendRequest}, this
+        #     field may be populated directly from
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#filter RecommendRequest.filter}
+        #     conforming to https://google.aip.dev/160#filtering.
         #
         #     The value must be a UTF-8 encoded string with a length limit of 1,000
         #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -182,7 +208,7 @@ module Google
         #   @return [::Array<::String>]
         #     A list of identifiers for the independent experiment groups this user event
         #     belongs to. This is used to distinguish between user events associated with
-        #     different experiment setups on the customer end.
+        #     different experiment setups.
         # @!attribute [rw] promotion_ids
         #   @return [::Array<::String>]
         #     The promotion IDs if this is an event associated with promotions.
@@ -250,7 +276,7 @@ module Google
         #     The most specific category associated with a category page.
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     Category pages include special pages such as sales or promotions. For
@@ -410,7 +436,7 @@ module Google
         #   @return [::Integer]
         #     Quantity of the Document associated with the user event. Defaults to 1.
         #
-        #     For example, this field will be 2 if two quantities of the same Document
+        #     For example, this field is 2 if two quantities of the same Document
         #     are involved in a `add-to-cart` event.
         #
         #     Required for events of the following event types:

data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb

@@ -24,11 +24,23 @@ module Google
         # Request message for WriteUserEvent method.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent DataStore resource name, such as
+        #     Required. The parent resource name.
+        #     If the write user event action is applied in
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} level, the format
+        #     is:
         #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+        #     If the write user event action is applied in [Location][] level, for
+        #     example, the event with
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} across multiple
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}, the format is:
+        #     `projects/{project}/locations/{location}`.
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::DiscoveryEngine::V1::UserEvent]
         #     Required. User event to write.
+        # @!attribute [rw] write_async
+        #   @return [::Boolean]
+        #     If set to true, the user event is written asynchronously after
+        #     validation, and the API responds without waiting for the write.
         class WriteUserEventRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods