google-cloud-retail-v2 0.10.0 → 0.12.0

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

@@ -58,9 +58,9 @@ module Google
             #
             # This process is asynchronous and does not require the
             # [Product][google.cloud.retail.v2.Product] to exist before updating
-            # fulfillment information. If the request is valid, the update will be
-            # enqueued and processed downstream. As a consequence, when a response is
-            # returned, updates are not immediately manifested in the
+            # fulfillment information. If the request is valid, the update is 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
             # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
             # or
@@ -70,10 +70,10 @@ module Google
             # [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)
+            # the specified inventory field value(s) 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
+            # update times for the specified inventory fields are overwritten by the
+            # times of the
             # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
             # or
             # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
@@ -81,11 +81,11 @@ module Google
             #
             # If no inventory fields are set in
             # [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product],
-            # then any pre-existing inventory information for this product will be used.
+            # then any pre-existing inventory information for this product is used.
             #
             # If no inventory fields are set in
             # [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask],
-            # then any existing inventory information will be preserved.
+            # then any existing inventory information is preserved.
             #
             # Pre-existing inventory information can only be updated with
             # [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
@@ -93,8 +93,17 @@ module Google
             # and
             # [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
             #
+            # The returned [Operation][google.longrunning.Operation]s is obsolete after
+            # one day, and the [GetOperation][google.longrunning.Operations.GetOperation]
+            # API returns `NOT_FOUND` afterwards.
+            #
+            # If conflicting updates are issued, the
+            # [Operation][google.longrunning.Operation]s associated with the stale
+            # updates are not marked as [done][google.longrunning.Operation.done] until
+            # they are obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :SetInventory, ::Google::Cloud::Retail::V2::SetInventoryRequest, ::Google::Longrunning::Operation
             # Incrementally adds place IDs to
             # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -109,8 +118,17 @@ module Google
             # or
             # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
+            # The returned [Operation][google.longrunning.Operation]s will be obsolete
+            # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # [Operation][google.longrunning.Operation]s associated with the stale
+            # updates will not be marked as [done][google.longrunning.Operation.done]
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :AddFulfillmentPlaces, ::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest, ::Google::Longrunning::Operation
             # Incrementally removes place IDs from a
             # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -125,8 +143,17 @@ module Google
             # or
             # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
+            # The returned [Operation][google.longrunning.Operation]s will be obsolete
+            # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # [Operation][google.longrunning.Operation]s associated with the stale
+            # updates will not be marked as [done][google.longrunning.Operation.done]
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :RemoveFulfillmentPlaces, ::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest, ::Google::Longrunning::Operation
             # Updates local inventory information for a
             # [Product][google.cloud.retail.v2.Product] at a list of places, while
@@ -148,8 +175,17 @@ module Google
             # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
             # has no effect on local inventories.
             #
+            # The returned [Operation][google.longrunning.Operation]s will be obsolete
+            # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # [Operation][google.longrunning.Operation]s associated with the stale
+            # updates will not be marked as [done][google.longrunning.Operation.done]
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :AddLocalInventories, ::Google::Cloud::Retail::V2::AddLocalInventoriesRequest, ::Google::Longrunning::Operation
             # Remove local inventory information for a
             # [Product][google.cloud.retail.v2.Product] at a list of places at a removal
@@ -169,8 +205,17 @@ module Google
             # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
             # has no effect on local inventories.
             #
+            # The returned [Operation][google.longrunning.Operation]s will be obsolete
+            # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # [Operation][google.longrunning.Operation]s associated with the stale
+            # updates will not be marked as [done][google.longrunning.Operation.done]
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :RemoveLocalInventories, ::Google::Cloud::Retail::V2::RemoveLocalInventoriesRequest, ::Google::Longrunning::Operation
           end
 

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

@@ -30,7 +30,7 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           #
           class Client
             include Paths
@@ -156,7 +156,7 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload search(request, options = nil)
             #   Pass arguments to `search` via a request object, either of type
