google-cloud-discovery_engine-v1 0.7.0 → 0.9.0

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

@@ -78,7 +78,10 @@ module Google
         #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         # @!attribute [rw] data_store_specs
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>]
-        #     A list of data store specs to apply on a search call.
+        #     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
@@ -115,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.
@@ -125,6 +130,13 @@ module Google
         #     Highly recommended for analytics.
         #     {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
         #     is used to deduce `device_type` for analytics.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+        #     information, see [Standard
+        #     fields](https://cloud.google.com/apis/design/standard_fields). This field
+        #     helps to better interpret the query. If a value isn't specified, the query
+        #     language code is automatically detected, which may not be accurate.
         # @!attribute [rw] facet_specs
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec>]
         #     Facet specifications for faceted search. If empty, no facets are returned.
@@ -135,7 +147,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.
@@ -144,8 +156,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)
@@ -153,8 +164,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
@@ -205,6 +215,44 @@ module Google
         #     See [Google Cloud
         #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         #     for more details.
+        # @!attribute [rw] search_as_you_type_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec]
+        #     Search as you type configuration. Only supported for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
+        #     vertical.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     The session resource name. Optional.
+        #
+        #     Session allows users to do multi-turn /search API calls or coordination
+        #     between /search API calls and /answer API calls.
+        #
+        #     Example #1 (multi-turn /search API calls):
+        #       1. Call /search API with the auto-session mode (see below).
+        #       2. Call /search API with the session ID generated in the first call.
+        #          Here, the previous search query gets considered in query
+        #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
+        #          and the current query is "How about 2023?", the current query will
+        #          be interpreted as "How did Alphabet do in 2023?".
+        #
+        #     Example #2 (coordination between /search API calls and /answer API calls):
+        #       1. Call /search API with the auto-session mode (see below).
+        #       2. Call /answer API with the session ID generated in the first call.
+        #          Here, the answer generation happens in the context of the search
+        #          results from the first search call.
+        #
+        #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
+        #     gets automatically created. Otherwise, users can use the create-session API
+        #     to create a session manually.
+        #
+        #     Multi-turn Search feature is currently at private GA stage. Please use
+        #     v1alpha or v1beta version instead before we launch this feature to public
+        #     GA. Or ask for allowlisting through Google Support team.
+        # @!attribute [rw] session_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec]
+        #     Session specification.
+        #
+        #     Can be used only when `session` is set.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -219,7 +267,9 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # A struct to define data stores to filter on in a search call.
+          # A struct to define data stores to filter on in a search call and
+          # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
+          # error is returned.
           # @!attribute [rw] data_store
           #   @return [::String]
           #     Required. Full resource name of
@@ -236,9 +286,12 @@ module Google
           #     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.
+          #     For aggregation in healthcare search, when the [FacetKey.key] is
+          #     "healthcare_aggregation_key", the limit will be overridden to
+          #     10,000 internally, regardless of the value set here.
           #
           #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
           # @!attribute [rw] excluded_filter_keys
@@ -333,7 +386,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".
@@ -453,8 +506,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
@@ -467,10 +520,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
@@ -492,6 +545,21 @@ module Google
           #   @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.
+          # @!attribute [rw] search_result_mode
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode]
+          #     Specifies the search result mode. If unspecified, the
+          #     search result mode is based on
+          #     [DataStore.DocumentProcessingConfig.chunking_config][]:
+          #     * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+          #       it defaults to `CHUNKS`.
+          #     * Otherwise, it defaults to `DOCUMENTS`.
+          # @!attribute [rw] chunk_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec]
+          #     Specifies the chunk spec to be returned from the search response.
+          #     Only available if the
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
           class ContentSearchSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -528,8 +596,9 @@ module Google
             #
             #     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].
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            #     is set to
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
             # @!attribute [rw] include_citations
             #   @return [::Boolean]
             #     Specifies whether to include citations in the summary. The default
@@ -686,6 +755,114 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Specifies the chunk spec to be returned from the search response.
+            # Only available if the
+            # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            # is set to
+            # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
+            # @!attribute [rw] num_previous_chunks
+            #   @return [::Integer]
+            #     The number of previous chunks to be returned of the current chunk. The
+            #     maximum allowed value is 3.
+            #     If not specified, no previous chunks will be returned.
+            # @!attribute [rw] num_next_chunks
+            #   @return [::Integer]
+            #     The number of next chunks to be returned of the current chunk. The
+            #     maximum allowed value is 3.
+            #     If not specified, no next chunks will be returned.
+            class ChunkSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specifies the search result mode. If unspecified, the
+            # search result mode is based on
+            # [DataStore.DocumentProcessingConfig.chunking_config][]:
+            # * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+            #   it defaults to `CHUNKS`.
+            # * Otherwise, it defaults to `DOCUMENTS`.
+            module SearchResultMode
+              # Default value.
+              SEARCH_RESULT_MODE_UNSPECIFIED = 0
+
+              # Returns documents in the search result.
+              DOCUMENTS = 1
+
+              # Returns chunks in the search result. Only available if the
+              # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
+              CHUNKS = 2
+            end
+          end
+
+          # Specification for search as you type in search requests.
+          # @!attribute [rw] condition
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition]
+          #     The condition under which search as you type should occur.
+          #     Default to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition::DISABLED Condition.DISABLED}.
+          class SearchAsYouTypeSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Enum describing under which condition search as you type should occur.
+            module Condition
+              # Server behavior defaults to
+              # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition::DISABLED Condition.DISABLED}.
+              CONDITION_UNSPECIFIED = 0
+
+              # Disables Search As You Type.
+              DISABLED = 1
+
+              # Enables Search As You Type.
+              ENABLED = 2
+            end
+          end
+
+          # Session specification.
+          #
+          # Multi-turn Search feature is currently at private GA stage. Please use
+          # v1alpha or v1beta version instead before we launch this feature to public
+          # GA. Or ask for allowlisting through Google Support team.
+          # @!attribute [rw] query_id
+          #   @return [::String]
+          #     If set, the search result gets stored to the "turn" specified by this
+          #     query ID.
+          #
+          #     Example: Let's say the session looks like this:
+          #       session {
+          #         name: ".../sessions/xxx"
+          #         turns {
+          #           query { text: "What is foo?" query_id: ".../questions/yyy" }
+          #           answer: "Foo is ..."
+          #         }
+          #         turns {
+          #           query { text: "How about bar then?" query_id: ".../questions/zzz" }
+          #         }
+          #       }
+          #
+          #     The user can call /search API with a request like this:
+          #
+          #        session: ".../sessions/xxx"
+          #        session_spec { query_id: ".../questions/zzz" }
+          #
+          #     Then, the API stores the search result, associated with the last turn.
+          #     The stored search result can be used by a subsequent /answer API call
+          #     (with the session ID and the query ID specified). Also, it is possible
+          #     to call /search and /answer in parallel with the same session ID & query
+          #     ID.
+          # @!attribute [rw] search_result_persistence_count
+          #   @return [::Integer]
+          #     The number of top search results to persist. The persisted search results
+          #     can be used for the subsequent /answer api call.
+          #
+          #     This field is simliar to the `summary_result_count` field in
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#summary_result_count SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count}.
+          #
+          #     At most 10 results for documents mode, or 50 for chunks mode.
+          class SessionSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
           # @!attribute [rw] key
@@ -757,6 +934,13 @@ module Google
         # @!attribute [rw] query_expansion_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::QueryExpansionInfo]
         #     Query expansion information for the returned results.
+        # @!attribute [rw] session_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo]
+        #     Session information.
+        #
+        #     Only set if
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#session SearchRequest.session}
+        #     is provided. See its description for more details.
         class SearchResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -769,7 +953,13 @@ 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.
+          # @!attribute [rw] chunk
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk]
+          #     The chunk data in the search response if the
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
           class SearchResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -778,7 +968,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>]
@@ -808,7 +998,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.
@@ -978,6 +1168,26 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Information about the session.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the session.
+          #     If the auto-session mode is used (when
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#session SearchRequest.session}
+          #     ends with "-"), this field holds the newly generated session name.
+          # @!attribute [rw] query_id
+          #   @return [::String]
+          #     Query ID that corresponds to this search API call.
+          #     One session can have multiple turns, each with a unique query ID.
+          #
+          #     By specifying the session name and this query ID in the Answer API call,
+          #     the answer generation happens in the context of the search results from
+          #     this search call.
+          class SessionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

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
@@ -187,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.
@@ -415,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