google-cloud-retail-v2 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f199a731870887e4a82c0ed6e57baa1b0053c16ae645de55956210981675e9e0
-  data.tar.gz: 97989b41ed188ee4457af6bbede9fb0cfcdcb567d7704d2d24df474cdd9fe7b7
+  metadata.gz: 4d1c1b9f050a34949ddbbf2216e42a2fcede56547eb053e243c0f4b398798951
+  data.tar.gz: d5748a0e343c717fb44675eb87e4d80ae5afba3e6a222250eca1fc1303d33dea
 SHA512:
-  metadata.gz: 9d6d6b0b4810c7f0745417563ca640bec1921bd4dc1ad6a9e5d5c56c0f87b7d218a29f31b4a7014ba722de9637de11efaa6231618e5c3dc579739df27cbc63ce
-  data.tar.gz: d8db9acbb06dd6a91c5a39ba0bb6be1057f44bb5c4299c8e9c4f68e9bd1489429881ac987371e556ae8d259b0e4d93ecb29eef43510d2d68d13419936d3c1bee
+  metadata.gz: 910e5dc16ed89bd22106fe89d5a48baac5fc4d8d9cc8204485a36adc00effcf1c47702de41b457d3ff89cc2c0b609cb7882389800ee8a6e208caa6699b5851bb
+  data.tar.gz: fa5329eb5145faf2d00bd0117077d8bd297d05bfd98f429302202470b89693ed0813bcbcfe1d871842de50f403ab35524db49bf80a065f558fddb3859314a2d9

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

@@ -204,6 +204,9 @@ module Google
             #     The field must be a UTF-8 encoded string with a length limit of 128
             #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
             #   @param language_codes [::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

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

@@ -169,14 +169,19 @@ module Google
             #
             #   @param placement [::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).
-            #
-            #     The full list of available placements can be seen at
-            #     https://console.cloud.google.com/recommendation/catalogs/default_catalog/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 serving configs can be seen at
+            #     https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
             #   @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
             #     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
@@ -193,12 +198,12 @@ module Google
             #     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
-            #     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.
             #   @param page_token [::String]
-            #     The previous PredictResponse.next_page_token.
+            #     This field is not used; leave it unset.
             #   @param filter [::String]
             #     Filter for restricting prediction results with a length limit of 5,000
             #     characters. Accepts values for tags and the `filterOutOfStockItems` flag.
@@ -229,6 +234,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"))
             #   @param validate_only [::Boolean]
             #     Use validate only mode for this prediction query. If set to true, a
             #     dummy model will be used that returns arbitrary products.
@@ -260,6 +273,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.
             #   @param labels [::Hash{::String => ::String}]
             #     The labels applied to a resource must meet the following requirements:
             #

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

@@ -6,6 +6,7 @@ require 'google/protobuf'
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/protobuf/struct_pb'
 

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

@@ -889,18 +889,21 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, updates are not immediately manifested in the
             # {::Google::Cloud::Retail::V2::Product Product} queried by
-            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
             #
             # When inventory is updated with
-            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct} and
-            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product UpdateProduct}, the
-            # specified inventory field value(s) will overwrite any existing value(s)
+            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
+            # and
+            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product 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
-            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product UpdateProduct}
+            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
             # request.
             #
             # If no inventory fields are set in
@@ -912,10 +915,10 @@ module Google
             # then any existing inventory information will be preserved.
             #
             # Pre-existing inventory information can only be updated with
-            # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory SetInventory},
+            # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory},
             # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces},
             # and
-            # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places RemoveFulfillmentPlaces}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places 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.
@@ -938,6 +941,7 @@ module Google
             #   @param inventory [::Google::Cloud::Retail::V2::Product, ::Hash]
             #     Required. The inventory information to update. The allowable fields to
             #     update are:
+            #
             #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
             #     * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
             #     * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
@@ -945,8 +949,9 @@ module Google
             #     The updated inventory fields must be specified in
             #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
             #
