google-apis-retail_v2 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7026215dee691483ee2220eea2f1b0925c01316973a526ee493dddc65252ccc
-  data.tar.gz: 2a09466d24ed7c69217c82db15ec62af850dadc841e47b0257fd3a2441da5b66
+  metadata.gz: 233478bb57c972e6f2f535ddfbcee72ebfc4052f5de8d79afc73db1f26b3cb15
+  data.tar.gz: 63088218281dafba204bea53192f5b6d10982c22b2a07c0f84c405dc9a12bc60
 SHA512:
-  metadata.gz: a648d9b561aa369bb0c0fdc189a64a95df5c205f35d3904e7e3b7c2391782d0b2bf8fdb653eb035b8ea4e066eefa00ab68b97de5f727106b01461275e8066ad8
-  data.tar.gz: 38c5765a7e13b5ce937559f351409a4e170bd4ed1f47ce29fdedfb25a26b92a5dd3b9a933ab9cb78afff6bd8891e9e6c1eabf60f0051b0ce77a0dc2c69bd2c9e
+  metadata.gz: 035f15cd06ef6bacb052c352f15e427d4372dbe9d6f8e90c2276062716a6827418932d86839d47359eeeb09b7dc165da57b49e806ca72ba18687e7557acbe0c1
+  data.tar.gz: 1269c8a22f73067dc09a72cbc04b3af2432874caa37c9471c97f2cc7ecfe869e620cb1db15ea0e08f2e94f6df34965b8112969e23bcda0d6f6ce6e1863c960ed

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.32.0 (2022-03-24)
+
+* Regenerated from discovery document revision 20220319
+
 ### v0.31.0 (2022-03-16)
 
 * Regenerated from discovery document revision 20220310

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

@@ -416,7 +416,9 @@ module Google
         # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
         # preview. Please contact the support team for importing Google Analytics 4
         # events. The schema is available here: https://support.google.com/analytics/
-        # answer/7029846.
+        # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
+        # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
+        # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
@@ -552,9 +554,9 @@ module Google
       class GoogleCloudRetailV2CompleteQueryResponse
         include Google::Apis::Core::Hashable
       
-        # A unique complete token. This should be included in the SearchRequest
-        # resulting from this completion, which enables accurate attribution of complete
-        # model performance.
+        # A unique complete token. This should be included in the UserEvent.
+        # completion_detail for search events resulting from this completion, which
+        # enables accurate attribution of complete model performance.
         # Corresponds to the JSON property `attributionToken`
         # @return [String]
         attr_accessor :attribution_token
@@ -594,7 +596,9 @@ module Google
       class GoogleCloudRetailV2CompleteQueryResponseCompletionResult
         include Google::Apis::Core::Hashable
       
-        # Additional custom attributes ingested through BigQuery.
+        # Custom attributes for the suggestion term. * For "user-data", the attributes
+        # are additional custom attributes ingested through BigQuery. * For "cloud-
+        # retail", the attributes are product attributes generated by Cloud Retail.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
         attr_accessor :attributes
@@ -980,8 +984,7 @@ module Google
         # @return [String]
         attr_accessor :notification_pubsub_topic
       
-        # Id of the request / operation. This is parroting back the requestId that was
-        # passed in the request.
+        # Deprecated. This field is never set.
         # Corresponds to the JSON property `requestId`
         # @return [String]
         attr_accessor :request_id
@@ -1041,11 +1044,7 @@ module Google
         # @return [String]
         attr_accessor :reconciliation_mode
       
-        # Unique identifier provided by client, within the ancestor dataset scope.
-        # Ensures idempotency and used for request deduplication. Server-generated if
-        # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
-        # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
-        # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
+        # Deprecated. This field has no effect.
         # Corresponds to the JSON property `requestId`
         # @return [String]
         attr_accessor :request_id
@@ -3744,8 +3743,7 @@ module Google
         # @return [String]
         attr_accessor :notification_pubsub_topic
       
-        # Id of the request / operation. This is parroting back the requestId that was
-        # passed in the request.
+        # Deprecated. This field is never set.
         # Corresponds to the JSON property `requestId`
         # @return [String]
         attr_accessor :request_id
@@ -4282,8 +4280,7 @@ module Google
         # @return [String]
         attr_accessor :notification_pubsub_topic
       
-        # Id of the request / operation. This is parroting back the requestId that was
-        # passed in the request.
+        # Deprecated. This field is never set.
         # Corresponds to the JSON property `requestId`
         # @return [String]
         attr_accessor :request_id
@@ -4617,8 +4614,7 @@ module Google
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
-      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
-      # `Empty` is empty JSON object ````.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
       class GoogleProtobufEmpty
         include Google::Apis::Core::Hashable
       

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.31.0"
+      GEM_VERSION = "0.32.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220310"
+      REVISION = "20220319"
     end
   end
 end

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

@@ -723,9 +723,11 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Bulk import of processed completion dataset. Request processing may be
-        # synchronous. Partial updating is not supported. This feature is only available
-        # for users who have Retail Search enabled. Please submit a form [here](https://
+        # Bulk import of processed completion dataset. Request processing is
+        # asynchronous. Partial updating is not supported. The operation is successfully
+        # finished only after the imported suggestions are indexed successfully and
+        # ready for serving. The process takes hours. This feature is only available for
+        # users who have Retail Search enabled. Please submit a form [here](https://
         # cloud.google.com/contact) to contact cloud sales if you are interested in
         # using Retail Search.
         # @param [String] parent
@@ -841,7 +843,8 @@ 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
+        #   catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
+        #   catalogs/default_catalog/servingConfigs/*` 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).
@@ -882,9 +885,10 @@ module Google
         # to contact cloud sales if you are interested in using Retail Search.
         # @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.
+        #   /locations/global/catalogs/default_catalog/placements/default_search` or `
+        #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
+        #   default_serving_config` 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::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -915,6 +919,85 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Makes a recommendation prediction.
+        # @param [String] placement
+        #   Required. Full resource name of the format: `name=projects/*/locations/global/
+        #   catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
+        #   catalogs/default_catalog/servingConfigs/*` 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
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_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::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
+        #
+        # @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_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+placement}:predict', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
+          command.request_object = google_cloud_retail_v2_predict_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
+          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
+        
+        # Performs a search. This feature is only available for users who have Retail
+        # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
+        # to contact cloud sales if you are interested in using Retail Search.
+        # @param [String] placement
+        #   Required. The resource name of the search engine placement, such as `projects/*
+        #   /locations/global/catalogs/default_catalog/placements/default_search` or `
+        #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
+        #   default_serving_config` 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::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_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::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
+        #
+        # @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_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+placement}:search', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
+          command.request_object = google_cloud_retail_v2_search_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
+          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_v2
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.31.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.32.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []