google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0

data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb

@@ -0,0 +1,186 @@
+# 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 V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#get_sample_query_set SampleQuerySetService.GetSampleQuerySet}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
+        #     as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
+        #     regardless of whether or not it exists, a PERMISSION_DENIED error is
+        #     returned.
+        #
+        #     If the requested
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} does
+        #     not exist, a NOT_FOUND error is returned.
+        class GetSampleQuerySetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent location resource name, such as
+        #     `projects/{project}/locations/{location}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s under
+        #     this location, regardless of whether or not this location exists, a
+        #     `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s to
+        #     return. If unspecified, defaults to 100. The maximum allowed value is 1000.
+        #     Values above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse#next_page_token ListSampleQuerySetsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
+        #     must match the call that provided the page token. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class ListSampleQuerySetsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
+        # method.
+        # @!attribute [rw] sample_query_sets
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet>]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest#page_token ListSampleQuerySetsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListSampleQuerySetsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#create_sample_query_set SampleQuerySetService.CreateSampleQuerySet}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}`.
+        # @!attribute [rw] sample_query_set
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
+        #     Required. The
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} to
+        #     create.
+        # @!attribute [rw] sample_query_set_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, which
+        #     will become the final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet#name SampleQuerySet.name}.
+        #
+        #     If the caller does not have permission to create the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
+        #     regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+        #     returned.
+        #
+        #     This field must be unique among all
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s with
+        #     the same
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest#parent parent}.
+        #     Otherwise, an `ALREADY_EXISTS` error is returned.
+        #
+        #     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class CreateSampleQuerySetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#update_sample_query_set SampleQuerySetService.UpdateSampleQuerySet}
+        # method.
+        # @!attribute [rw] sample_query_set
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
+        #     Required. The sample query set to update.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
+        #     regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+        #     returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
+        #     to update does not exist a `NOT_FOUND` error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided imported 'sample query set' to
+        #     update. If not set, will by default update all fields.
+        class UpdateSampleQuerySetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#delete_sample_query_set SampleQuerySetService.DeleteSampleQuerySet}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
+        #     as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
+        #
+        #     If the caller does not have permission to delete the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
+        #     regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+        #     returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
+        #     to delete does not exist, a `NOT_FOUND` error is returned.
+        class DeleteSampleQuerySetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -46,9 +46,9 @@ module Google
         #     to return. The service may return fewer than this value.
         #
         #     If unspecified, at most 100
-        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s will be returned.
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::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
@@ -94,7 +94,7 @@ module Google
         # @!attribute [rw] schema_id
         #   @return [::String]
         #     Required. The ID to use for the
-        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which will become the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which becomes the
         #     final component of the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema#name Schema.name}.
         #
@@ -117,8 +117,8 @@ module Google
         #   @return [::Boolean]
         #     If set to true, and the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is not found, a new
-        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} will be created. In
-        #     this situation, `update_mask` is ignored.
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is created. In this
+        #     situation, `update_mask` is ignored.
         class UpdateSchemaRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1beta/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::V1beta::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::V1beta::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::V1beta::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::V1beta::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
@@ -200,20 +203,26 @@ module Google
         #     documents. This overrides
         #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
         #     The ranking expression is a single function or multiple functions that are
-        #     joint by "+".
+        #     joined by "+".
+        #
         #       * ranking_expression = function, { " + ", function };
+        #
         #     Supported functions:
+        #
         #       * double * relevance_score
         #       * double * dotProduct(embedding_field_path)
+        #
         #     Function variables:
-        #       `relevance_score`: pre-defined keywords, used for measure relevance
+        #
+        #       * `relevance_score`: pre-defined keywords, used for measure relevance
         #       between query and document.
-        #       `embedding_field_path`: the document embedding field
+        #       * `embedding_field_path`: the document embedding field
         #       used with query embedding vector.
-        #       `dotProduct`: embedding function between embedding_field_path and query
+        #       * `dotProduct`: embedding function between embedding_field_path and query
         #       embedding vector.
         #
         #      Example ranking expression:
+        #
         #        If document has an embedding field doc_embedding, the ranking expression
         #        could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
         # @!attribute [rw] safe_search
@@ -253,7 +262,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
@@ -270,9 +281,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
@@ -367,7 +381,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".
@@ -518,7 +532,7 @@ module Google
                   # specified. The value must be formatted as an XSD `dayTimeDuration`
                   # value (a restricted subset of an ISO 8601 duration value). The
                   # pattern for this is: `[nD][T[nH][nM][nS]]`.
-                  # E.g. `5D`, `3DT12H30M`, `T24H`.
+                  # For example, `5D`, `3DT12H30M`, `T24H`.
                   FRESHNESS = 2
                 end
 
@@ -571,8 +585,8 @@ module Google
           # The specification for query spell correction.
           # @!attribute [rw] mode
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
           class SpellCorrectionSpec
             include ::Google::Protobuf::MessageExts
