google-apis-retail_v2alpha 0.33.0 → 0.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 28c4b9d5bc9ab2434afee8a37fc05065f33e4c1f877cdbc49c66842ce818531d
4
- data.tar.gz: 586c391c1b0770ee1add05161217fa51b71fe15949f03c489c0d15a1cd861ffd
3
+ metadata.gz: 82ba0873fffb5177af7796136383999137f3b300d93113a3a7d1079250df1ffb
4
+ data.tar.gz: 6e886f2d384917a8aeb825cfe1e0dd117888eaf1ed5c7ff8bd10a4c7dea8f2d0
5
5
  SHA512:
6
- metadata.gz: 8c6f8ac592b5a64f5ddd5611412c337c6230aa21dd2e03613ff379f286a7dd7bae87131dad3a07fa0ffcf180381e99f46d34c3490587c921f2353044bfe5fa0a
7
- data.tar.gz: 7a129795a38abcc73706846069990a9bae357a873e339f907ec2d75b82b53f156476b25092bf345a931d4501491f3a9d349087a3486c027910ef9661881614b3
6
+ metadata.gz: e5f285306766885d90316c1674eab733c87737d18dc830c879e54eacd7fbb6c4ba19acaac0ee99fa295eb1ce2ed561eaddf39e3d1e3cd425aa15d114c7e43261
7
+ data.tar.gz: e3492014caaee1ebc2cecdd16a23a1b7b279452b13747103861f60620f504d47e82686c9b73ab29b7d0f72ace525825fc7ec99f17b5844b4257169141d6945da
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.34.0 (2022-03-24)
4
+
5
+ * Regenerated from discovery document revision 20220319
6
+
3
7
  ### v0.33.0 (2022-03-16)
4
8
 
5
9
  * Regenerated from discovery document revision 20220310
@@ -373,8 +373,7 @@ module Google
373
373
  # @return [String]
374
374
  attr_accessor :notification_pubsub_topic
375
375
 
376
- # Id of the request / operation. This is parroting back the requestId that was
377
- # passed in the request.
376
+ # Deprecated. This field is never set.
378
377
  # Corresponds to the JSON property `requestId`
379
378
  # @return [String]
380
379
  attr_accessor :request_id
@@ -911,7 +910,9 @@ module Google
911
910
  # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
912
911
  # preview. Please contact the support team for importing Google Analytics 4
913
912
  # events. The schema is available here: https://support.google.com/analytics/
914
- # answer/7029846.
913
+ # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
914
+ # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
915
+ # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
915
916
  # Corresponds to the JSON property `dataSchema`
916
917
  # @return [String]
917
918
  attr_accessor :data_schema
@@ -1123,9 +1124,9 @@ module Google
1123
1124
  class GoogleCloudRetailV2alphaCompleteQueryResponse
1124
1125
  include Google::Apis::Core::Hashable
1125
1126
 
1126
- # A unique complete token. This should be included in the SearchRequest
1127
- # resulting from this completion, which enables accurate attribution of complete
1128
- # model performance.
1127
+ # A unique complete token. This should be included in the UserEvent.
1128
+ # completion_detail for search events resulting from this completion, which
1129
+ # enables accurate attribution of complete model performance.
1129
1130
  # Corresponds to the JSON property `attributionToken`
1130
1131
  # @return [String]
1131
1132
  attr_accessor :attribution_token
@@ -1165,7 +1166,9 @@ module Google
1165
1166
  class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
1166
1167
  include Google::Apis::Core::Hashable
1167
1168
 
1168
- # Additional custom attributes ingested through BigQuery.
1169
+ # Custom attributes for the suggestion term. * For "user-data", the attributes
1170
+ # are additional custom attributes ingested through BigQuery. * For "cloud-
1171
+ # retail", the attributes are product attributes generated by Cloud Retail.
1169
1172
  # Corresponds to the JSON property `attributes`
1170
1173
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
1171
1174
  attr_accessor :attributes
@@ -1205,6 +1208,103 @@ module Google
1205
1208
  end
