google-cloud-retail-v2 0.20.0 → 1.0.0

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

@@ -30,7 +30,7 @@ module Google
         #     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 config name and the set
-        #     of models that will be used to make the search.
+        #     of models that are used to make the search.
         # @!attribute [rw] branch
         #   @return [::String]
         #     The branch resource name, such as
@@ -93,8 +93,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. See more details at this [user
-        #     guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
+        #     expression is case-sensitive. For more information, see
+        #     [Filter](https://cloud.google.com/retail/docs/filter-and-order#filter).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] canonical_filter
@@ -103,21 +103,21 @@ module Google
         #     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
-        #     {::Google::Cloud::Retail::V2::SearchRequest#canonical_filter SearchRequest.canonical_filter}
-        #     will be returned as a supplement of the original query. This field is
-        #     strongly recommended to achieve high search quality.
+        #     query expansion is needed. In the case a query does not have a sufficient
+        #     amount of results this filter will be used to determine whether or not to
+        #     enable the query expansion flow. The original filter will still be used for
+        #     the query expanded search.
+        #     This field is strongly recommended to achieve high search quality.
         #
-        #     See {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter} for
-        #     more details about filter syntax.
+        #     For more information about filter syntax, see
+        #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
         # @!attribute [rw] order_by
         #   @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. See
-        #     more details at this [user
-        #     guide](https://cloud.google.com/retail/docs/filter-and-order#order).
+        #     unset if ordered by relevance. OrderBy expression is case-sensitive. For
+        #     more information, see
+        #     [Order](https://cloud.google.com/retail/docs/filter-and-order#order).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] facet_specs
@@ -136,8 +136,8 @@ module Google
         #     textual facets can be dynamically generated.
         # @!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).
+        #     Boost specification to boost certain products. For more information, see
+        #     [Boost results](https://cloud.google.com/retail/docs/boosting).
         #
         #     Notice that if both
         #     {::Google::Cloud::Retail::V2::ServingConfig#boost_control_ids ServingConfig.boost_control_ids}
@@ -149,8 +149,8 @@ module Google
         # @!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. See more details at this [user
-        #     guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
+        #     query expansion occurs. For more information, see [Query
+        #     expansion](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
@@ -225,7 +225,7 @@ module Google
         #     INVALID_ARGUMENT error is returned.
         # @!attribute [rw] page_categories
         #   @return [::Array<::String>]
-        #     The categories associated with a category page. Required for category
+        #     The categories associated with a category page. Must be set for category
         #     navigation queries to achieve good search quality. The format should be
         #     the same as
         #     {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
@@ -269,9 +269,9 @@ module Google
         #       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.
+        #     For more information, see [Requirements for
+        #     labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     in the Resource Manager documentation.
         # @!attribute [rw] spell_correction_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec]
         #     The spell correction specification that specifies the mode under
@@ -333,15 +333,15 @@ module Google
           #   @return [::Boolean]
           #     Enables dynamic position for this facet. If set to true, the position of
           #     this facet among all facets in the response is determined by Google
-          #     Retail Search. It will be ordered together with dynamic facets if dynamic
+          #     Retail Search. It is ordered together with dynamic facets if dynamic
           #     facets is enabled. If set to false, the position of this facet in the
-          #     response will be the same as in the request, and it will be ranked before
+          #     response is the same as in the request, and it is ranked before
           #     the facets with dynamic position enable and all dynamic facets.
           #
           #     For example, you may always want to have rating facet returned in
           #     the response, but it's not necessarily to always display the rating facet
           #     at the top. In that case, you can set enable_dynamic_position to true so
-          #     that the position of rating facet in response will be determined by
+          #     that the position of rating facet in response is determined by
           #     Google Retail Search.
           #
           #     Another example, assuming you have the following facets in the request:
@@ -352,13 +352,13 @@ module Google
           #
           #     * "brands", enable_dynamic_position = false
           #
-          #     And also you have a dynamic facets enable, which will generate a facet
-          #     'gender'. Then the final order of the facets in the response can be
+          #     And also you have a dynamic facets enable, which generates a facet
+          #     "gender". Then, the final order of the facets in the response can be
           #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
           #     "rating") depends on how Google Retail Search orders "gender" and
-          #     "rating" facets. However, notice that "price" and "brands" will always be
-          #     ranked at 1st and 2nd position since their enable_dynamic_position are
-          #     false.
+          #     "rating" facets. However, notice that "price" and "brands" are always
+          #     ranked at first and second position because their enable_dynamic_position
+          #     values are false.
           class FacetSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -414,13 +414,13 @@ module Google
             #     values. Maximum number of intervals is 40.
             #
             #     For all numerical facet keys that appear in the list of products from
-            #     the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are
+            #     the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are
             #     computed from their distribution weekly. If the model assigns a high
             #     score to a numerical facet key and its intervals are not specified in
-            #     the search request, these percentiles will become the bounds
-            #     for its intervals and will be returned in the response. If the
+            #     the search request, these percentiles become the bounds
+            #     for its intervals and are returned in the response. If the
             #     facet key intervals are specified in the request, then the specified
-            #     intervals will be returned instead.
+            #     intervals are returned instead.
             # @!attribute [rw] restricted_values
             #   @return [::Array<::String>]
             #     Only get facet for the given restricted values. For example, when using
@@ -453,14 +453,14 @@ module Google
             #     Only get facet values that start with the given string prefix. For
             #     example, suppose "categories" has three values "Women > Shoe",
             #     "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the
-            #     "categories" facet will give only "Women > Shoe" and "Women > Dress".
+            #     "categories" facet gives only "Women > Shoe" and "Women > Dress".
             #     Only supported on textual fields. Maximum is 10.
             # @!attribute [rw] contains
             #   @return [::Array<::String>]
             #     Only get facet values that contains the given strings. For example,
             #     suppose "categories" has three values "Women > Shoe",
             #     "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the
-            #     "categories" facet will give only "Women > Shoe" and "Men > Shoe".
+            #     "categories" facet gives only "Women > Shoe" and "Men > Shoe".
             #     Only supported on textual fields. Maximum is 10.
             # @!attribute [rw] case_insensitive
             #   @return [::Boolean]
@@ -493,7 +493,7 @@ module Google
             # @!attribute [rw] query
             #   @return [::String]
             #     The query that is used to compute facet for the given facet key.
-            #     When provided, it will override the default behavior of facet
+            #     When provided, it overrides the default behavior of facet
             #     computation. The query syntax is the same as a filter expression. See
             #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter} for
             #     detail syntax and limitations. Notice that there is no limitation on
@@ -502,9 +502,9 @@ module Google
             #
             #     In the response,
             #     {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
-            #     will be always "1" and
+            #     is 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.
+            #     is the number of results that match the query.
             #
             #     For example, you can set a customized facet for "shipToStore",
             #     where
@@ -512,7 +512,7 @@ module Google
             #     is "customizedShipToStore", and
             #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#query FacetKey.query}
             #     is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")".
-            #     Then the facet will count the products that are both in stock and ship
+            #     Then the facet counts the products that are both in stock and ship
             #     to store "123".
             # @!attribute [rw] return_min_max
             #   @return [::Boolean]
@@ -970,7 +970,7 @@ module Google
           end
         end
 
-        # Metadata for active A/B testing [Experiments][].
+        # Metadata for active A/B testing [Experiment][].
         # @!attribute [rw] serving_config_experiment
         #   @return [::Google::Cloud::Retail::V2::ExperimentInfo::ServingConfigExperiment]
         #     A/B test between existing Cloud Retail Search
@@ -994,8 +994,8 @@ module Google
           # @!attribute [rw] experiment_serving_config
           #   @return [::String]
           #     The fully qualified resource name of the serving config
-          #     [VariantArm.serving_config_id][] responsible for generating the search
-          #     response. For example:
+          #     [Experiment.VariantArm.serving_config_id][] responsible for generating
+          #     the search response. For example:
           #     `projects/*/locations/*/catalogs/*/servingConfigs/*`.
           class ServingConfigExperiment
             include ::Google::Protobuf::MessageExts

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

@@ -213,6 +213,10 @@ module Google
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
         #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        # @!attribute [rw] ignore_recs_denylist
+        #   @return [::Boolean]
+        #     When the flag is enabled, the products in the denylist will not be filtered
+        #     out in the recommendation filtering results.
         # @!attribute [rw] personalization_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec]
         #     The specification for personalization spec.

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

@@ -28,6 +28,7 @@ module Google
         #     Required. User event type. Allowed values are:
         #
         #     * `add-to-cart`: Products being added to cart.
+        #     * `remove-from-cart`: Products being removed from cart.
         #     * `category-page-view`: Special pages such as sale or promotion pages
         #       viewed.
         #     * `detail-page-view`: Products detail page viewed.
@@ -262,8 +263,8 @@ module Google
         #     The entity for customers that may run multiple different entities, domains,
         #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
         #     `google.com`, `youtube.com`, etc.
-        #     It is recommended to set this field to get better per-entity search,
-        #     completion and prediction results.
+        #     We recommend that you set this field to get better per-entity search,
+        #     completion, and prediction results.
         class UserEvent
           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.20.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -250,7 +250,8 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
-summary: Cloud Retail service enables customers to build end-to-end personalized recommendation
-  systems without requiring a high level of expertise in machine learning, recommendation
-  system, or Google Cloud.
+summary: Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations.
+  These discovery AI solutions help you implement personalized search, browse and
+  recommendations, based on machine learning models, across your websites and mobile
+  applications.
 test_files: []