@@ -585,10 +599,10 @@ module Google
               # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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
@@ -610,6 +624,17 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode]
+          #     Specifies the search result mode. If unspecified, the
+          #     search result mode defaults to `DOCUMENTS`.
+          # @!attribute [rw] chunk_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec]
+          #     Specifies the chunk spec to be returned from the search response.
+          #     Only available if the
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
           class ContentSearchSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -644,7 +669,11 @@ module Google
             #     of results returned is less than `summaryResultCount`, the summary is
             #     generated from all of the results.
             #
-            #     At most 10 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
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            #     is set to
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
             # @!attribute [rw] include_citations
             #   @return [::Boolean]
             #     Specifies whether to include citations in the summary. The default
@@ -801,6 +830,40 @@ 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::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            # is set to
+            # {::Google::Cloud::DiscoveryEngine::V1beta::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 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
 
           # The specification that uses customized query embedding vector to do
@@ -900,8 +963,6 @@ module Google
         #     Controls applied as part of the Control service.
         # @!attribute [rw] geo_search_debug_info
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>]
-        #     Debug information specifically related to forward geocoding issues arising
-        #     from Geolocation Search.
         # @!attribute [rw] query_expansion_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
         #     Query expansion information for the returned results.
@@ -917,7 +978,13 @@ module Google
           # @!attribute [rw] document
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::Chunk]
+          #     The chunk data in the search response if the
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
           # @!attribute [rw] model_scores
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
           #     Google provided available scores.
@@ -938,7 +1005,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::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
           # @!attribute [rw] values
           #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
@@ -983,17 +1050,17 @@ module Google
             # Useful attribute for search result refinements.
             # @!attribute [rw] attribute_key
             #   @return [::String]
-            #     Attribute key used to refine the results e.g. 'movie_type'.
+            #     Attribute key used to refine the results. For example, `"movie_type"`.
             # @!attribute [rw] attribute_value
             #   @return [::String]
-            #     Attribute value used to refine the results e.g. 'drama'.
+            #     Attribute value used to refine the results. For example, `"drama"`.
             class RefinementAttribute
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             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/v1beta/search_tuning_service.rb

@@ -21,6 +21,31 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     Required. The resource name of the parent Data Store, such as
+        #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+        #     This field is used to identify the data store where to fetch the models
+        #     from.
+        class ListCustomModelsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] models
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel>]
+        #     List of custom tuning models.
+        class ListCustomModelsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
         # method.
@@ -41,6 +66,9 @@ module Google
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
         #     The desired location of errors incurred during the data ingestion and
         #     training.
+        # @!attribute [rw] model_id
+        #   @return [::String]
+        #     If not provided, a UUID will be generated.
         class TrainCustomModelRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -108,6 +136,9 @@ module Google
         # @!attribute [rw] metrics
         #   @return [::Google::Protobuf::Map{::String => ::Float}]
         #     The metrics of the trained model.
+        # @!attribute [rw] model_name
+        #   @return [::String]
+        #     Fully qualified name of the CustomTuningModel.
         class TrainCustomModelResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb

@@ -93,21 +93,27 @@ module Google
         #
         #     The ranking expression is a single function or multiple functions that are
         #     joined by "+".
+        #
         #       * ranking_expression = function, { " + ", function };
+        #
         #     Supported functions:
+        #
         #       * double * relevance_score
         #       * double * dotProduct(embedding_field_path)
+        #
         #     Function variables:
-        #       relevance_score: pre-defined keywords, used for measure relevance between
-        #       query and document.
-        #       embedding_field_path: the document embedding field
+        #
+        #       * `relevance_score`: pre-defined keywords, used for measure relevance
+        #       between query and document.
+        #       * `embedding_field_path`: the document embedding field
         #       used with query embedding vector.
-        #       dotProduct: embedding function between embedding_field_path and query
+        #       * `dotProduct`: embedding function between embedding_field_path and query
         #       embedding vector.
         #
         #      Example ranking expression:
+        #
         #        If document has an embedding field doc_embedding, the ranking expression
-        #        could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
+        #        could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. ServingConfig created timestamp.

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

@@ -25,7 +25,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Fully qualified name
-        #     `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+        #     `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Session::State]
         #     The state of the session.
@@ -53,6 +53,9 @@ module Google
           # @!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

data/proto_docs/google/cloud/discoveryengine/v1beta/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::V1beta::SiteVerificationInfo]
         #     Output only. Site ownership and validity verification status.

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

@@ -22,7 +22,7 @@ module Google
     module DiscoveryEngine
       module V1beta
         # 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::V1beta::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::V1beta::Engine Engine} produced user events.
+        #     For example, user events from blended search.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::UserEvent#engine UserEvent.engine} or
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::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.
@@ -418,7 +439,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: