google-cloud-retail-v2 0.6.2 → 0.7.0

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

@@ -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
@@ -46,6 +46,9 @@ module Google
         #     identify a visitor on a single device. This unique identifier should not
         #     change if the visitor logs in or out of the website.
         #
+        #     This should be the same identifier as
+        #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id}.
+        #
         #     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] user_info
@@ -89,6 +92,9 @@ module Google
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] canonical_filter
         #   @return [::String]
+        #     The default filter that is applied when a user performs a search without
+        #     checking any filters on the search page.
+        #
         #     The filter applied to every search request when quality improvement such as
         #     query expansion is needed. For example, if a query does not have enough
         #     results, an expanded query with
@@ -115,11 +121,11 @@ module Google
         #     is returned.
         # @!attribute [rw] dynamic_facet_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec]
+        #     Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic
+        #     to enable dynamic facets. Do not set this field.
+        #
         #     The specification for dynamically generated facets. Notice that only
         #     textual facets can be dynamically generated.
-        #
-        #     This feature requires additional allowlisting. Contact Retail Search
-        #     support team if you are interested in using dynamic facet feature.
         # @!attribute [rw] boost_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
         #     Boost specification to boost certain products. See more details at this
@@ -139,12 +145,15 @@ module Google
         #   @return [::Array<::String>]
         #     The keys to fetch and rollup the matching
         #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-        #     {::Google::Cloud::Retail::V2::Product Product}s attributes. The attributes from
-        #     all the matching {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-        #     {::Google::Cloud::Retail::V2::Product Product}s are merged and de-duplicated.
-        #     Notice that rollup {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-        #     {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
-        #     query latency. Maximum number of keys is 10.
+        #     {::Google::Cloud::Retail::V2::Product Product}s attributes,
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo} or
+        #     {::Google::Cloud::Retail::V2::LocalInventory LocalInventory}s attributes. The
+        #     attributes from all the matching
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
+        #     {::Google::Cloud::Retail::V2::Product Product}s or
+        #     {::Google::Cloud::Retail::V2::LocalInventory LocalInventory}s are merged and
+        #     de-duplicated. Notice that rollup attributes will lead to extra query
+        #     latency. Maximum number of keys is 30.
         #
         #     For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
         #     fulfillment type and a fulfillment ID must be provided in the format of
@@ -157,7 +166,11 @@ module Google
         #     * price
         #     * originalPrice
         #     * discount
+        #     * variantId
         #     * 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.
         #     * attributes.key, where key is any key in the
         #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
         #     * pickupInStore.id, where id is any
@@ -217,6 +230,9 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::SearchMode]
         #     The search mode of the search request. If not specified, a single search
         #     request triggers both product search and faceted search.
+        # @!attribute [rw] personalization_spec
+        #   @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec]
+        #     The specification for personalization.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,6 +335,7 @@ module Google
             #         * "customFulfillment3"
             #         * "customFulfillment4"
             #         * "customFulfillment5"
+            #         * "inventory(place_id,attributes.key)"
             #
             #     * numerical_field =
             #         * "price"
@@ -327,6 +344,8 @@ module Google
             #         * "ratingCount"
             #         * "attributes.key"
             #         * "inventory(place_id,price)"
+            #         * "inventory(place_id,original_price)"
+            #         * "inventory(place_id,attributes.key)"
             # @!attribute [rw] intervals
             #   @return [::Array<::Google::Cloud::Retail::V2::Interval>]
             #     Set only if values should be bucketized into intervals. Must be set
@@ -452,6 +471,14 @@ module Google
           #     in the specifictions, boost scores from these specifications are all
           #     applied and combined in a non-linear way. Maximum number of
           #     specifications is 10.
+          # @!attribute [rw] skip_boost_spec_validation
+          #   @return [::Boolean]
+          #     Whether to skip boostspec validation. If this field is set to true,
+          #     invalid
+          #     {::Google::Cloud::Retail::V2::SearchRequest::BoostSpec#condition_boost_specs BoostSpec.condition_boost_specs}
+          #     will be ignored and valid
+          #     {::Google::Cloud::Retail::V2::SearchRequest::BoostSpec#condition_boost_specs BoostSpec.condition_boost_specs}
+          #     will still be applied.
           class BoostSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -527,6 +554,29 @@ module Google
             end
           end
 
+          # The specification for personalization.
+          # @!attribute [rw] mode
+          #   @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode]
+          #     Defaults to
+          #     {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
+          class PersonalizationSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The personalization mode of each search request.
+            module Mode
+              # Default value. Defaults to
+              # {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
+              MODE_UNSPECIFIED = 0
+
+              # Let CRS decide whether to use personalization.
+              AUTO = 1
+
+              # Disable personalization.
+              DISABLED = 2
+            end
+          end
+
           # The search mode of each search request.
           module SearchMode
             # Default value. In this case both product search and faceted search will
@@ -596,6 +646,15 @@ module Google
         #     {::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.
+        # @!attribute [rw] applied_controls
+        #   @return [::Array<::String>]
+        #     The fully qualified resource name of applied
+        #     [controls](https://cloud.google.com/retail/docs/serving-control-rules).
+        # @!attribute [rw] invalid_condition_boost_specs
+        #   @return [::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>]
+        #     The invalid
+        #     {::Google::Cloud::Retail::V2::SearchRequest::BoostSpec#condition_boost_specs SearchRequest.BoostSpec.condition_boost_specs}
+        #     that are not applied during serving.
         class SearchResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -30,7 +30,6 @@ module Google
         #     * `add-to-cart`: Products being added to cart.
         #     * `category-page-view`: Special pages such as sale or promotion pages
         #       viewed.
-        #     * `completion`: Completion query result showed/clicked.
         #     * `detail-page-view`: Products detail page viewed.
         #     * `home-page-view`: Homepage viewed.
         #     * `promotion-offered`: Promotion is offered to a user.
@@ -108,6 +107,7 @@ module Google
         #     * `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
@@ -118,22 +118,35 @@ module Google
         #     desired. The end user may have not finished browsing the whole page yet.
         # @!attribute [rw] completion_detail
         #   @return [::Google::Cloud::Retail::V2::CompletionDetail]
-        #     The main completion details related to the event.
+        #     The main auto-completion details related to the event.
         #
-        #     In a `completion` event, this field represents the completions returned to
-        #     the end user and the clicked completion by the end user. In a `search`
-        #     event, it represents the search event happens after clicking completion.
+        #     This field should be set for `search` event when autocomplete function is
+        #     enabled and the user clicks a suggestion for search.
         # @!attribute [rw] attributes
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
         #     Extra user event features to include in the recommendation model.
         #
-        #     The key must be a UTF-8 encoded string with a length limit of 5,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
-        #
-        #     For product recommendation, an example of extra user information is
-        #     traffic_channel, i.e. how user arrives at the site. Users can arrive
-        #     at the site by coming to the site directly, or coming through Google
-        #     search, and etc.
+        #     If you provide custom attributes for ingested user events, also include
+        #     them in the user events that you associate with prediction requests. Custom
+        #     attribute formatting must be consistent between imported events and events
+        #     provided with prediction requests. This lets the Retail API use
+        #     those custom attributes when training models and serving predictions, which
+        #     helps improve recommendation quality.
+        #
+        #     This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
+        #     error is returned:
+        #
+        #     * The key must be a UTF-8 encoded string with a length limit of 5,000
+        #       characters.
+        #     * For text attributes, at most 400 values are allowed. Empty values are not
+        #       allowed. Each value must be a UTF-8 encoded string with a length limit of
+        #       256 characters.
+        #     * For number attributes, at most 400 values are allowed.
+        #
+        #     For product recommendations, an example of extra user information is
+        #     traffic_channel, which is how a user arrives at the site. Users can arrive
+        #     at the site by coming to the site directly, coming through Google
+        #     search, or in other ways.
         # @!attribute [rw] cart_id
         #   @return [::String]
         #     The ID or name of the associated shopping cart. This ID is used

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -202,6 +202,7 @@ files:
 - lib/google/cloud/retail/v2/product_service/paths.rb
 - lib/google/cloud/retail/v2/product_service_pb.rb
 - lib/google/cloud/retail/v2/product_service_services_pb.rb
+- lib/google/cloud/retail/v2/promotion_pb.rb
 - lib/google/cloud/retail/v2/purge_config_pb.rb
 - lib/google/cloud/retail/v2/search_service.rb
 - lib/google/cloud/retail/v2/search_service/client.rb
@@ -230,6 +231,7 @@ files:
 - proto_docs/google/cloud/retail/v2/prediction_service.rb
 - proto_docs/google/cloud/retail/v2/product.rb
 - proto_docs/google/cloud/retail/v2/product_service.rb
+- proto_docs/google/cloud/retail/v2/promotion.rb
 - proto_docs/google/cloud/retail/v2/purge_config.rb
 - proto_docs/google/cloud/retail/v2/search_service.rb
 - proto_docs/google/cloud/retail/v2/user_event.rb
@@ -263,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Retail V2 API