RubyGems - google-cloud-retail-v2 - Versions diffs - 0.7.0 → 0.8.0 - Mend

google-cloud-retail-v2 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89163592b295d93348803898a24239837bdb48bbf061a099a2112d914cc53e47
-  data.tar.gz: 12193ad19dff4ed242f1329e90a1c40adb99d837eafc5adc7b2a478006e9fb57
+  metadata.gz: '09eebe56def80aca474541e0f90b49b98428f7530cd3cf00f76ed6d069d0d2e3'
+  data.tar.gz: cb93509ec2c2f405c2dd69bf015f53dfa7daf9fa685190e4f6b64ce174371ad5
 SHA512:
-  metadata.gz: bd235626e52464707b3c9a3631960409b73adc577ca457cacb18af1f07bf1484edc97493525fc062134a2a791d7e70d0833bea9a9584df9844ae58cbe968ca04
-  data.tar.gz: 2be8ed1a45db9dd9aa5cb14def5fcf6cb7de39162cef3c9328c7a716585bd211ffc15d1cc1c59861d13ae51888815700d17d074592fdf86f9f153b57b9d037bc
+  metadata.gz: abc56ec5460f8cf74fde99d87bc6d44474a1f72fed49fb9dde8c414e2e6ac58f97061b29ca5f017af432fd3751ef160853048496689d4575146eae29fb3d4164
+  data.tar.gz: '08b8bf20cd8fc3c3f15a13b2b21a6fecb391d41e8697a17ba43e572e546733d9571d843be5724bd05d4e302788629f9d6a5f9562d1d0498d7f89711d0ff036a6'

data/README.md CHANGED Viewed

@@ -69,6 +69,11 @@ module GRPC
 end
 ```
+## Google Cloud Samples
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
 ## Supported Ruby Versions
 This library is supported on Ruby 2.5+.

data/lib/google/cloud/retail/v2/catalog_pb.rb CHANGED Viewed

@@ -1,9 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/catalog.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/catalog.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/catalog_service_pb.rb CHANGED Viewed

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/catalog_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/catalog_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/catalog_service.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/common_pb.rb CHANGED Viewed

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

data/lib/google/cloud/retail/v2/completion_service/client.rb CHANGED Viewed

@@ -236,9 +236,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).
             #   @param max_suggestions [::Integer]
             #     Completion max suggestions. If left unset or set to 0, then will fallback
             #     to the configured value [CompletionConfig.max_suggestions][].

data/lib/google/cloud/retail/v2/completion_service_pb.rb CHANGED Viewed

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

data/lib/google/cloud/retail/v2/import_config_pb.rb CHANGED Viewed

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/import_config.proto
+require 'google/protobuf'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/product_pb'
@@ -9,7 +11,6 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
 require 'google/type/date_pb'
-require 'google/protobuf'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/import_config.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/prediction_service/client.rb CHANGED Viewed

@@ -182,6 +182,16 @@ module Google
             #     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.
             #   @param page_size [::Integer]
             #     Maximum number of results to return per page. Set this property
             #     to the number of prediction results needed. If zero, the service will
@@ -256,7 +266,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

data/lib/google/cloud/retail/v2/prediction_service_pb.rb CHANGED Viewed

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

data/lib/google/cloud/retail/v2/product_pb.rb CHANGED Viewed

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/product.proto
+require 'google/protobuf'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/common_pb'
@@ -9,7 +11,6 @@ require 'google/protobuf/duration_pb'
 require 'google/protobuf/field_mask_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/product.proto", :syntax => :proto3) do

data/lib/google/cloud/retail/v2/product_service/client.rb CHANGED Viewed

@@ -566,6 +566,11 @@ module Google
             #
             #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
             #     is returned.
+            #
+            #     The attribute key can be updated by setting the mask path as
+            #     "attributes.$\\{key_name}". If a key name is present in the mask but not in
+            #     the patching product from the request, this key will be deleted after the
+            #     update.
             #   @param allow_missing [::Boolean]
             #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
             #     found, a new {::Google::Cloud::Retail::V2::Product Product} will be created. In
@@ -743,7 +748,7 @@ module Google
             ##
             # Bulk import of multiple {::Google::Cloud::Retail::V2::Product 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
@@ -784,11 +789,18 @@ module Google
             #     imported. Defaults to
             #     {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
             #   @param notification_pubsub_topic [::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}
@@ -901,7 +913,7 @@ module Google
             #
             # Pre-existing inventory information can only be updated with
             # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory SetInventory},
-            # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places AddFulfillmentPlaces},
+            # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces},
             # and
             # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places RemoveFulfillmentPlaces}.
             #
@@ -1286,7 +1298,8 @@ module Google
             #     If this field is set to an invalid value other than these, an
             #     INVALID_ARGUMENT error is returned.
             #
-            #     This field directly corresponds to [Product.fulfillment_info.type][].
+            #     This field directly corresponds to
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
             #   @param place_ids [::Array<::String>]
             #     Required. The IDs for this
             #     {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest#type type}, such as

data/lib/google/cloud/retail/v2/product_service_pb.rb CHANGED Viewed

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

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

@@ -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
@@ -86,7 +86,7 @@ module Google
             #
             # Pre-existing inventory information can only be updated with
             # [SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
-            # [AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
+            # [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
             # and
             # [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
             #

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

@@ -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 CHANGED Viewed

@@ -168,14 +168,14 @@ 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`
+            #     `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 +186,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 +273,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 +309,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 +370,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 CHANGED Viewed

