google-apis-retail_v2alpha 0.43.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d9d8cdfedc9dac5ab682e091678633706bd1f238ed7552272d156037f38411
-  data.tar.gz: e8783a3ce3702a4074f13e2ae9fdcc483744d24880c3e3d5f8707c391cb67d41
+  metadata.gz: 64a427f5a6e48062fd4037b102518525f364246731a9f47c0de21a6a36fbd172
+  data.tar.gz: '0364182dd92a137a753202ab45dbe87de8273420b53626418003e44da13e2945'
 SHA512:
-  metadata.gz: 4960907a05097a6e1a44904d97c5b51e4ad02edefada1b0da53bfa50ece6919c679c44214c3bea4ed74335d446170079e53f1d29b3cd64f69a9822270a94b77e
-  data.tar.gz: 1b2e6093e79495fc1004ce53df173c2df605201f72d05bfd945cc7f9d2803fa3f8d42d93eecf5e3077da9317474f510902a5ad96bb79c7a4b7d1e5008048dab7
+  metadata.gz: 16a0999e673d0a757d481125d755c81f783ed5fcce0f582139c6022f4eaa45c715c1a3b8ac13b83f3b6b53a88cc5f55024c0fb6c7dd42c6d2aef3b59bf15c295
+  data.tar.gz: 38b4c0cd7965479a02eaa50cb01ce1153d8a085ffefd0471483a4f73b57a4082d5c7ff9d5ee60d0d893f38d935a2fe0c297eec022dbf61638e8f9994313ad889

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.46.0 (2022-07-01)
+
+* Regenerated from discovery document revision 20220623
+* Regenerated using generator version 0.8.0
+
+### v0.45.0 (2022-06-23)
+
+* Regenerated from discovery document revision 20220617
+* Regenerated using generator version 0.7.0
+
+### v0.44.0 (2022-06-14)
+
+* Regenerated from discovery document revision 20220609
+* Regenerated using generator version 0.6.0
+
 ### v0.43.0 (2022-06-07)
 
 * Regenerated from discovery document revision 20220602

data/lib/google/apis/retail_v2alpha/classes.rb

@@ -1108,11 +1108,22 @@ module Google
         attr_accessor :indexable_option
       
         # Required. Attribute name. For example: `color`, `brands`, `attributes.
-        # custom_attribute`, such as `attributes.xyz`.
+        # custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
+        # name can contain only alpha-numeric characters and underscores. For example,
+        # an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
+        # `attributes.abc-xyz` cannot be indexed.
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
       
+        # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
+        # if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for
+        # recommendations. This option works for categorical features only, does not
+        # work for numerical features, inventory filtering.
+        # Corresponds to the JSON property `recommendationsFilteringOption`
+        # @return [String]
+        attr_accessor :recommendations_filtering_option
+      
         # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
         # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
         # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
@@ -1138,6 +1149,7 @@ module Google
           @in_use = args[:in_use] if args.key?(:in_use)
           @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
           @key = args[:key] if args.key?(:key)
+          @recommendations_filtering_option = args[:recommendations_filtering_option] if args.key?(:recommendations_filtering_option)
           @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
           @type = args[:type] if args.key?(:type)
         end
@@ -1297,14 +1309,16 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
         attr_accessor :denylist_input_config
       
-        # Output only. LRO corresponding to the latest allowlist import. Can use
-        # GetOperation API to retrieve the latest state of the Long Running Operation.
+        # Output only. Name of the LRO corresponding to the latest allowlist import. Can
+        # use GetOperation API to retrieve the latest state of the Long Running
+        # Operation.
         # Corresponds to the JSON property `lastAllowlistImportOperation`
         # @return [String]
         attr_accessor :last_allowlist_import_operation
       
-        # Output only. LRO corresponding to the latest denylist import. Can use
-        # GetOperation API to retrieve the latest state of the Long Running Operation.
+        # Output only. Name of the LRO corresponding to the latest denylist import. Can
+        # use GetOperation API to retrieve the latest state of the Long Running
+        # Operation.
         # Corresponds to the JSON property `lastDenylistImportOperation`
         # @return [String]
         attr_accessor :last_denylist_import_operation
@@ -2459,7 +2473,11 @@ module Google
         # only want results strictly matching the filters, set `strictFiltering` to True
         # in `PredictRequest.params` to receive empty results instead. Note that the API
         # will never return items with storageStatus of "EXPIRED" or "DELETED"
-        # regardless of filter choices.
+        # 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"))
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2508,7 +2526,9 @@ module Google
         # price. * `diversityLevel`: String. Default empty. If set to be non-empty, then
         # it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
         # high-diversity', 'auto-diversity'`. This gives request-level control and
-        # adjusts prediction results based on product category.
+        # adjusts prediction results based on product category. * `filterSyntaxV2`:
+        # Boolean. False by default. If set to true, the `filter` field will be
+        # interpreteted according to the new, attribute-based syntax.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -4479,8 +4499,8 @@ module Google
       class GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
         include Google::Apis::Core::Hashable
       
-        # Whether to make facet keys case insensitive when getting faceting values with
-        # prefixes or contains.
+        # True to make facet keys case insensitive when getting faceting values with
+        # prefixes or contains; false otherwise.
         # Corresponds to the JSON property `caseInsensitive`
         # @return [Boolean]
         attr_accessor :case_insensitive

data/lib/google/apis/retail_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.43.0"
+      GEM_VERSION = "0.46.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.5.0"
+      GENERATOR_VERSION = "0.8.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220602"
+      REVISION = "20220623"
     end
   end
 end

data/lib/google/apis/retail_v2alpha/representations.rb

@@ -1358,6 +1358,7 @@ module Google
           property :in_use, as: 'inUse'
           property :indexable_option, as: 'indexableOption'
           property :key, as: 'key'
+          property :recommendations_filtering_option, as: 'recommendationsFilteringOption'
           property :searchable_option, as: 'searchableOption'
           property :type, as: 'type'
         end

data/lib/google/apis/retail_v2alpha/service.rb

@@ -1419,13 +1419,16 @@ module Google
         
         # Makes a recommendation prediction.
         # @param [String] placement
-        #   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
+        #   Required. Full resource name of the format: `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 [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1460,10 +1463,12 @@ module Google
         # Search enabled. Please enable Retail Search on Cloud Console before using this
         # feature.
         # @param [String] placement
-        #   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 serving configuration name and the set of models
-        #   that will be used to make the search.
+        #   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.
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1718,6 +1723,48 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Makes a recommendation prediction.
+        # @param [String] placement
+        #   Required. Full resource name of the format: `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 [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_predict_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
+          command.params['placement'] = placement unless placement.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Disables a Control on the specified ServingConfig. The control is removed from
         # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
         # the ServingConfig.
@@ -1755,6 +1802,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Performs a search. This feature is only available for users who have Retail
+        # Search enabled. Please enable Retail Search on Cloud Console before using this
+        # feature.
+        # @param [String] placement
+        #   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.
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_search_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
+          command.params['placement'] = placement unless placement.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Writes a single user event from the browser. This uses a GET request to due to
         # browser restriction of POST-ing to a 3rd party domain. This method is used
         # only by the Retail API JavaScript pixel and Google Tag Manager. Users should

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.43.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.46.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []