google-cloud-retail-v2 0.4.2 → 0.6.1

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

@@ -27,12 +27,8 @@ module Google
         #   @return [::String]
         #     Required. The resource name of the search engine placement, such as
         #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
-        #     This field is used to identify the set of models that will be used to make
-        #     the search.
-        #
-        #     We currently support one placement with the following ID:
-        #
-        #     * `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
         #   @return [::String]
         #     The branch resource name, such as
@@ -87,7 +83,8 @@ module Google
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
         #     predicate from one or more fields of the products being filtered. Filter
-        #     expression is case-sensitive.
+        #     expression is case-sensitive. See more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] canonical_filter
@@ -105,7 +102,9 @@ module Google
         #   @return [::String]
         #     The order in which products are returned. Products can be ordered by
         #     a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
-        #     unset if ordered by relevance. OrderBy expression is case-sensitive.
+        #     unset if ordered by relevance. OrderBy expression is case-sensitive. See
+        #     more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/filter-and-order#order).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] facet_specs
@@ -119,16 +118,23 @@ module Google
         #     The specification for dynamically generated facets. Notice that only
         #     textual facets can be dynamically generated.
         #
-        #     This feature requires additional allowlisting. Contact Retail Support
-        #     (retail-search-support@google.com) if you are interested in using dynamic
-        #     facet feature.
+        #     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.
+        #     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.
         # @!attribute [rw] query_expansion_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
-        #     query expansion will occur.
+        #     query expansion will occur. See more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
         # @!attribute [rw] variant_rollup_keys
         #   @return [::Array<::String>]
         #     The keys to fetch and rollup the matching
@@ -140,10 +146,9 @@ module Google
         #     {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
         #     query latency. Maximum number of keys is 10.
         #
-        #     For
-        #     {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info},
-        #     a fulfillment type and a fulfillment ID must be provided in the format of
-        #     "fulfillmentType.filfillmentId". E.g., in "pickupInStore.store123",
+        #     For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
+        #     fulfillment type and a fulfillment ID must be provided in the format of
+        #     "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",
         #     "pickupInStore" is fulfillment type and "store123" is the store ID.
         #
         #     Supported keys are:
@@ -152,26 +157,45 @@ module Google
         #     * price
         #     * originalPrice
         #     * discount
+        #     * inventory(place_id,price)
         #     * attributes.key, where key is any key in the
         #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
-        #     * pickupInStore.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.PICKUP_IN_STORE][].
-        #     * shipToStore.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.SHIP_TO_STORE][].
-        #     * sameDayDelivery.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.SAME_DAY_DELIVERY][].
-        #     * nextDayDelivery.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][].
-        #     * customFulfillment1.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.CUSTOM_TYPE_1][].
-        #     * customFulfillment2.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.CUSTOM_TYPE_2][].
-        #     * customFulfillment3.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.CUSTOM_TYPE_3][].
-        #     * customFulfillment4.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.CUSTOM_TYPE_4][].
-        #     * customFulfillment5.id, where id is any [FulfillmentInfo.ids][] for type
-        #       [FulfillmentInfo.Type.CUSTOM_TYPE_5][].
+        #     * pickupInStore.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "pickup-in-store".
+        #     * shipToStore.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "ship-to-store".
+        #     * sameDayDelivery.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "same-day-delivery".
+        #     * nextDayDelivery.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "next-day-delivery".
+        #     * customFulfillment1.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "custom-type-1".
+        #     * customFulfillment2.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "custom-type-2".
+        #     * customFulfillment3.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "custom-type-3".
+        #     * customFulfillment4.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "custom-type-4".
+        #     * customFulfillment5.id, where id is any
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+        #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+        #       "custom-type-5".
         #
         #     If this field is set to an invalid value other than these, an
         #     INVALID_ARGUMENT error is returned.
@@ -189,6 +213,10 @@ module Google
         #     Category pages include special pages such as sales or promotions. For
         #     instance, a special sale page may have the category hierarchy:
         #     "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+        # @!attribute [rw] search_mode
+        #   @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.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -269,35 +297,36 @@ module Google
             #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#query FacetKey.query}
             #     is not specified:
             #
-            #     Textual facet keys:
-            #     * brands
-            #     * categories
-            #     * genders
-            #     * ageGroups
-            #     * availability
-            #     * colorFamilies
-            #     * colors
-            #     * sizes
-            #     * materials
-            #     * patterns
-            #     * conditions
-            #     * attributes.key
-            #     * pickupInStore
-            #     * shipToStore
-            #     * sameDayDelivery
-            #     * nextDayDelivery
-            #     * customFulfillment1
-            #     * customFulfillment2
-            #     * customFulfillment3
-            #     * customFulfillment4
-            #     * customFulfillment5
+            #     * textual_field =
+            #         * "brands"
+            #         * "categories"
+            #         * "genders"
+            #         * "ageGroups"
+            #         * "availability"
+            #         * "colorFamilies"
+            #         * "colors"
+            #         * "sizes"
+            #         * "materials"
+            #         * "patterns"
+            #         * "conditions"
+            #         * "attributes.key"
+            #         * "pickupInStore"
+            #         * "shipToStore"
+            #         * "sameDayDelivery"
+            #         * "nextDayDelivery"
+            #         * "customFulfillment1"
+            #         * "customFulfillment2"
+            #         * "customFulfillment3"
+            #         * "customFulfillment4"
+            #         * "customFulfillment5"
             #