@@ -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"
@@ -82,6 +85,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
@@ -140,6 +151,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 CHANGED Viewed

@@ -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_pb.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -78,9 +78,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 +114,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 UTF-8 safe.
         #
         #     Recent searches are deduplicated. More recent searches will be reserved
@@ -134,10 +138,13 @@ 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. This is an experimental feature. Contact Retail Search
+          #     support team if you are interested in enabling it.
           class CompletionResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -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 CHANGED Viewed

@@ -39,6 +39,16 @@ module Google
         #     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
@@ -119,7 +129,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 +195,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 CHANGED Viewed

@@ -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>]

data/proto_docs/google/cloud/retail/v2/product_service.rb CHANGED Viewed

@@ -91,6 +91,11 @@ module Google
         #
         #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
         #     is returned.
+        #
+        #     The attribute key can be updated by setting the mask path as
+        #     "attributes.$\\{key_name}". If a key name is present in the mask but not in
+        #     the patching product from the request, this key will be deleted after the
+        #     update.
         # @!attribute [rw] allow_missing
         #   @return [::Boolean]
         #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
@@ -332,7 +337,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
-        # Request message for [AddFulfillmentPlaces][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces}
+        # method.
         # @!attribute [rw] product
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -400,21 +407,25 @@ module Google
         # Metadata related to the progress of the AddFulfillmentPlaces operation.
         # Currently empty because there is no meaningful metadata populated from the
-        # [AddFulfillmentPlaces][] method.
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces}
+        # method.
         class AddFulfillmentPlacesMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
         # Response of the AddFulfillmentPlacesRequest.  Currently empty because
-        # there is no meaningful response populated from the [AddFulfillmentPlaces][]
+        # there is no meaningful response populated from the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces}
         # method.
         class AddFulfillmentPlacesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
-        # Request message for [AddLocalInventories][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
+        # method.
         # @!attribute [rw] product
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -465,14 +476,18 @@ module Google
         # Metadata related to the progress of the AddLocalInventories operation.
         # Currently empty because there is no meaningful metadata populated from the
-        # [AddLocalInventories][] method.
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
+        # method.
         class AddLocalInventoriesMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
-        # Response of the [AddLocalInventories][] API.  Currently empty because
-        # there is no meaningful response populated from the [AddLocalInventories][]
+        # Response of the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
+        # API.  Currently empty because there is no meaningful response populated from
+        # the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
         # method.
         class AddLocalInventoriesResponse
           include ::Google::Protobuf::MessageExts
