google-cloud-retail-v2 0.6.3 → 0.8.0

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

@@ -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
@@ -46,6 +51,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 +97,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,21 +126,21 @@ 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
         #     [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
@@ -139,12 +150,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
@@ -159,8 +173,10 @@ module Google
         #     * 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.
+        #       {::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
@@ -220,6 +236,32 @@ 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.
+        # @!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
@@ -239,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.
@@ -331,6 +383,7 @@ 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>]
@@ -342,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:
             #
@@ -456,7 +509,15 @@ 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,
+          #     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
@@ -532,6 +593,66 @@ 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 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
@@ -553,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]
@@ -579,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
@@ -597,10 +722,19 @@ 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
+        #     [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.
@@ -46,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
@@ -103,7 +106,7 @@ 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`
@@ -118,22 +121,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

data/proto_docs/google/protobuf/any.rb

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

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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-06-09 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.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Retail V2 API