-            #     Numeric facet keys:
-            #     * price
-            #     * discount
-            #     * rating
-            #     * ratingCount
-            #     * attributes.key
+            #     * numerical_field =
+            #         * "price"
+            #         * "discount"
+            #         * "rating"
+            #         * "ratingCount"
+            #         * "attributes.key"
+            #         * "inventory(place_id,price)"
             # @!attribute [rw] intervals
             #   @return [::Array<::Google::Cloud::Retail::V2::Interval>]
             #     Set only if values should be bucketized into intervals. Must be set
@@ -361,7 +390,8 @@ module Google
             #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
             #     intervals are sorted in the order given by
             #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals};
-            #     [FulfillmentInfo.ids][] are sorted in the order given by
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     are sorted in the order given by
             #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#restricted_values FacetSpec.FacetKey.restricted_values}.
             # @!attribute [rw] query
             #   @return [::String]
@@ -437,12 +467,10 @@ module Google
             #     Examples:
             #
             #     * To boost products with product ID "product_1" or "product_2", and
-            #     color "Red" or "Blue":
-            #       ```
-            #       (id: ANY("product_1", "product_2"))
-            #       AND
-            #       (colorFamilies: ANY("Red", "Blue"))
-            #       ```
+            #     color
+            #       "Red" or "Blue":
+            #         * (id: ANY("product_1", "product_2")) AND (colorFamilies:
+            #         ANY("Red","Blue"))
             # @!attribute [rw] boost
             #   @return [::Float]
             #     Strength of the condition boost, which should be in [-1, 1]. Negative
@@ -474,6 +502,11 @@ module Google
           #   @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition]
           #     The condition under which query expansion should occur. Default to
           #     {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
+          # @!attribute [rw] pin_unexpanded_results
+          #   @return [::Boolean]
+          #     Whether to pin unexpanded results. If this field is set to true,
+          #     unexpanded products are always at the top of the search results, followed
+          #     by the expanded results.
           class QueryExpansionSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -493,6 +526,35 @@ module Google
               AUTO = 3
             end
           end
+
+          # The search mode of each search request.
+          module SearchMode
+            # Default value. In this case both product search and faceted search will
+            # be performed. Both [SearchResponse.SearchResult] and
+            # [SearchResponse.Facet] will be returned.
+            SEARCH_MODE_UNSPECIFIED = 0
+
+            # Only product search will be performed. The faceted search will be
+            # disabled.
+            #
+            # Only [SearchResponse.SearchResult] will be returned.
+            # [SearchResponse.Facet] will not be returned, even if
+            # {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
+            # or
+            # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
+            # is set.
+            PRODUCT_SEARCH_ONLY = 1
+
+            # Only faceted search will be performed. The product search will be
+            # disabled.
+            #
+            # When in this mode, one or both of [SearchRequest.facet_spec][] 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]
+            # will not be returned.
+            FACETED_SEARCH_ONLY = 2
+          end
         end
 
         # Response message for
@@ -605,10 +667,9 @@ module Google
           #           }
           #         }
           #
-          #     For
-          #     {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info},
-          #     the rollup values is a double value with type
-          #     {::Google::Protobuf::Value google.protobuf.Value}. For example:
+          #     For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, the rollup
+          #     values is a double value with type
+          #     {::Google::Protobuf::Value google.protobuf.Value}. For example,
           #     `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
           #     are 10 variants in this product are available in the store "store1".
           class SearchResult
@@ -670,6 +731,12 @@ module Google
           # @!attribute [rw] expanded_query
           #   @return [::Boolean]
           #     Bool describing whether query expansion has occurred.
+          # @!attribute [rw] pinned_result_count
+          #   @return [::Integer]
+          #     Number of pinned results. This field will only be set when expansion
+          #     happens and
+          #     {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
+          #     is set to true.
           class QueryExpansionInfo
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -110,12 +110,12 @@ module Google
         #     * `purchase-complete`
         #
         #     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 broswing the
+        #     user on the current page (the end user may have not finished browsing the
         #     whole page yet). When a new page is returned to the end user, after
         #     pagination/filtering/ordering even for the same query, a new `search` event
         #     with different
         #     {::Google::Cloud::Retail::V2::UserEvent#product_details product_details} is
-        #     desired. The end user may have not finished broswing the whole page yet.
+        #     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.
@@ -136,7 +136,7 @@ module Google
         #     search, and etc.
         # @!attribute [rw] cart_id
         #   @return [::String]
-        #     The id or name of the associated shopping cart. This id is used
+        #     The ID or name of the associated shopping cart. This ID is used
         #     to associate multiple items added or present in the cart before purchase.
         #
         #     This can only be set for `add-to-cart`, `purchase-complete`, or
@@ -231,7 +231,7 @@ module Google
         #     Tag Manager, this value is filled in automatically.
         # @!attribute [rw] page_view_id
         #   @return [::String]
-        #     A unique id of a web page view.
+        #     A unique ID of a web page view.
         #
         #     This should be kept the same for all user events triggered from the same
         #     pageview. For example, an item detail page view could trigger multiple
@@ -260,9 +260,21 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::Product]
         #     Required. {::Google::Cloud::Retail::V2::Product Product} information.
         #
-        #     Only {::Google::Cloud::Retail::V2::Product#id Product.id} field is used when
-        #     ingesting an event, all other product fields are ignored as we will look
-        #     them up from the catalog.
+        #     Required field(s):
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#id Product.id}
+        #
+        #     Optional override field(s):
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
+        #
+        #     If any supported optional fields are provided, we will treat them as a full
+        #     override when looking up product information from the catalog. Thus, it is
+        #     important to ensure that the overriding fields are accurate and
+        #     complete.
+        #
+        #     All other product fields are ignored and instead populated via catalog
+        #     lookup after event ingestion.
         # @!attribute [rw] quantity
         #   @return [::Google::Protobuf::Int32Value]
         #     Quantity of the product associated with the user event.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common