@@ -178,7 +178,7 @@ module Google
             #     `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
+            #     This field is used to identify the serving config name and the set
             #     of models that will be used to make the search.
             #   @param branch [::String]
             #     The branch resource name, such as
@@ -274,7 +274,9 @@ module Google
             #     Boost specification to boost certain products. See more details at this
             #     [user guide](https://cloud.google.com/retail/docs/boosting).
             #
-            #     Notice that if both [ServingConfig.boost_control_ids][] and
+            #     Notice that if both
+            #     {::Google::Cloud::Retail::V2::ServingConfig#boost_control_ids ServingConfig.boost_control_ids}
+            #     and
             #     {::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
@@ -361,7 +363,7 @@ module Google
             #     {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
             #
             #     To represent full path of category, use '>' sign to separate different
-            #     hierarchies. If '>' is part of the category name, please replace it with
+            #     hierarchies. If '>' is part of the category name, replace it with
             #     other character(s).
             #
             #     Category pages include special pages such as sales or promotions. For
@@ -372,6 +374,15 @@ module Google
             #     request triggers both product search and faceted search.
             #   @param personalization_spec [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec, ::Hash]
             #     The specification for personalization.
+            #
+            #     Notice that if both
+            #     {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}
+            #     and
+            #     {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
+            #     are set.
+            #     {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
+            #     will override
+            #     {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
             #   @param labels [::Hash{::String => ::String}]
             #     The labels applied to a resource must meet the following requirements:
             #

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

@@ -34,9 +34,9 @@ module Google
         # Service for search.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Please enable Retail Search on Cloud Console before using this feature.
+        # Enable Retail Search on Cloud Console before using this feature.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/search_service"
         #     client = ::Google::Cloud::Retail::V2::SearchService::Client.new

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

@@ -118,6 +118,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :matching_variant_count, :int32, 3
       map :matching_variant_fields, :string, :message, 4, "google.protobuf.FieldMask"
       map :variant_rollup_values, :string, :message, 5, "google.protobuf.Value"
+      repeated :personal_labels, :string, 7
     end
     add_message "google.cloud.retail.v2.SearchResponse.Facet" do
       optional :key, :string, 1

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

@@ -27,7 +27,7 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           class Service
 
             include ::GRPC::GenericService
@@ -39,7 +39,7 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
           end
 

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

@@ -0,0 +1,51 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/serving_config.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/common_pb'
+require 'google/cloud/retail/v2/search_service_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/serving_config.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.ServingConfig" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      optional :model_id, :string, 3
+      optional :price_reranking_level, :string, 4
+      repeated :facet_control_ids, :string, 5
+      optional :dynamic_facet_spec, :message, 6, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec"
+      repeated :boost_control_ids, :string, 7
+      repeated :filter_control_ids, :string, 9
+      repeated :redirect_control_ids, :string, 10
+      repeated :twoway_synonyms_control_ids, :string, 18
+      repeated :oneway_synonyms_control_ids, :string, 12
+      repeated :do_not_associate_control_ids, :string, 13
+      repeated :replacement_control_ids, :string, 14
+      repeated :ignore_control_ids, :string, 15
+      optional :diversity_level, :string, 8
+      optional :diversity_type, :enum, 20, "google.cloud.retail.v2.ServingConfig.DiversityType"
+      optional :enable_category_filter_level, :string, 16
+      optional :personalization_spec, :message, 21, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
+      repeated :solution_types, :enum, 19, "google.cloud.retail.v2.SolutionType"
+    end
+    add_enum "google.cloud.retail.v2.ServingConfig.DiversityType" do
+      value :DIVERSITY_TYPE_UNSPECIFIED, 0
+      value :RULE_BASED_DIVERSITY, 2
+      value :DATA_DRIVEN_DIVERSITY, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ServingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig").msgclass
+        ServingConfig::DiversityType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig.DiversityType").enummodule
+      end
+    end
+  end
+end