-            #     If [SetInventoryRequest.inventory.name][] is empty or invalid, an
-            #     INVALID_ARGUMENT error is returned.
+            #     If
+            #     {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
+            #     is empty or invalid, an INVALID_ARGUMENT error is returned.
             #
             #     If the caller does not have permission to update the
             #     {::Google::Cloud::Retail::V2::Product Product} named in
@@ -969,7 +974,8 @@ module Google
             #     * Adds "fulfillment_info" in
             #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
             #     * Specifies only the desired fulfillment types and corresponding place IDs
-            #     to update in [SetInventoryRequest.inventory.fulfillment_info][]
+            #     to update in
+            #     {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
             #
             #     The caller can clear all place IDs from a subset of fulfillment types in
             #     the following ways:
@@ -977,9 +983,9 @@ module Google
             #     * Adds "fulfillment_info" in
             #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
             #     * Specifies only the desired fulfillment types to clear in
-            #     [SetInventoryRequest.inventory.fulfillment_info][]
+            #     {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
             #     * Checks that only the desired fulfillment info types have empty
-            #     [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
             #
             #     The last update time is recorded for the following inventory fields:
             #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
@@ -988,7 +994,9 @@ module Google
             #     * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
             #
             #     If a full overwrite of inventory information while ignoring timestamps is
-            #     needed, [UpdateProduct][] should be invoked instead.
+            #     needed,
+            #     {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
+            #     should be invoked instead.
             #   @param set_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Indicates which inventory fields in the provided
             #     {::Google::Cloud::Retail::V2::Product Product} to update.
@@ -1091,8 +1099,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
             # {::Google::Cloud::Retail::V2::Product Product} queried by
-            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products 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.
@@ -1139,7 +1148,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::AddFulfillmentPlacesRequest#type type}, such as
@@ -1250,8 +1260,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
             # {::Google::Cloud::Retail::V2::Product Product} queried by
-            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products 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.
@@ -1406,13 +1417,15 @@ module Google
             # and processed downstream. As a consequence, when a response is returned,
             # updates are not immediately manifested in the
             # {::Google::Cloud::Retail::V2::Product Product} queried by
-            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
             #
             # Local inventory information can only be modified using this method.
-            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct} and
-            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product UpdateProduct} has no
-            # effect on local inventories.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
+            # and
+            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product 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.
@@ -1552,13 +1565,15 @@ module Google
             # enqueued and processed downstream. As a consequence, when a response is
             # returned, removals are not immediately manifested in the
             # {::Google::Cloud::Retail::V2::Product Product} queried by
-            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct} or
-            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+            # or
+            # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
             #
             # Local inventory information can only be removed using this method.
-            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct} and
-            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product UpdateProduct} has no
-            # effect on local inventories.
+            # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
+            # and
+            # {::Google::Cloud::Retail::V2::ProductService::Client#update_product 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/product_service_services_pb.rb

@@ -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],
+            # [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/search_service/client.rb

@@ -174,7 +174,9 @@ module Google
             #   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
+            #     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.

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

@@ -49,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"
@@ -124,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"

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

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

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
@@ -121,7 +124,7 @@ module Google
         #      {::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.
         #
@@ -143,8 +146,9 @@ module Google
           #     ingested through BigQuery.
           #
           #     * For "cloud-retail", the attributes are product attributes generated
-          #     by Cloud Retail. This is an experimental feature. Contact Retail Search
-          #     support team if you are interested in enabling it.
+          #     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/prediction_service.rb

@@ -25,14 +25,19 @@ 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
@@ -51,13 +56,13 @@ module Google
         #     {::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
@@ -89,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
@@ -122,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:

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

@@ -21,7 +21,9 @@ module Google
   module Cloud
     module Retail
       module V2