1206
1209
  end
1207
1210
 
1211
+ # Catalog level autocomplete config for customers to customize autocomplete
1212
+ # feature's settings.
1213
+ class GoogleCloudRetailV2alphaCompletionConfig
1214
+ include Google::Apis::Core::Hashable
1215
+
1216
+ # The input config source for completion data.
1217
+ # Corresponds to the JSON property `allowlistInputConfig`
1218
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1219
+ attr_accessor :allowlist_input_config
1220
+
1221
+ # If set to true, the auto learning function is enabled. Auto learning uses user
1222
+ # data to generate suggestions using ML techniques. Default value is false. Only
1223
+ # after enabling auto learning can users use `cloud-retail` data in
1224
+ # CompleteQueryRequest.
1225
+ # Corresponds to the JSON property `autoLearning`
1226
+ # @return [Boolean]
1227
+ attr_accessor :auto_learning
1228
+ alias_method :auto_learning?, :auto_learning
1229
+
1230
+ # The input config source for completion data.
1231
+ # Corresponds to the JSON property `denylistInputConfig`
1232
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1233
+ attr_accessor :denylist_input_config
1234
+
1235
+ # Output only. LRO corresponding to the latest allowlist import. Can use
1236
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1237
+ # Corresponds to the JSON property `lastAllowlistImportOperation`
1238
+ # @return [String]
1239
+ attr_accessor :last_allowlist_import_operation
1240
+
1241
+ # Output only. LRO corresponding to the latest denylist import. Can use
1242
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1243
+ # Corresponds to the JSON property `lastDenylistImportOperation`
1244
+ # @return [String]
1245
+ attr_accessor :last_denylist_import_operation
1246
+
1247
+ # Output only. Name of the LRO corresponding to the latest suggestion terms list
1248
+ # import. Can use GetOperation API to retrieve the latest state of the Long
1249
+ # Running Operation.
1250
+ # Corresponds to the JSON property `lastSuggestionsImportOperation`
1251
+ # @return [String]
1252
+ attr_accessor :last_suggestions_import_operation
1253
+
1254
+ # Specifies the matching order for autocomplete suggestions, e.g., a query
1255
+ # consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
1256
+ # whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
1257
+ # shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
1258
+ # value: 'exact-prefix'.
1259
+ # Corresponds to the JSON property `matchingOrder`
1260
+ # @return [String]
1261
+ attr_accessor :matching_order
1262
+
1263
+ # The maximum number of autocomplete suggestions returned per term. The maximum
1264
+ # allowed max suggestions is 20. Default value is 20. If left unset or set to 0,
1265
+ # then will fallback to default value.
1266
+ # Corresponds to the JSON property `maxSuggestions`
1267
+ # @return [Fixnum]
1268
+ attr_accessor :max_suggestions
1269
+
1270
+ # The minimum number of characters needed to be typed in order to get
1271
+ # suggestions. Default value is 2. If left unset or set to 0, then will fallback
1272
+ # to default value.
1273
+ # Corresponds to the JSON property `minPrefixLength`
1274
+ # @return [Fixnum]
1275
+ attr_accessor :min_prefix_length
1276
+
1277
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
1278
+ # completionConfig
1279
+ # Corresponds to the JSON property `name`
1280
+ # @return [String]
1281
+ attr_accessor :name
1282
+
1283
+ # The input config source for completion data.
1284
+ # Corresponds to the JSON property `suggestionsInputConfig`
1285
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1286
+ attr_accessor :suggestions_input_config
1287
+
1288
+ def initialize(**args)
1289
+ update!(**args)
1290
+ end
1291
+
1292
+ # Update properties of this object
1293
+ def update!(**args)
1294
+ @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
1295
+ @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
1296
+ @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
1297
+ @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
1298
+ @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
1299
+ @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
1300
+ @matching_order = args[:matching_order] if args.key?(:matching_order)
1301
+ @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
1302
+ @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
1303
+ @name = args[:name] if args.key?(:name)
1304
+ @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
1305
+ end
1306
+ end
1307
+
1208
1308
  # The input config source for completion data.
