google-cloud-retail-v2 0.7.0 → 0.10.0

data/lib/google/cloud/retail/v2/product_service_services_pb.rb

@@ -46,7 +46,7 @@ module Google
             rpc :DeleteProduct, ::Google::Cloud::Retail::V2::DeleteProductRequest, ::Google::Protobuf::Empty
             # Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.
             #
-            # Request processing may be synchronous. No partial updating is supported.
+            # Request processing may be synchronous.
             # Non-existing items are created.
             #
             # Note that it is possible for a subset of the
@@ -62,18 +62,21 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, updates are not immediately manifested in the
             # [Product][google.cloud.retail.v2.Product] queried by
-            # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
-            # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
+            # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
+            # or
+            # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # When inventory is updated with
-            # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
-            # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct], the
-            # specified inventory field value(s) will overwrite any existing value(s)
+            # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
+            # and
+            # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct],
+            # the specified inventory field value(s) will overwrite any existing value(s)
             # while ignoring the last update time for this field. Furthermore, the last
             # update time for the specified inventory fields will be overwritten to the
             # time of the
-            # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or
-            # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
+            # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
+            # or
+            # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
             # request.
             #
             # If no inventory fields are set in
@@ -85,10 +88,10 @@ module Google
             # then any existing inventory information will be preserved.
             #
             # Pre-existing inventory information can only be updated with
-            # [SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
-            # [AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
+            # [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
+            # [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
             # and
-            # [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
+            # [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
             #
             # This feature is only available for users who have Retail Search enabled.
             # Please enable Retail Search on Cloud Console before using this feature.
@@ -102,8 +105,9 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, the added place IDs are not immediately manifested in the
             # [Product][google.cloud.retail.v2.Product] queried by
-            # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
-            # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
+            # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
+            # or
+            # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # This feature is only available for users who have Retail Search enabled.
             # Please enable Retail Search on Cloud Console before using this feature.
@@ -117,8 +121,9 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, the removed place IDs are not immediately manifested in the
             # [Product][google.cloud.retail.v2.Product] queried by
-            # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
-            # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
+            # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
+            # or
+            # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # This feature is only available for users who have Retail Search enabled.
             # Please enable Retail Search on Cloud Console before using this feature.
@@ -133,13 +138,15 @@ module Google
             # and processed downstream. As a consequence, when a response is returned,
             # updates are not immediately manifested in the
             # [Product][google.cloud.retail.v2.Product] queried by
-            # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
-            # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
+            # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
+            # or
+            # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # Local inventory information can only be modified using this method.
-            # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
-            # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no
-            # effect on local inventories.
+            # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
+            # and
+            # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
+            # has no effect on local inventories.
             #
             # This feature is only available for users who have Retail Search enabled.
             # Please enable Retail Search on Cloud Console before using this feature.
@@ -152,13 +159,15 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, removals are not immediately manifested in the
             # [Product][google.cloud.retail.v2.Product] queried by
-            # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
-            # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
+            # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
+            # or
+            # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # Local inventory information can only be removed using this method.
-            # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
-            # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no
-            # effect on local inventories.
+            # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
+            # and
+            # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
+            # has no effect on local inventories.
             #
             # This feature is only available for users who have Retail Search enabled.
             # Please enable Retail Search on Cloud Console before using this feature.

data/lib/google/cloud/retail/v2/purge_config_pb.rb

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/purge_config.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/purge_config.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/search_service/client.rb

@@ -168,14 +168,16 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil)
+            # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil)
             #   Pass arguments to `search` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param placement [::String]
-            #     Required. The resource name of the search engine placement, such as
-            #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
+            #     Required. The resource name of the Retail Search serving config, such as
+            #     `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
+            #     or the name of the legacy placement resource, such as
+            #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
             #     This field is used to identify the serving configuration name and the set
             #     of models that will be used to make the search.
             #   @param branch [::String]
@@ -186,6 +188,11 @@ module Google
             #     products under the default branch.
             #   @param query [::String]
             #     Raw search query.
+            #
+            #     If this field is empty, the request is considered a category browsing
+            #     request and returned results are based on
+            #     {::Google::Cloud::Retail::V2::SearchRequest#filter filter} and
+            #     {::Google::Cloud::Retail::V2::SearchRequest#page_categories page_categories}.
             #   @param visitor_id [::String]
             #     Required. A unique identifier for tracking visitors. For example, this
             #     could be implemented with an HTTP cookie, which should be able to uniquely
@@ -268,10 +275,10 @@ module Google
             #     [user guide](https://cloud.google.com/retail/docs/boosting).
             #
             #     Notice that if both [ServingConfig.boost_control_ids][] and
-            #     [SearchRequest.boost_spec] are set, the boost conditions from both places
-            #     are evaluated. If a search request matches multiple boost conditions,
-            #     the final boost score is equal to the sum of the boost scores from all
-            #     matched boost conditions.
+            #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}
+            #     are set, the boost conditions from both places are evaluated. If a search
+            #     request matches multiple boost conditions, the final boost score is equal
+            #     to the sum of the boost scores from all matched boost conditions.
             #   @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
             #     The query expansion specification that specifies the conditions under which
             #     query expansion will occur. See more details at this [user
@@ -304,7 +311,8 @@ module Google
             #     * inventory(place_id,price)
             #     * inventory(place_id,original_price)
             #     * inventory(place_id,attributes.key), where key is any key in the
-            #       [Product.inventories.attributes][] map.
+            #       {::Google::Cloud::Retail::V2::LocalInventory#attributes Product.local_inventories.attributes}
+            #       map.
             #     * attributes.key, where key is any key in the
             #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
             #     * pickupInStore.id, where id is any
@@ -364,6 +372,27 @@ module Google
             #     request triggers both product search and faceted search.
             #   @param personalization_spec [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec, ::Hash]
             #     The specification for personalization.
+            #   @param labels [::Hash{::String => ::String}]
+            #     The 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.
+            #   @param spell_correction_spec [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash]
+            #     The spell correction specification that specifies the mode under
+            #     which spell correction will take effect.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>]

data/lib/google/cloud/retail/v2/search_service_pb.rb

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/search_service.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -9,7 +11,6 @@ require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/product_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/struct_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/search_service.proto", :syntax => :proto3) do
@@ -33,6 +34,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :page_categories, :string, 23
       optional :search_mode, :enum, 31, "google.cloud.retail.v2.SearchRequest.SearchMode"
       optional :personalization_spec, :message, 32, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
+      map :labels, :string, :string, 34
+      proto3_optional :spell_correction_spec, :message, 35, "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec"
     end
     add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
       optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
@@ -46,8 +49,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :restricted_values, :string, 3
       repeated :prefixes, :string, 8
       repeated :contains, :string, 9
+      optional :case_insensitive, :bool, 10
       optional :order_by, :string, 4
       optional :query, :string, 5
+      optional :return_min_max, :bool, 11
     end
     add_message "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec" do
       optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode"
@@ -82,6 +87,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :AUTO, 1
       value :DISABLED, 2
     end
+    add_message "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec" do
+      optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode"
+    end
+    add_enum "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode" do
+      value :MODE_UNSPECIFIED, 0
+      value :SUGGESTION_ONLY, 1
+      value :AUTO, 2
+    end
     add_enum "google.cloud.retail.v2.SearchRequest.SearchMode" do
       value :SEARCH_MODE_UNSPECIFIED, 0
       value :PRODUCT_SEARCH_ONLY, 1
@@ -113,6 +126,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.retail.v2.SearchResponse.Facet.FacetValue" do
       optional :count, :int64, 3