@@ -557,7 +572,8 @@ module Google
         #     If this field is set to an invalid value other than these, an
         #     INVALID_ARGUMENT error is returned.
         #
-        #     This field directly corresponds to [Product.fulfillment_info.type][].
+        #     This field directly corresponds to
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
         # @!attribute [rw] place_ids
         #   @return [::Array<::String>]
         #     Required. The IDs for this

data/proto_docs/google/cloud/retail/v2/search_service.rb CHANGED Viewed

@@ -26,7 +26,7 @@ module Google
         # @!attribute [rw] placement
         #   @return [::String]
         #     Required. The resource name of the search engine placement, such as
-        #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
+        #     `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.
         # @!attribute [rw] branch
@@ -39,6 +39,11 @@ module Google
         # @!attribute [rw] query
         #   @return [::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}.
         # @!attribute [rw] visitor_id
         #   @return [::String]
         #     Required. A unique identifier for tracking visitors. For example, this
@@ -132,10 +137,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.
         # @!attribute [rw] query_expansion_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
@@ -170,7 +175,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
@@ -233,6 +239,29 @@ module Google
         # @!attribute [rw] personalization_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec]
         #     The specification for personalization.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::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.
+        # @!attribute [rw] spell_correction_spec
+        #   @return [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec]
+        #     The spell correction specification that specifies the mode under
+        #     which spell correction will take effect.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -252,19 +281,29 @@ module Google
           #   @return [::Array<::String>]
           #     List of keys to exclude when faceting.
           #
+          #
           #     By default,
           #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
           #     is not excluded from the filter unless it is listed in this field.
           #
-          #     For example, suppose there are 100 products with color facet "Red" and
-          #     200 products with color facet "Blue". A query containing the filter
-          #     "colorFamilies:ANY("Red")" and have "colorFamilies" as
+          #     Listing a facet key in this field allows its values to appear as facet
+          #     results, even when they are filtered out of search results. Using this
+          #     field does not affect what search results are returned.
+          #
+          #     For example, suppose there are 100 products with the color facet "Red"
+          #     and 200 products with the color facet "Blue". A query containing the
+          #     filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
           #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
-          #     will by default return the "Red" with count 100.
+          #     would by default return only "Red" products in the search results, and
+          #     also return "Red" with count 100 as the only color facet. Although there
+          #     are also blue products available, "Blue" would not be shown as an
+          #     available facet value.
           #
-          #     If this field contains "colorFamilies", then the query returns both the
-          #     "Red" with count 100 and "Blue" with count 200, because the
-          #     "colorFamilies" key is now excluded from the filter.
+          #     If "colorFamilies" is listed in "excludedFilterKeys", then the query
+          #     returns the facet values "Red" with count 100 and "Blue" with count
+          #     200, because the "colorFamilies" key is now excluded from the filter.
+          #     Because this field doesn't affect search results, the search results
+          #     are still correctly filtered to return only "Red" products.
           #
           #     A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
           #     is returned.
@@ -356,8 +395,8 @@ module Google
             #     Only get facet for the given restricted values. For example, when using
             #     "pickupInStore" as key and set restricted values to
             #     ["store123", "store456"], only facets for "store123" and "store456" are
-            #     returned. Only supported on textual fields and fulfillments.
-            #     Maximum is 20.
+            #     returned. Only supported on predefined textual fields, custom textual
+            #     attributes and fulfillments. Maximum is 20.
             #
             #     Must be set for the fulfillment facet keys:
             #
@@ -470,7 +509,7 @@ module Google
           #     Condition boost specifications. If a product matches multiple conditions
           #     in the specifictions, boost scores from these specifications are all
           #     applied and combined in a non-linear way. Maximum number of
-          #     specifications is 10.
+          #     specifications is 20.
           # @!attribute [rw] skip_boost_spec_validation
           #   @return [::Boolean]
           #     Whether to skip boostspec validation. If this field is set to true,
@@ -577,6 +616,43 @@ module Google
             end
           end
+          # The specification for query spell correction.
+          # @!attribute [rw] mode
+          #   @return [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode]
+          #     The mode under which spell correction should take effect to
+          #     replace the original search query. Default to
+          #     {::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
+          class SpellCorrectionSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+            # Enum describing under which mode spell correction should occur.
+            module Mode
+              # Unspecified spell correction mode. This defaults to
+              # {::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
+              MODE_UNSPECIFIED = 0
+              # Google Retail Search will try to find a spell suggestion if there
+              # is any and put in the
+              # {::Google::Cloud::Retail::V2::SearchResponse#corrected_query SearchResponse.corrected_query}.
+              # The spell suggestion will not be used as the search query.
+              SUGGESTION_ONLY = 1
+              # Automatic spell correction built by Google Retail Search. Search will
+              # be based on the corrected query if found.
+              AUTO = 2
+            end
+          end
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
           # The search mode of each search request.
           module SearchMode
             # Default value. In this case both product search and faceted search will
@@ -598,7 +674,9 @@ module Google
             # Only faceted search will be performed. The product search will be
             # disabled.
             #
-            # When in this mode, one or both of [SearchRequest.facet_spec][] and
+            # When in this mode, one or both of
+            # {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
+            # and
             # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
             # should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
             # [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult]
@@ -624,7 +702,9 @@ module Google
         #     matches.
         # @!attribute [rw] corrected_query
         #   @return [::String]
-        #     If spell correction applies, the corrected query. Otherwise, empty.
+        #     Contains the spell corrected query, if found. If the spell correction type
+        #     is AUTOMATIC, then the search results are based on corrected_query.
+        #     Otherwise the original query will be used for search.
         # @!attribute [rw] attribution_token
         #   @return [::String]
         #     A unique search token. This should be included in the
@@ -642,10 +722,10 @@ module Google
         # @!attribute [rw] redirect_uri
         #   @return [::String]
         #     The URI of a customer-defined redirect page. If redirect action is
-        #     triggered, no search will be performed, and only
+        #     triggered, no search is performed, and only
         #     {::Google::Cloud::Retail::V2::SearchResponse#redirect_uri redirect_uri} and
         #     {::Google::Cloud::Retail::V2::SearchResponse#attribution_token attribution_token}
-        #     will be set in the response.
+        #     are set in the response.
         # @!attribute [rw] applied_controls
         #   @return [::Array<::String>]
         #     The fully qualified resource name of applied

data/proto_docs/google/cloud/retail/v2/user_event.rb CHANGED Viewed

@@ -45,11 +45,15 @@ module Google
         #     able to uniquely identify a visitor on a single device. This unique
         #     identifier should not change if the visitor log in/out of the website.
         #
+        #     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.
         #
         #     The field should not contain PII or user-data. We recommend to use Google
-        #     Analystics [Client
+        #     Analytics [Client
         #     ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
         #     for this field.
         # @!attribute [rw] session_id
@@ -102,12 +106,11 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::ProductDetail>]
         #     The main product details related to the event.
         #
-        #     This field is required for the following event types:
+        #     This field is optional except for the following event types:
         #
         #     * `add-to-cart`
         #     * `detail-page-view`
         #     * `purchase-complete`
-        #     * `search`
         #
         #     In a `search` event, this field represents the products returned to the end
         #     user on the current page (the end user may have not finished browsing the

data/proto_docs/google/protobuf/any.rb CHANGED Viewed

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

data/proto_docs/google/protobuf/struct.rb CHANGED Viewed

@@ -46,8 +46,8 @@ module Google
     # `Value` represents a dynamically typed value which can be either
     # null, a number, a string, a boolean, a recursive struct value, or a
-    # list of values. A producer of value is expected to set one of that
-    # variants, absence of any variant indicates an error.
+    # list of values. A producer of value is expected to set one of these
+    # variants. Absence of any variant indicates an error.
     #
     # The JSON representation for `Value` is JSON value.
     # @!attribute [rw] null_value

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: API Client library for the Retail V2 API