1209
1309
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1210
1310
  include Google::Apis::Core::Hashable
@@ -1810,8 +1910,7 @@ module Google
1810
1910
  # @return [String]
1811
1911
  attr_accessor :notification_pubsub_topic
1812
1912
 
1813
- # Id of the request / operation. This is parroting back the requestId that was
1814
- # passed in the request.
1913
+ # Deprecated. This field is never set.
1815
1914
  # Corresponds to the JSON property `requestId`
1816
1915
  # @return [String]
1817
1916
  attr_accessor :request_id
@@ -1871,11 +1970,7 @@ module Google
1871
1970
  # @return [String]
1872
1971
  attr_accessor :reconciliation_mode
1873
1972
 
1874
- # Unique identifier provided by client, within the ancestor dataset scope.
1875
- # Ensures idempotency and used for request deduplication. Server-generated if
1876
- # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1877
- # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1878
- # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1973
+ # Deprecated. This field has no effect.
1879
1974
  # Corresponds to the JSON property `requestId`
1880
1975
  # @return [String]
1881
1976
  attr_accessor :request_id
@@ -5481,8 +5576,7 @@ module Google
5481
5576
  # @return [String]
5482
5577
  attr_accessor :notification_pubsub_topic
5483
5578
 
5484
- # Id of the request / operation. This is parroting back the requestId that was
5485
- # passed in the request.
5579
+ # Deprecated. This field is never set.
5486
5580
  # Corresponds to the JSON property `requestId`
5487
5581
  # @return [String]
5488
5582
  attr_accessor :request_id
@@ -5816,8 +5910,7 @@ module Google
5816
5910
  # A generic empty message that you can re-use to avoid defining duplicated empty
5817
5911
  # messages in your APIs. A typical example is to use it as the request or the
5818
5912
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
5819
- # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
5820
- # `Empty` is empty JSON object ````.
5913
+ # protobuf.Empty) returns (google.protobuf.Empty); `
5821
5914
  class GoogleProtobufEmpty
5822
5915
  include Google::Apis::Core::Hashable
5823
5916
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.33.0"
19
+ GEM_VERSION = "0.34.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220310"
25
+ REVISION = "20220319"
26
26
  end
27
27
  end
28
28
  end
@@ -262,6 +262,12 @@ module Google
262
262
  include Google::Apis::Core::JsonObjectSupport
263
263
  end
264
264
 
265
+ class GoogleCloudRetailV2alphaCompletionConfig
266
+ class Representation < Google::Apis::Core::JsonRepresentation; end
267
+
268
+ include Google::Apis::Core::JsonObjectSupport
269
+ end
270
+
265
271
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
266
272
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
273
 
@@ -1314,6 +1320,26 @@ module Google
1314
1320
  end
1315
1321
  end
1316
1322
 
1323
+ class GoogleCloudRetailV2alphaCompletionConfig
1324
+ # @private
1325
+ class Representation < Google::Apis::Core::JsonRepresentation
1326
+ property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1327
+
1328
+ property :auto_learning, as: 'autoLearning'
1329
+ property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1330
+
1331
+ property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
1332
+ property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
1333
+ property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
1334
+ property :matching_order, as: 'matchingOrder'
1335
+ property :max_suggestions, as: 'maxSuggestions'
1336
+ property :min_prefix_length, as: 'minPrefixLength'
1337
+ property :name, as: 'name'
1338
+ property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1339
+
1340
+ end
1341
+ end
1342
+
1317
1343
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1318
1344
  # @private
1319
1345
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -156,6 +156,37 @@ module Google
156
156
  execute_or_queue_command(command, &block)
157
157
  end
158
158
 