-        # Request message for [CreateProduct][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
+        # method.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog resource name, such as
@@ -51,7 +53,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [GetProduct][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -69,7 +73,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [UpdateProduct][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
+        # method.
         # @!attribute [rw] product
         #   @return [::Google::Cloud::Retail::V2::Product]
         #     Required. The product to update/create.
@@ -106,7 +112,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [DeleteProduct][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#delete_product ProductService.DeleteProduct}
+        # method.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -238,11 +246,14 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [SetInventory][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
+        # method.
         # @!attribute [rw] inventory
         #   @return [::Google::Cloud::Retail::V2::Product]
         #     Required. The inventory information to update. The allowable fields to
         #     update are:
+        #
         #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
         #     * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
         #     * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
@@ -250,8 +261,9 @@ module Google
         #     The updated inventory fields must be specified in
         #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
         #
-        #     If [SetInventoryRequest.inventory.name][] is empty or invalid, an
-        #     INVALID_ARGUMENT error is returned.
+        #     If
+        #     {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
+        #     is empty or invalid, an INVALID_ARGUMENT error is returned.
         #
         #     If the caller does not have permission to update the
         #     {::Google::Cloud::Retail::V2::Product Product} named in
@@ -274,7 +286,8 @@ module Google
         #     * Adds "fulfillment_info" in
         #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
         #     * Specifies only the desired fulfillment types and corresponding place IDs
-        #     to update in [SetInventoryRequest.inventory.fulfillment_info][]
+        #     to update in
+        #     {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
         #
         #     The caller can clear all place IDs from a subset of fulfillment types in
         #     the following ways:
@@ -282,9 +295,9 @@ module Google
         #     * Adds "fulfillment_info" in
         #     {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
         #     * Specifies only the desired fulfillment types to clear in
-        #     [SetInventoryRequest.inventory.fulfillment_info][]
+        #     {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
         #     * Checks that only the desired fulfillment info types have empty
-        #     [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
         #
         #     The last update time is recorded for the following inventory fields:
         #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
@@ -293,7 +306,9 @@ module Google
         #     * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
         #
         #     If a full overwrite of inventory information while ignoring timestamps is
-        #     needed, [UpdateProduct][] should be invoked instead.
+        #     needed,
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
+        #     should be invoked instead.
         # @!attribute [rw] set_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which inventory fields in the provided
@@ -323,14 +338,16 @@ module Google
 
         # Metadata related to the progress of the SetInventory operation.
         # Currently empty because there is no meaningful metadata populated from the
-        # [SetInventory][] method.
+        # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
+        # method.
         class SetInventoryMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Response of the SetInventoryRequest.  Currently empty because
-        # there is no meaningful response populated from the [SetInventory][]
+        # there is no meaningful response populated from the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
         # method.
         class SetInventoryResponse
           include ::Google::Protobuf::MessageExts
@@ -369,7 +386,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
@@ -494,7 +512,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [RemoveLocalInventories][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
+        # method.
         # @!attribute [rw] product
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -528,21 +548,27 @@ module Google
 
         # Metadata related to the progress of the RemoveLocalInventories operation.
         # Currently empty because there is no meaningful metadata populated from the
-        # [RemoveLocalInventories][] method.
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
+        # method.
         class RemoveLocalInventoriesMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response of the [RemoveLocalInventories][] API.  Currently empty because
-        # there is no meaningful response populated from the [RemoveLocalInventories][]
+        # Response of the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
+        # API.  Currently empty because there is no meaningful response populated from
+        # the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
         # method.
         class RemoveLocalInventoriesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for [RemoveFulfillmentPlaces][] method.
+        # Request message for
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
+        # method.
         # @!attribute [rw] product
         #   @return [::String]
         #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -606,14 +632,16 @@ module Google
 
         # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
         # Currently empty because there is no meaningful metadata populated from the
-        # [RemoveFulfillmentPlaces][] method.
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
+        # method.
         class RemoveFulfillmentPlacesMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-        # is no meaningful response populated from the [RemoveFulfillmentPlaces][]
+        # is no meaningful response populated from the
+        # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
         # method.
         class RemoveFulfillmentPlacesResponse
           include ::Google::Protobuf::MessageExts

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

@@ -25,7 +25,9 @@ module Google
         # {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} method.
         # @!attribute [rw] placement
         #   @return [::String]
-        #     Required. The resource name of the search engine placement, such as
+        #     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.
@@ -431,16 +433,24 @@ module Google
             #     "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the
             #     "categories" facet will give only "Women > Shoe" and "Men > Shoe".
             #     Only supported on textual fields. Maximum is 10.
+            # @!attribute [rw] case_insensitive
+            #   @return [::Boolean]
+            #     True to make facet keys case insensitive when getting faceting
+            #     values with prefixes or contains; false otherwise.
             # @!attribute [rw] order_by
             #   @return [::String]
-            #     The order in which [Facet.values][] are returned.
+            #     The order in which
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet#values SearchResponse.Facet.values}
+            #     are returned.
             #
             #     Allowed values are:
             #
-            #     * "count desc", which means order by [Facet.FacetValue.count][]
+            #     * "count desc", which means order by
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
             #     descending.
             #
-            #     * "value desc", which means order by [Facet.FacetValue.value][]
+            #     * "value desc", which means order by
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
             #     descending.
             #       Only applies to textual facets.
             #
@@ -461,9 +471,11 @@ module Google
             #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
             #     when query is specified.
             #
-            #     In the response, [FacetValue.value][] will be always "1" and
-            #     [FacetValue.count][] will be the number of results that matches the
-            #     query.
+            #     In the response,
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
+            #     will be always "1" and
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
+            #     will be the number of results that match the query.
             #
             #     For example, you can set a customized facet for "shipToStore",
             #     where
@@ -473,6 +485,10 @@ module Google
             #     is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")".
             #     Then the facet will count the products that are both in stock and ship
             #     to store "123".
+            # @!attribute [rw] return_min_max
+            #   @return [::Boolean]
+            #     Returns the min and max value for each numerical facet intervals.
+            #     Ignored for textual facets.
             class FacetKey
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -579,7 +595,8 @@ module Google
 
             # Enum describing under which condition query expansion should occur.
             module Condition
-              # Unspecified query expansion condition. This defaults to
+              # Unspecified query expansion condition. In this case, server behavior
+              # defaults to
               # {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
               CONDITION_UNSPECIFIED = 0
 
@@ -604,7 +621,7 @@ module Google
 
             # The personalization mode of each search request.
             module Mode
-              # Default value. Defaults to
+              # Default value. In this case, server behavior defaults to
               # {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
               MODE_UNSPECIFIED = 0
 
@@ -628,7 +645,8 @@ module Google
 
             # Enum describing under which mode spell correction should occur.
             module Mode
-              # Unspecified spell correction mode. This defaults to
+              # Unspecified spell correction mode. In this case, server behavior
+              # defaults to
               # {::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
               MODE_UNSPECIFIED = 0
 
@@ -704,7 +722,7 @@ module Google
         #   @return [::String]
         #     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.
+        #     Otherwise the original query is used for search.
         # @!attribute [rw] attribution_token
         #   @return [::String]
         #     A unique search token. This should be included in the
@@ -859,6 +877,20 @@ module Google
             # @!attribute [rw] count
             #   @return [::Integer]
             #     Number of items that have this facet value.
+            # @!attribute [rw] min_value
+            #   @return [::Float]
+            #     The minimum value in the
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#interval FacetValue.interval}.
+            #     Only supported on numerical facets and returned if
+            #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#return_min_max SearchRequest.FacetSpec.FacetKey.return_min_max}
+            #     is true.
+            # @!attribute [rw] max_value
+            #   @return [::Float]
+            #     The maximum value in the
+            #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#interval FacetValue.interval}.
+            #     Only supported on numerical facets and returned if
+            #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#return_min_max SearchRequest.FacetSpec.FacetKey.return_min_max}
+            #     is true.
             class FacetValue
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common