+      optional :min_value, :double, 5
+      optional :max_value, :double, 6
       oneof :facet_value do
         optional :value, :string, 1
         optional :interval, :message, 2, "google.cloud.retail.v2.Interval"
@@ -140,6 +155,8 @@ module Google
         SearchRequest::QueryExpansionSpec::Condition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition").enummodule
         SearchRequest::PersonalizationSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.PersonalizationSpec").msgclass
         SearchRequest::PersonalizationSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.PersonalizationSpec.Mode").enummodule
+        SearchRequest::SpellCorrectionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec").msgclass
+        SearchRequest::SpellCorrectionSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode").enummodule
         SearchRequest::SearchMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SearchMode").enummodule
         SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse").msgclass
         SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.SearchResult").msgclass

data/lib/google/cloud/retail/v2/user_event_pb.rb

@@ -1,12 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/product_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/user_event.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/user_event_service/operations.rb

@@ -95,6 +95,9 @@ module Google
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors
               )
+
+              # Used by an LRO wrapper for some methods of this service
+              @operations_client = self
             end
 
             # Service calls

data/lib/google/cloud/retail/v2/user_event_service_pb.rb

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event_service.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,7 +12,6 @@ require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/longrunning/operations_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/user_event_service.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.7.0"
+        VERSION = "0.10.0"
       end
     end
   end

data/proto_docs/google/cloud/retail/v2/catalog.rb

@@ -34,10 +34,10 @@ module Google
         #       default to
         #       {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY} if
         #       unset.
-        #     * `variant`: You can only ingest
-        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
-        #     {::Google::Cloud::Retail::V2::Product Product}s.
-        #       This means
+        #     * `variant` (incompatible with Retail Search): You can only
+        #       ingest
+        #       {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #       {::Google::Cloud::Retail::V2::Product Product}s. This means
         #       {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}
         #       cannot be empty.
         #
@@ -48,8 +48,8 @@ module Google
         #     {::Google::Cloud::Retail::V2::ProductLevelConfig#merchant_center_product_id_field merchant_center_product_id_field}
         #     is `itemGroupId`, an INVALID_ARGUMENT error is returned.
         #
-        #     See [Using product
-        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     See [Product
+        #     levels](https://cloud.google.com/retail/docs/catalog#product-levels)
         #     for more details.
         # @!attribute [rw] merchant_center_product_id_field
         #   @return [::String]
@@ -70,8 +70,8 @@ module Google
         #     {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type ingestion_product_type}
         #     is `variant`, an INVALID_ARGUMENT error is returned.
         #
-        #     See [Using product
-        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     See [Product
+        #     levels](https://cloud.google.com/retail/docs/catalog#product-levels)
         #     for more details.
         class ProductLevelConfig
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/common.rb

@@ -115,11 +115,13 @@ module Google
         #     Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] searchable
         #   @return [::Boolean]
-        #     This field will only be used when
+        #     This field is normally ignored unless
         #     [AttributesConfig.attribute_config_level][] of the
-        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is
-        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute values are
-        #     searchable by text queries in
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
+        #     If true, custom attribute values are searchable by text queries in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
         #     This field is ignored in a {::Google::Cloud::Retail::V2::UserEvent UserEvent}.
@@ -128,11 +130,14 @@ module Google
         #     set. Otherwise, a INVALID_ARGUMENT error is returned.
         # @!attribute [rw] indexable
         #   @return [::Boolean]
-        #     This field will only be used when
+        #     This field is normally ignored unless
         #     [AttributesConfig.attribute_config_level][] of the
-        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is
-        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute values are
-        #     indexed, so that it can be filtered, faceted or boosted in
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
+        #     If true, custom attribute values are indexed, so that they can be filtered,
+        #     faceted or boosted in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
         #     This field is ignored in a {::Google::Cloud::Retail::V2::UserEvent UserEvent}.
@@ -260,7 +265,10 @@ module Google
         # @!attribute [rw] original_price
         #   @return [::Float]
         #     Price of the product without any discount. If zero, by default set to be
-        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}.
+        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}. If set,
+        #     {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price} should be
+        #     greater than or equal to {::Google::Cloud::Retail::V2::PriceInfo#price price},
+        #     otherwise an INVALID_ARGUMENT error is thrown.
         # @!attribute [rw] cost
         #   @return [::Float]
         #     The costs associated with the sale of a particular product. Used for gross
@@ -373,10 +381,14 @@ module Google
         # @!attribute [rw] user_id
         #   @return [::String]
         #     Highly recommended for logged-in users. Unique identifier for logged-in
-        #     user, such as a user name.
+        #     user, such as a user name. Don't set for anonymous users.
         #
         #     Always use a hashed value for this ID.
         #
+        #     Don't set the field to the same fixed ID for different users. This mixes
+        #     the event history of those users together, which results in degraded
+        #     model quality.
+        #
         #     The field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] ip_address

data/proto_docs/google/cloud/retail/v2/completion_service.rb

@@ -44,6 +44,9 @@ module Google
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] language_codes
         #   @return [::Array<::String>]
+        #     Note that this field applies for `user-data` dataset only. For requests
+        #     with `cloud-retail` dataset, setting this field has no effect.
+        #
         #     The language filters applied to the output suggestions. If set, it should
         #     contain the language of the query. If not set, suggestions are returned
         #     without considering language restrictions. This is the BCP-47 language
@@ -78,9 +81,9 @@ module Google
         #
         #     * user-data
         #
-        #     * cloud-retail
-        #       This option requires additional allowlisting. Before using cloud-retail,
-        #       contact Cloud Retail support team first.
+        #     * cloud-retail:
+        #       This option requires enabling auto-learning function first. See
+        #       [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
         # @!attribute [rw] max_suggestions
         #   @return [::Integer]
         #     Completion max suggestions. If left unset or set to 0, then will fallback
@@ -114,11 +117,15 @@ module Google
         #     {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
         #     field is set and {::Google::Cloud::Retail::V2::UserEvent UserEvent} is imported.
         #     The recent searches satisfy the follow rules:
+        #
         #      * They are ordered from latest to oldest.
+        #
         #      * They are matched with
         #      {::Google::Cloud::Retail::V2::CompleteQueryRequest#query CompleteQueryRequest.query}
         #      case insensitively.
-        #      * They are transformed to lower cases.
+        #
+        #      * They are transformed to lower case.
+        #
         #      * They are UTF-8 safe.
         #
         #     Recent searches are deduplicated. More recent searches will be reserved
@@ -134,10 +141,14 @@ module Google
           # @!attribute [rw] attributes
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
           #     Custom attributes for the suggestion term.
+          #
           #     * For "user-data", the attributes are additional custom attributes
           #     ingested through BigQuery.
+          #
           #     * For "cloud-retail", the attributes are product attributes generated
-          #     by Cloud Retail.
+          #     by Cloud Retail. It requires
+          #     {::Google::Cloud::Retail::V2::UserEvent#product_details UserEvent.product_details}
+          #     is imported properly.
           class CompletionResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/retail/v2/import_config.rb

@@ -184,11 +184,18 @@ module Google
         #     {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
-        #     Pub/Sub topic for receiving notification. If this field is set,
+        #     Full Pub/Sub topic name for receiving notification. If this field is set,
         #     when the import is finished, a notification will be sent to
         #     specified Pub/Sub topic. The message data will be JSON string of a
         #     {::Google::Longrunning::Operation Operation}.
-        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
+        #
+        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
+        #     to be within the same project as
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
+        #     Make sure that both
+        #     `cloud-retail-customer-data-access@system.gserviceaccount.com` and
+        #     `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
+        #     have the `pubsub.topics.publish` IAM permission on the topic.
         #
         #     Only supported when
         #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}

data/proto_docs/google/cloud/retail/v2/prediction_service.rb

@@ -25,29 +25,44 @@ module Google
         # @!attribute [rw] placement
         #   @return [::String]
         #     Required. Full resource name of the format:
-        #     \\{name=projects/*/locations/global/catalogs/default_catalog/placements/*}
-        #     The ID of the Recommendations AI placement. Before you can request
-        #     predictions from your model, you must create at least one placement for it.
-        #     For more information, see [Managing
-        #     placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
+        #     `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
+        #     or
+        #     `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
+        #     We recommend using the `servingConfigs` resource. `placements` is a legacy
+        #     resource.
+        #     The ID of the Recommendations AI serving config or placement.
+        #     Before you can request predictions from your model, you must create at
+        #     least one serving config or placement for it. For more information, see
+        #     [Managing serving configurations]
+        #     (https://cloud.google.com/retail/docs/manage-configs).
         #
-        #     The full list of available placements can be seen at
-        #     https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
+        #     The full list of available serving configs can be seen at
+        #     https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::Retail::V2::UserEvent]
         #     Required. Context about the user, what they are looking at and what action
         #     they took to trigger the predict request. Note that this user event detail
         #     won't be ingested to userEvent logs. Thus, a separate userEvent write
         #     request is required for event logging.
+        #
+        #     Don't set
+        #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or
+        #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same
+        #     fixed ID for different users. If you are trying to receive non-personalized
+        #     recommendations (not recommended; this can negatively impact model
+        #     performance), instead set
+        #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a
+        #     random unique ID and leave
+        #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Maximum number of results to return per page. Set this property
-        #     to the number of prediction 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.
+        #     Maximum number of results to return. Set this property to the number of
+        #     prediction 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.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     The previous PredictResponse.next_page_token.
+        #     This field is not used; leave it unset.
         # @!attribute [rw] filter
         #   @return [::String]
         #     Filter for restricting prediction results with a length limit of 5,000
@@ -79,6 +94,14 @@ module Google
         #     receive empty results instead.
         #     Note that the API will never return items with storageStatus of "EXPIRED"
         #     or "DELETED" regardless of filter choices.
+        #
+        #     If `filterSyntaxV2` is set to true under the `params` field, then
+        #     attribute-based expressions are expected instead of the above described
+        #     tag-based syntax. Examples:
+        #
+        #      * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
+        #      * (availability: ANY("IN_STOCK")) AND
+        #        (colors: ANY("Red") OR categories: ANY("Phones"))
         # @!attribute [rw] validate_only
         #   @return [::Boolean]
         #     Use validate only mode for this prediction query. If set to true, a
@@ -112,6 +135,8 @@ module Google
         #        'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
         #        request-level control and adjusts prediction results based on product
         #        category.
+        #     * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
+        #       field is interpreteted according to the new, attribute-based syntax.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The labels applied to a resource must meet the following requirements:
@@ -119,7 +144,7 @@ module Google
         #     * 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
+        #       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
@@ -185,9 +210,9 @@ module Google
           #
           #     Possible values:
           #
-          #     * `product`: JSON representation of the product. Will be set if
+          #     * `product`: JSON representation of the product. Is set if
           #       `returnProduct` is set to true in `PredictRequest.params`.
-          #     * `score`: Prediction score in double value. Will be set if
+          #     * `score`: Prediction score in double value. Is set if
           #       `returnScore` is set to true in `PredictRequest.params`.
           class PredictionResult
             include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -456,11 +456,11 @@ module Google
         #     * {::Google::Cloud::Retail::V2::Product#name name}
         #     * {::Google::Cloud::Retail::V2::Product#color_info color_info}
         #
-        #     Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
+        #     The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
         #     returned.
         #
         #     Note: Returning more fields in
-        #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} may increase
+        #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
         #     response payload size and serving latency.
         # @!attribute [r] variants
         #   @return [::Array<::Google::Cloud::Retail::V2::Product>]