159
+ # Gets a CompletionConfig.
160
+ # @param [String] name
161
+ # Required. Full CompletionConfig resource name. Format: projects/`
162
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
163
+ # @param [String] fields
164
+ # Selector specifying which fields to include in a partial response.
165
+ # @param [String] quota_user
166
+ # Available to use for quota purposes for server-side applications. Can be any
167
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
168
+ # @param [Google::Apis::RequestOptions] options
169
+ # Request-specific options
170
+ #
171
+ # @yield [result, err] Result & error if block supplied
172
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
173
+ # @yieldparam err [StandardError] error object if request failed
174
+ #
175
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
176
+ #
177
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
178
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
179
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
180
+ def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
181
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
182
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
183
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
184
+ command.params['name'] = name unless name.nil?
185
+ command.query['fields'] = fields unless fields.nil?
186
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
187
+ execute_or_queue_command(command, &block)
188
+ end
189
+
159
190
  # Get which branch is currently default branch set by CatalogService.
160
191
  # SetDefaultBranch method under a specified parent catalog.
161
192
  # @param [String] catalog
@@ -365,6 +396,46 @@ module Google
365
396
  execute_or_queue_command(command, &block)
366
397
  end
367
398
 
399
+ # Updates the CompletionConfigs.
400
+ # @param [String] name
401
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
402
+ # completionConfig
403
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] google_cloud_retail_v2alpha_completion_config_object
404
+ # @param [String] update_mask
405
+ # Indicates which fields in the provided CompletionConfig to update. The
406
+ # following are the only supported fields: * CompletionConfig.matching_order *
407
+ # CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
408
+ # CompletionConfig.auto_learning If not set, all supported fields are updated.
409
+ # @param [String] fields
410
+ # Selector specifying which fields to include in a partial response.
411
+ # @param [String] quota_user
412
+ # Available to use for quota purposes for server-side applications. Can be any
413
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
414
+ # @param [Google::Apis::RequestOptions] options
415
+ # Request-specific options
416
+ #
417
+ # @yield [result, err] Result & error if block supplied
418
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
419
+ # @yieldparam err [StandardError] error object if request failed
420
+ #
421
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
422
+ #
423
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
424
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
425
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
426
+ def update_project_location_catalog_completion_config(name, google_cloud_retail_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
427
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
428
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
429
+ command.request_object = google_cloud_retail_v2alpha_completion_config_object
430
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
431
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
432
+ command.params['name'] = name unless name.nil?
433
+ command.query['updateMask'] = update_mask unless update_mask.nil?
434
+ command.query['fields'] = fields unless fields.nil?
435
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
436
+ execute_or_queue_command(command, &block)
437
+ end
438
+
368
439
  # Adds the specified CatalogAttribute to the AttributesConfig. If the
369
440
  # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
370
441
  # @param [String] attributes_config
@@ -1041,9 +1112,11 @@ module Google
1041
1112
  execute_or_queue_command(command, &block)
1042
1113
  end
1043
1114
 
1044
- # Bulk import of processed completion dataset. Request processing may be
1045
- # synchronous. Partial updating is not supported. This feature is only available
1046
- # for users who have Retail Search enabled. Please submit a form [here](https://
1115
+ # Bulk import of processed completion dataset. Request processing is
1116
+ # asynchronous. Partial updating is not supported. The operation is successfully
1117
+ # finished only after the imported suggestions are indexed successfully and
1118
+ # ready for serving. The process takes hours. This feature is only available for
1119
+ # users who have Retail Search enabled. Please submit a form [here](https://
1047
1120
  # cloud.google.com/contact) to contact cloud sales if you are interested in
1048
1121
  # using Retail Search.
1049
1122
  # @param [String] parent
@@ -1350,7 +1423,8 @@ module Google
1350
1423
  # Makes a recommendation prediction.
1351
1424
  # @param [String] placement
1352
1425
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1353
- # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1426
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
1427
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
1354
1428
  # placement. Before you can request predictions from your model, you must create
1355
1429
  # at least one placement for it. For more information, see [Managing placements](
1356
1430
  # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
@@ -1391,9 +1465,10 @@ module Google
1391
1465
  # to contact cloud sales if you are interested in using Retail Search.
1392
1466
  # @param [String] placement
1393
1467
  # Required. The resource name of the search engine placement, such as `projects/*
1394
- # /locations/global/catalogs/default_catalog/placements/default_search`. This
1395
- # field is used to identify the serving configuration name and the set of models
1396
- # that will be used to make the search.
1468
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
1469
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1470
+ # default_serving_config` This field is used to identify the serving
1471
+ # configuration name and the set of models that will be used to make the search.
1397
1472
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1398
1473
  # @param [String] fields
1399
1474
  # Selector specifying which fields to include in a partial response.
@@ -1648,6 +1723,46 @@ module Google
1648
1723
  execute_or_queue_command(command, &block)
1649
1724
  end
1650
1725
 
1726
+ # Makes a recommendation prediction.
1727
+ # @param [String] placement
1728
+ # Required. Full resource name of the format: `name=projects/*/locations/global/
1729
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
1730
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
1731
+ # placement. Before you can request predictions from your model, you must create
1732
+ # at least one placement for it. For more information, see [Managing placements](
1733
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1734
+ # The full list of available placements can be seen at https://console.cloud.
1735
+ # google.com/recommendation/catalogs/default_catalog/placements
1736
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1737
+ # @param [String] fields
1738
+ # Selector specifying which fields to include in a partial response.
1739
+ # @param [String] quota_user
1740
+ # Available to use for quota purposes for server-side applications. Can be any
1741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1742
+ # @param [Google::Apis::RequestOptions] options
1743
+ # Request-specific options
1744
+ #
1745
+ # @yield [result, err] Result & error if block supplied
1746
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
1747
+ # @yieldparam err [StandardError] error object if request failed
1748
+ #
1749
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
1750
+ #
1751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1754
+ def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1755
+ command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
1756
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
1757
+ command.request_object = google_cloud_retail_v2alpha_predict_request_object
1758
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
1759
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
1760
+ command.params['placement'] = placement unless placement.nil?
1761
+ command.query['fields'] = fields unless fields.nil?
1762
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1763
+ execute_or_queue_command(command, &block)
1764
+ end
1765
+
1651
1766
  # Disables a Control on the specified ServingConfig. The control is removed from
1652
1767
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1653
1768
  # the ServingConfig.
@@ -1685,6 +1800,45 @@ module Google
1685
1800
  execute_or_queue_command(command, &block)
1686
1801
  end
1687
1802
 
1803
+ # Performs a search. This feature is only available for users who have Retail
1804
+ # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
1805
+ # to contact cloud sales if you are interested in using Retail Search.
1806
+ # @param [String] placement
1807
+ # Required. The resource name of the search engine placement, such as `projects/*
1808
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
1809
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1810
+ # default_serving_config` This field is used to identify the serving
1811
+ # configuration name and the set of models that will be used to make the search.
1812
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1813
+ # @param [String] fields
1814
+ # Selector specifying which fields to include in a partial response.
1815
+ # @param [String] quota_user
1816
+ # Available to use for quota purposes for server-side applications. Can be any
1817
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1818
+ # @param [Google::Apis::RequestOptions] options
1819
+ # Request-specific options
1820
+ #
1821
+ # @yield [result, err] Result & error if block supplied
1822
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
1823
+ # @yieldparam err [StandardError] error object if request failed
1824
+ #
1825
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
1826
+ #
1827
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1828
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1829
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1830
+ def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1831
+ command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
1832
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
1833
+ command.request_object = google_cloud_retail_v2alpha_search_request_object
1834
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
1835
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
1836
+ command.params['placement'] = placement unless placement.nil?
1837
+ command.query['fields'] = fields unless fields.nil?
1838
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1839
+ execute_or_queue_command(command, &block)
1840
+ end
1841
+
1688
1842
  # Writes a single user event from the browser. This uses a GET request to due to
1689
1843
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1690
1844
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.34.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-03-21 00:00:00.000000000 Z
11
+ date: 2022-03-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.34.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []