google-cloud-discovery_engine-v1 0.7.0 → 0.8.0

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

@@ -0,0 +1,124 @@
+# 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
+        # Record message for
+        # {::Google::Cloud::DiscoveryEngine::V1::RankService::Client#rank RankService.Rank} method.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     The unique ID to represent the record.
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     The title of the record. Empty by default.
+        #     At least one of
+        #     {::Google::Cloud::DiscoveryEngine::V1::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1::RankingRecord#content content} should be
+        #     set otherwise an INVALID_ARGUMENT error is thrown.
+        # @!attribute [rw] content
+        #   @return [::String]
+        #     The content of the record. Empty by default.
+        #     At least one of
+        #     {::Google::Cloud::DiscoveryEngine::V1::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1::RankingRecord#content content} should be
+        #     set otherwise an INVALID_ARGUMENT error is thrown.
+        # @!attribute [rw] score
+        #   @return [::Float]
+        #     The score of this record based on the given query and selected model.
+        class RankingRecord
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::RankService::Client#rank RankService.Rank} method.
+        # @!attribute [rw] ranking_config
+        #   @return [::String]
+        #     Required. The resource name of the rank service config, such as
+        #     `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+        # @!attribute [rw] model
+        #   @return [::String]
+        #     The identifier of the model to use. It is one of:
+        #
+        #     * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+        #     token size 512.
+        #
+        #     It is set to `semantic-ranker-512@latest` by default if unspecified.
+        # @!attribute [rw] top_n
+        #   @return [::Integer]
+        #     The number of results to return. If this is unset or no bigger than zero,
+        #     returns all results.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     The query to use.
+        # @!attribute [rw] records
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RankingRecord>]
+        #     Required. A list of records to rank. At most 200 records to rank.
+        # @!attribute [rw] ignore_record_details_in_response
+        #   @return [::Boolean]
+        #     If true, the response will contain only record ID and score. By default, it
+        #     is false, the response will contain record details.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class RankRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::RankService::Client#rank RankService.Rank} method.
+        # @!attribute [rw] records
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RankingRecord>]
+        #     A list of records sorted by descending score.
+        class RankResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module Google
         #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
         #
         #     One default serving config is created along with your recommendation engine
-        #     creation. The engine ID will be used as the ID of the default serving
+        #     creation. The engine ID is used as the ID of the default serving
         #     config. For example, for Engine
         #     `projects/*/locations/global/collections/*/engines/my-engine`, you can use
         #     `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
@@ -57,9 +57,9 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of results to return. Set this property
-        #     to the number of recommendation results needed. If zero, the service will
-        #     choose a reasonable default. The maximum allowed value is 100. Values
-        #     above 100 will be coerced to 100.
+        #     to the number of recommendation results needed. If zero, the service
+        #     chooses a reasonable default. The maximum allowed value is 100. Values
+        #     above 100 are set to 100.
         # @!attribute [rw] filter
         #   @return [::String]
         #     Filter for restricting recommendation results with a length limit of 5,000
@@ -80,19 +80,19 @@ module Google
         #      * (available: true) AND
         #        (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
         #
-        #     If your filter blocks all results, the API will return generic
+        #     If your filter blocks all results, the API returns generic
         #     (unfiltered) popular Documents. If you only want results strictly matching
-        #     the filters, set `strictFiltering` to True in
+        #     the filters, set `strictFiltering` to `true` in
         #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}
         #     to receive empty results instead.
         #
-        #     Note that the API will never return
+        #     Note that the API never returns
         #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s with `storageStatus`
-        #     of `EXPIRED` or `DELETED` regardless of filter choices.
+        #     as `EXPIRED` or `DELETED` regardless of filter choices.
         # @!attribute [rw] validate_only
         #   @return [::Boolean]
-        #     Use validate only mode for this recommendation query. If set to true, a
-        #     fake model will be used that returns arbitrary Document IDs.
+        #     Use validate only mode for this recommendation query. If set to `true`, a
+        #     fake model is used that returns arbitrary Document IDs.
         #     Note that the validate only mode should only be used for testing the API,
         #     or if the model is not ready.
         # @!attribute [rw] params
@@ -101,16 +101,17 @@ module Google
         #
         #     Allowed values:
         #
-        #     * `returnDocument`: Boolean. If set to true, the associated Document
-        #        object will be returned in
+        #     * `returnDocument`: Boolean. If set to `true`, the associated Document
+        #        object is returned in
         #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
-        #     * `returnScore`: Boolean. If set to true, the recommendation 'score'
-        #        corresponding to each returned Document will be set in
+        #     * `returnScore`: Boolean. If set to true, the recommendation score
+        #        corresponding to each returned Document is set in
         #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
-        #        The given 'score' indicates the probability of a Document conversion
-        #        given the user's context and history.
-        #     * `strictFiltering`: Boolean. True by default. If set to false, the service
-        #        will return generic (unfiltered) popular Documents instead of empty if
+        #        The given score indicates the probability of a Document conversion given
+        #        the user's context and history.
+        #     * `strictFiltering`: Boolean. True by default. If set to `false`, the
+        #     service
+        #        returns generic (unfiltered) popular Documents instead of empty if
         #        your filter blocks all recommendation results.
         #     * `diversityLevel`: String. Default empty. If set to be non-empty, then
         #        it needs to be one of:
@@ -201,7 +202,7 @@ module Google
           #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
           # @!attribute [rw] metadata
           #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
-          #     Additional Document metadata / annotations.
+          #     Additional Document metadata or annotations.
           #
           #     Possible values:
           #

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

@@ -46,9 +46,9 @@ module Google
         #     return. The service may return fewer than this value.
         #
         #     If unspecified, at most 100
-        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}s will be returned.
+        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}s are returned.
         #
-        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        #     The maximum value is 1000; values above 1000 are set to 1000.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token, received from a previous
@@ -93,8 +93,8 @@ module Google
         # @!attribute [rw] schema_id
         #   @return [::String]
         #     Required. The ID to use for the
-        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}, which will become the
-        #     final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}, which becomes the final
+        #     component of the
         #     {::Google::Cloud::DiscoveryEngine::V1::Schema#name Schema.name}.
         #
         #     This field should conform to
@@ -114,7 +114,7 @@ module Google
         # @!attribute [rw] allow_missing
         #   @return [::Boolean]
         #     If set to true, and the {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} is
-        #     not found, a new {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} will be
+        #     not found, a new {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} is
         #     created. In this situation, `update_mask` is ignored.
         class UpdateSchemaRequest
           include ::Google::Protobuf::MessageExts

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.
@@ -135,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.
@@ -144,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)
@@ -153,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
@@ -219,7 +222,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. 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
@@ -236,7 +241,7 @@ 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.
           #
@@ -333,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".
@@ -453,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
@@ -467,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
@@ -769,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
@@ -778,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>]
@@ -808,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.

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