google-apis-retail_v2 0.62.0 → 0.64.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: a9e324a6f5306d41a7e392e641c5732433802d42b1e2ab755f89bbefe4f31fcf
4
- data.tar.gz: d0b5caa8995e29482f38f2d6920cd21fdeee93a47ccfce26b596361ff4b4bc85
3
+ metadata.gz: 622ff4fe49dfa205d4b2cdf2dee86c48ae1aa2b037d84b209b533f30edb71bdc
4
+ data.tar.gz: fcf1577667bc6090815a7f8cdba1b0ad4b07236030958a5fc450e8633dac7872
5
5
  SHA512:
6
- metadata.gz: 8aa16469e510eb29518d359803ce97b5bbc2105e912dbc5bb9ec7415004a94fa5179578bc52fa934617d15000b1d696f939df47f95670274c53bb3b56e3ff459
7
- data.tar.gz: 26bd2355b5096960a6b7bddb34f29ee9b75dfda6594b6d04fc04e785e0113d7bec0e576627e01e470586ec85cedd767f401ba3326855d2225ea95abcce2b5a5a
6
+ metadata.gz: 76e77a8d0c6117fbf38aa038255699639981fb60d8c277b220dc308171f8b77163c3d038f5664b980662c05bfd098a400944264facbb32540eb92b186abcdb70
7
+ data.tar.gz: 119e40f0b6a507272ab0532fcf0e01671d0741cbee274e2dd98871a06ed682d22484d06799bc143648ba0b4fc4bb2a1403ab1663dea6f2437f0b1fec70475c7c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.64.0 (2023-02-05)
4
+
5
+ * Regenerated from discovery document revision 20230126
6
+
7
+ ### v0.63.0 (2023-01-29)
8
+
9
+ * Regenerated from discovery document revision 20230119
10
+
3
11
  ### v0.62.0 (2023-01-22)
4
12
 
5
13
  * Regenerated from discovery document revision 20230117
@@ -572,10 +572,10 @@ module Google
572
572
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
573
573
  # user_event_ga360`: The schema is available here: https://support.google.com/
574
574
  # analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
575
- # https://support.google.com/analytics/answer/7029846. Supported values for auto-
576
- # completion imports: * `suggestions` (default): One JSON completion suggestion
577
- # per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One
578
- # JSON allow suggestion per line.
575
+ # https://support.google.com/analytics/answer/7029846. Supported values for
576
+ # autocomplete imports: * `suggestions` (default): One JSON completion
577
+ # suggestion per line. * `denylist`: One JSON deny suggestion per line. * `
578
+ # allowlist`: One JSON allow suggestion per line.
579
579
  # Corresponds to the JSON property `dataSchema`
580
580
  # @return [String]
581
581
  attr_accessor :data_schema
@@ -802,7 +802,7 @@ module Google
802
802
  end
803
803
  end
804
804
 
805
- # Response of the auto-complete query.
805
+ # Response of the autocomplete query.
806
806
  class GoogleCloudRetailV2CompleteQueryResponse
807
807
  include Google::Apis::Core::Hashable
808
808
 
@@ -1193,6 +1193,27 @@ module Google
1193
1193
  end
1194
1194
  end
1195
1195
 
1196
+ # Metadata associated with a create operation.
1197
+ class GoogleCloudRetailV2CreateModelMetadata
1198
+ include Google::Apis::Core::Hashable
1199
+
1200
+ # The resource name of the model that this create applies to. Format: `projects/`
1201
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1202
+ # `
1203
+ # Corresponds to the JSON property `model`
1204
+ # @return [String]
1205
+ attr_accessor :model
1206
+
1207
+ def initialize(**args)
1208
+ update!(**args)
1209
+ end
1210
+
1211
+ # Update properties of this object
1212
+ def update!(**args)
1213
+ @model = args[:model] if args.key?(:model)
1214
+ end
1215
+ end
1216
+
1196
1217
  # A custom attribute that is not explicitly modeled in Product.
1197
1218
  class GoogleCloudRetailV2CustomAttribute
1198
1219
  include Google::Apis::Core::Hashable
@@ -1250,6 +1271,62 @@ module Google
1250
1271
  end
1251
1272
  end
1252
1273
 
1274
+ # Metadata for active A/B testing Experiments.
1275
+ class GoogleCloudRetailV2ExperimentInfo
1276
+ include Google::Apis::Core::Hashable
1277
+
1278
+ # The fully qualified resource name of the experiment that provides the serving
1279
+ # config under test, should an active experiment exist. For example: `projects/*/
1280
+ # locations/global/catalogs/default_catalog/experiments/experiment_id`
1281
+ # Corresponds to the JSON property `experimentName`
1282
+ # @return [String]
1283
+ attr_accessor :experiment_name
1284
+
1285
+ # Metadata for active serving config A/B tests.
1286
+ # Corresponds to the JSON property `servingConfigExperiment`
1287
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment]
1288
+ attr_accessor :serving_config_experiment
1289
+
1290
+ def initialize(**args)
1291
+ update!(**args)
1292
+ end
1293
+
1294
+ # Update properties of this object
1295
+ def update!(**args)
1296
+ @experiment_name = args[:experiment_name] if args.key?(:experiment_name)
1297
+ @serving_config_experiment = args[:serving_config_experiment] if args.key?(:serving_config_experiment)
1298
+ end
1299
+ end
1300
+
1301
+ # Metadata for active serving config A/B tests.
1302
+ class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
1303
+ include Google::Apis::Core::Hashable
1304
+
1305
+ # The fully qualified resource name of the serving config VariantArm.
1306
+ # serving_config_id responsible for generating the search response. For example:
1307
+ # `projects/*/locations/*/catalogs/*/servingConfigs/*`.
1308
+ # Corresponds to the JSON property `experimentServingConfig`
1309
+ # @return [String]
1310
+ attr_accessor :experiment_serving_config
1311
+
1312
+ # The fully qualified resource name of the original SearchRequest.placement in
1313
+ # the search request prior to reassignment by experiment API. For example: `
1314
+ # projects/*/locations/*/catalogs/*/servingConfigs/*`.
1315
+ # Corresponds to the JSON property `originalServingConfig`
1316
+ # @return [String]
1317
+ attr_accessor :original_serving_config
1318
+
1319
+ def initialize(**args)
1320
+ update!(**args)
1321
+ end
1322
+
1323
+ # Update properties of this object
1324
+ def update!(**args)
1325
+ @experiment_serving_config = args[:experiment_serving_config] if args.key?(:experiment_serving_config)
1326
+ @original_serving_config = args[:original_serving_config] if args.key?(:original_serving_config)
1327
+ end
1328
+ end
1329
+
1253
1330
  # Fulfillment information, such as the store IDs for in-store pickup or region
1254
1331
  # IDs for different shipping methods.
1255
1332
  class GoogleCloudRetailV2FulfillmentInfo
@@ -1753,6 +1830,31 @@ module Google
1753
1830
  end
1754
1831
  end
1755
1832
 
1833
+ # Response to a ListModelRequest.
1834
+ class GoogleCloudRetailV2ListModelsResponse
1835
+ include Google::Apis::Core::Hashable
1836
+
1837
+ # List of Models.
1838
+ # Corresponds to the JSON property `models`
1839
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Model>]
1840
+ attr_accessor :models
1841
+
1842
+ # Pagination token, if not returned indicates the last page.
1843
+ # Corresponds to the JSON property `nextPageToken`
1844
+ # @return [String]
1845
+ attr_accessor :next_page_token
1846
+
1847
+ def initialize(**args)
1848
+ update!(**args)
1849
+ end
1850
+
1851
+ # Update properties of this object
1852
+ def update!(**args)
1853
+ @models = args[:models] if args.key?(:models)
1854
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1855
+ end
1856
+ end
1857
+
1756
1858
  # Response message for ProductService.ListProducts method.
1757
1859
  class GoogleCloudRetailV2ListProductsResponse
1758
1860
  include Google::Apis::Core::Hashable
@@ -1857,6 +1959,179 @@ module Google
1857
1959
  end
1858
1960
  end
1859
1961
 
1962
+ # Metadata that describes the training and serving parameters of a Model. A
1963
+ # Model can be associated with a ServingConfig and then queried through the
1964
+ # Predict API.
1965
+ class GoogleCloudRetailV2Model
1966
+ include Google::Apis::Core::Hashable
1967
+
1968
+ # Output only. Timestamp the Recommendation Model was created at.
1969
+ # Corresponds to the JSON property `createTime`
1970
+ # @return [String]
1971
+ attr_accessor :create_time
1972
+
1973
+ # Output only. The state of data requirements for this model: `DATA_OK` and `
1974
+ # DATA_ERROR`. Recommendation model cannot be trained if the data is in `
1975
+ # DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
1976
+ # serving state is `ACTIVE`: models were trained successfully before, but cannot
1977
+ # be refreshed because model no longer has sufficient data for training.
1978
+ # Corresponds to the JSON property `dataState`
1979
+ # @return [String]
1980
+ attr_accessor :data_state
1981
+
1982
+ # Required. The display name of the model. Should be human readable, used to
1983
+ # display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
1984
+ # encoded string with limit of 1024 characters.
1985
+ # Corresponds to the JSON property `displayName`
1986
+ # @return [String]
1987
+ attr_accessor :display_name
1988
+
1989
+ # Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
1990
+ # attributes is enabled for the model.
1991
+ # Corresponds to the JSON property `filteringOption`
1992
+ # @return [String]
1993
+ attr_accessor :filtering_option
1994
+
1995
+ # Output only. The timestamp when the latest successful tune finished.
1996
+ # Corresponds to the JSON property `lastTuneTime`
1997
+ # @return [String]
1998
+ attr_accessor :last_tune_time
1999
+
2000
+ # Required. The fully qualified resource name of the model. Format: `projects/`
2001
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
2002
+ # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
2003
+ # 40.
2004
+ # Corresponds to the JSON property `name`
2005
+ # @return [String]
2006
+ attr_accessor :name
2007
+
2008
+ # Optional. The optimization objective e.g. `cvr`. Currently supported values: `
2009
+ # ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
2010
+ # model type. Default depends on type of recommendation: `recommended-for-you` =>
2011
+ # `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
2012
+ # revenue_per_order` This field together with optimization_objective describe
2013
+ # model metadata to use to control model training and serving. See https://cloud.
2014
+ # google.com/retail/docs/models for more details on what the model metadata
2015
+ # control and which combination of parameters are valid. For invalid
2016
+ # combinations of parameters (e.g. type = `frequently-bought-together` and
2017
+ # optimization_objective = `ctr`), you receive an error 400 if you try to create/
2018
+ # update a recommendation with this set of knobs.
2019
+ # Corresponds to the JSON property `optimizationObjective`
2020
+ # @return [String]
2021
+ attr_accessor :optimization_objective
2022
+
2023
+ # Optional. The state of periodic tuning. The period we use is 3 months - to do
2024
+ # a one-off tune earlier use the `TuneModel` method. Default value is `
2025
+ # PERIODIC_TUNING_ENABLED`.
2026
+ # Corresponds to the JSON property `periodicTuningState`
2027
+ # @return [String]
2028
+ attr_accessor :periodic_tuning_state
2029
+
2030
+ # Output only. The list of valid serving configs associated with the
2031
+ # PageOptimizationConfig.
2032
+ # Corresponds to the JSON property `servingConfigLists`
2033
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList>]
2034
+ attr_accessor :serving_config_lists
2035
+
2036
+ # Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
2037
+ # Corresponds to the JSON property `servingState`
2038
+ # @return [String]
2039
+ attr_accessor :serving_state
2040
+
2041
+ # Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
2042
+ # . Since part of the cost of running the service is frequency of training -
2043
+ # this can be used to determine when to train model in order to control cost. If
2044
+ # not specified: the default value for `CreateModel` method is `TRAINING`. The
2045
+ # default value for `UpdateModel` method is to keep the state the same as before.
2046
+ # Corresponds to the JSON property `trainingState`
2047
+ # @return [String]
2048
+ attr_accessor :training_state
2049
+
2050
+ # Output only. The tune operation associated with the model. Can be used to
2051
+ # determine if there is an ongoing tune for this recommendation. Empty field
2052
+ # implies no tune is goig on.
2053
+ # Corresponds to the JSON property `tuningOperation`
2054
+ # @return [String]
2055
+ attr_accessor :tuning_operation
2056
+
2057
+ # Required. The type of model e.g. `home-page`. Currently supported values: `
2058
+ # recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
2059
+ # page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
2060
+ # recently-viewed`(readonly value). This field together with
2061
+ # optimization_objective describe model metadata to use to control model
2062
+ # training and serving. See https://cloud.google.com/retail/docs/models for more
2063
+ # details on what the model metadata control and which combination of parameters
2064
+ # are valid. For invalid combinations of parameters (e.g. type = `frequently-
2065
+ # bought-together` and optimization_objective = `ctr`), you receive an error 400
2066
+ # if you try to create/update a recommendation with this set of knobs.
2067
+ # Corresponds to the JSON property `type`
2068
+ # @return [String]
2069
+ attr_accessor :type
2070
+
2071
+ # Output only. Timestamp the Recommendation Model was last updated. E.g. if a
2072
+ # Recommendation Model was paused - this would be the time the pause was
2073
+ # initiated.
2074
+ # Corresponds to the JSON property `updateTime`
2075
+ # @return [String]
2076
+ attr_accessor :update_time
2077
+
2078
+ def initialize(**args)
2079
+ update!(**args)
2080
+ end
2081
+
2082
+ # Update properties of this object
2083
+ def update!(**args)
2084
+ @create_time = args[:create_time] if args.key?(:create_time)
2085
+ @data_state = args[:data_state] if args.key?(:data_state)
2086
+ @display_name = args[:display_name] if args.key?(:display_name)
2087
+ @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
2088
+ @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
2089
+ @name = args[:name] if args.key?(:name)
2090
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
2091
+ @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
2092
+ @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
2093
+ @serving_state = args[:serving_state] if args.key?(:serving_state)
2094
+ @training_state = args[:training_state] if args.key?(:training_state)
2095
+ @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
2096
+ @type = args[:type] if args.key?(:type)
2097
+ @update_time = args[:update_time] if args.key?(:update_time)
2098
+ end
2099
+ end
2100
+
2101
+ # Represents an ordered combination of valid serving configs, which can be used
2102
+ # for `PAGE_OPTIMIZATION` recommendations.
2103
+ class GoogleCloudRetailV2ModelServingConfigList
2104
+ include Google::Apis::Core::Hashable
2105
+
2106
+ # Optional. A set of valid serving configs that may be used for `
2107
+ # PAGE_OPTIMIZATION`.
2108
+ # Corresponds to the JSON property `servingConfigIds`
2109
+ # @return [Array<String>]
2110
+ attr_accessor :serving_config_ids
2111
+
2112
+ def initialize(**args)
2113
+ update!(**args)
2114
+ end
2115
+
2116
+ # Update properties of this object
2117
+ def update!(**args)
2118
+ @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
2119
+ end
2120
+ end
2121
+
2122
+ # Request for pausing training of a model.
2123
+ class GoogleCloudRetailV2PauseModelRequest
2124
+ include Google::Apis::Core::Hashable
2125
+
2126
+ def initialize(**args)
2127
+ update!(**args)
2128
+ end
2129
+
2130
+ # Update properties of this object
2131
+ def update!(**args)
2132
+ end
2133
+ end
2134
+
1860
2135
  # Request message for Predict method.
1861
2136
  class GoogleCloudRetailV2PredictRequest
1862
2137
  include Google::Apis::Core::Hashable
@@ -3105,6 +3380,19 @@ module Google
3105
3380
  end
3106
3381
  end
3107
3382
 
3383
+ # Request for resuming training of a model.
3384
+ class GoogleCloudRetailV2ResumeModelRequest
3385
+ include Google::Apis::Core::Hashable
3386
+
3387
+ def initialize(**args)
3388
+ update!(**args)
3389
+ end
3390
+
3391
+ # Update properties of this object
3392
+ def update!(**args)
3393
+ end
3394
+ end
3395
+
3108
3396
  # A rule is a condition-action pair * A condition defines when a rule is to be
3109
3397
  # triggered. * An action specifies what occurs on that trigger. Currently rules
3110
3398
  # only work for controls with SOLUTION_TYPE_SEARCH.
@@ -4007,6 +4295,12 @@ module Google
4007
4295
  # @return [String]
4008
4296
  attr_accessor :corrected_query
4009
4297
 
4298
+ # Metadata related to A/B testing Experiment associated with this response. Only
4299
+ # exists when an experiment is triggered.
4300
+ # Corresponds to the JSON property `experimentInfo`
4301
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>]
4302
+ attr_accessor :experiment_info
4303
+
4010
4304
  # Results of facets requested by user.
4011
4305
  # Corresponds to the JSON property `facets`
4012
4306
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>]
@@ -4058,6 +4352,7 @@ module Google
4058
4352
  @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
4059
4353
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
4060
4354
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
4355
+ @experiment_info = args[:experiment_info] if args.key?(:experiment_info)
4061
4356
  @facets = args[:facets] if args.key?(:facets)
4062
4357
  @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
4063
4358
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@@ -4545,6 +4840,54 @@ module Google
4545
4840
  end
4546
4841
  end
4547
4842
 
4843
+ # Metadata associated with a tune operation.
4844
+ class GoogleCloudRetailV2TuneModelMetadata
4845
+ include Google::Apis::Core::Hashable
4846
+
4847
+ # The resource name of the model that this tune applies to. Format: `projects/`
4848
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
4849
+ # `
4850
+ # Corresponds to the JSON property `model`
4851
+ # @return [String]
4852
+ attr_accessor :model
4853
+
4854
+ def initialize(**args)
4855
+ update!(**args)
4856
+ end
4857
+
4858
+ # Update properties of this object
4859
+ def update!(**args)
4860
+ @model = args[:model] if args.key?(:model)
4861
+ end
4862
+ end
4863
+
4864
+ # Request to manually start a tuning process now (instead of waiting for the
4865
+ # periodically scheduled tuning to happen).
4866
+ class GoogleCloudRetailV2TuneModelRequest
4867
+ include Google::Apis::Core::Hashable
4868
+
4869
+ def initialize(**args)
4870
+ update!(**args)
4871
+ end
4872
+
4873
+ # Update properties of this object
4874
+ def update!(**args)
4875
+ end
4876
+ end
4877
+
4878
+ # Response associated with a tune operation.
4879
+ class GoogleCloudRetailV2TuneModelResponse
4880
+ include Google::Apis::Core::Hashable
4881
+
4882
+ def initialize(**args)
4883
+ update!(**args)
4884
+ end
4885
+
4886
+ # Update properties of this object
4887
+ def update!(**args)
4888
+ end
4889
+ end
4890
+
4548
4891
  # UserEvent captures all metadata information Retail API needs to know about how
4549
4892
  # end users interact with customers' website.
4550
4893
  class GoogleCloudRetailV2UserEvent
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.62.0"
19
+ GEM_VERSION = "0.64.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.11.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230117"
25
+ REVISION = "20230126"
26
26
  end
27
27
  end
28
28
  end
@@ -208,12 +208,30 @@ module Google
208
208
  include Google::Apis::Core::JsonObjectSupport
209
209
  end
210
210
 
211
+ class GoogleCloudRetailV2CreateModelMetadata
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
211
217
  class GoogleCloudRetailV2CustomAttribute
212
218
  class Representation < Google::Apis::Core::JsonRepresentation; end
213
219
 
214
220
  include Google::Apis::Core::JsonObjectSupport
215
221
  end
216
222
 
223
+ class GoogleCloudRetailV2ExperimentInfo
224
+ class Representation < Google::Apis::Core::JsonRepresentation; end
225
+
226
+ include Google::Apis::Core::JsonObjectSupport
227
+ end
228
+
229
+ class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
230
+ class Representation < Google::Apis::Core::JsonRepresentation; end
231
+
232
+ include Google::Apis::Core::JsonObjectSupport
233
+ end
234
+
217
235
  class GoogleCloudRetailV2FulfillmentInfo
218
236
  class Representation < Google::Apis::Core::JsonRepresentation; end
219
237
 
@@ -304,6 +322,12 @@ module Google
304
322
  include Google::Apis::Core::JsonObjectSupport
305
323
  end
306
324
 
325
+ class GoogleCloudRetailV2ListModelsResponse
326
+ class Representation < Google::Apis::Core::JsonRepresentation; end
327
+
328
+ include Google::Apis::Core::JsonObjectSupport
329
+ end
330
+
307
331
  class GoogleCloudRetailV2ListProductsResponse
308
332
  class Representation < Google::Apis::Core::JsonRepresentation; end
309
333
 
@@ -322,6 +346,24 @@ module Google
322
346
  include Google::Apis::Core::JsonObjectSupport
323
347
  end
324
348
 
349
+ class GoogleCloudRetailV2Model
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
355
+ class GoogleCloudRetailV2ModelServingConfigList
356
+ class Representation < Google::Apis::Core::JsonRepresentation; end
357
+
358
+ include Google::Apis::Core::JsonObjectSupport
359
+ end
360
+
361
+ class GoogleCloudRetailV2PauseModelRequest
362
+ class Representation < Google::Apis::Core::JsonRepresentation; end
363
+
364
+ include Google::Apis::Core::JsonObjectSupport
365
+ end
366
+
325
367
  class GoogleCloudRetailV2PredictRequest
326
368
  class Representation < Google::Apis::Core::JsonRepresentation; end
327
369
 
@@ -490,6 +532,12 @@ module Google
490
532
  include Google::Apis::Core::JsonObjectSupport
491
533
  end
492
534
 
535
+ class GoogleCloudRetailV2ResumeModelRequest
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
493
541
  class GoogleCloudRetailV2Rule
494
542
  class Representation < Google::Apis::Core::JsonRepresentation; end
495
543
 
@@ -658,6 +706,24 @@ module Google
658
706
  include Google::Apis::Core::JsonObjectSupport
659
707
  end
660
708
 
709
+ class GoogleCloudRetailV2TuneModelMetadata
710
+ class Representation < Google::Apis::Core::JsonRepresentation; end
711
+
712
+ include Google::Apis::Core::JsonObjectSupport
713
+ end
714
+
715
+ class GoogleCloudRetailV2TuneModelRequest
716
+ class Representation < Google::Apis::Core::JsonRepresentation; end
717
+
718
+ include Google::Apis::Core::JsonObjectSupport
719
+ end
720
+
721
+ class GoogleCloudRetailV2TuneModelResponse
722
+ class Representation < Google::Apis::Core::JsonRepresentation; end
723
+
724
+ include Google::Apis::Core::JsonObjectSupport
725
+ end
726
+
661
727
  class GoogleCloudRetailV2UserEvent
662
728
  class Representation < Google::Apis::Core::JsonRepresentation; end
663
729
 
@@ -1433,6 +1499,13 @@ module Google
1433
1499
  end
1434
1500
  end
1435
1501
 
1502
+ class GoogleCloudRetailV2CreateModelMetadata
1503
+ # @private
1504
+ class Representation < Google::Apis::Core::JsonRepresentation
1505
+ property :model, as: 'model'
1506
+ end
1507
+ end
1508
+
1436
1509
  class GoogleCloudRetailV2CustomAttribute
1437
1510
  # @private
1438
1511
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1443,6 +1516,23 @@ module Google
1443
1516
  end
1444
1517
  end
1445
1518
 
1519
+ class GoogleCloudRetailV2ExperimentInfo
1520
+ # @private
1521
+ class Representation < Google::Apis::Core::JsonRepresentation
1522
+ property :experiment_name, as: 'experimentName'
1523
+ property :serving_config_experiment, as: 'servingConfigExperiment', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment::Representation
1524
+
1525
+ end
1526
+ end
1527
+
1528
+ class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
1529
+ # @private
1530
+ class Representation < Google::Apis::Core::JsonRepresentation
1531
+ property :experiment_serving_config, as: 'experimentServingConfig'
1532
+ property :original_serving_config, as: 'originalServingConfig'
1533
+ end
1534
+ end
1535
+
1446
1536
  class GoogleCloudRetailV2FulfillmentInfo
1447
1537
  # @private
1448
1538
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1587,6 +1677,15 @@ module Google
1587
1677
  end
1588
1678
  end
1589
1679
 
1680
+ class GoogleCloudRetailV2ListModelsResponse
1681
+ # @private
1682
+ class Representation < Google::Apis::Core::JsonRepresentation
1683
+ collection :models, as: 'models', class: Google::Apis::RetailV2::GoogleCloudRetailV2Model, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1684
+
1685
+ property :next_page_token, as: 'nextPageToken'
1686
+ end
1687
+ end
1688
+
1590
1689
  class GoogleCloudRetailV2ListProductsResponse
1591
1690
  # @private
1592
1691
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1617,6 +1716,40 @@ module Google
1617
1716
  end
1618
1717
  end
1619
1718
 
1719
+ class GoogleCloudRetailV2Model
1720
+ # @private
1721
+ class Representation < Google::Apis::Core::JsonRepresentation
1722
+ property :create_time, as: 'createTime'
1723
+ property :data_state, as: 'dataState'
1724
+ property :display_name, as: 'displayName'
1725
+ property :filtering_option, as: 'filteringOption'
1726
+ property :last_tune_time, as: 'lastTuneTime'
1727
+ property :name, as: 'name'
1728
+ property :optimization_objective, as: 'optimizationObjective'
1729
+ property :periodic_tuning_state, as: 'periodicTuningState'
1730
+ collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList::Representation
1731
+
1732
+ property :serving_state, as: 'servingState'
1733
+ property :training_state, as: 'trainingState'
1734
+ property :tuning_operation, as: 'tuningOperation'
1735
+ property :type, as: 'type'
1736
+ property :update_time, as: 'updateTime'
1737
+ end
1738
+ end
1739
+
1740
+ class GoogleCloudRetailV2ModelServingConfigList
1741
+ # @private
1742
+ class Representation < Google::Apis::Core::JsonRepresentation
1743
+ collection :serving_config_ids, as: 'servingConfigIds'
1744
+ end
1745
+ end
1746
+
1747
+ class GoogleCloudRetailV2PauseModelRequest
1748
+ # @private
1749
+ class Representation < Google::Apis::Core::JsonRepresentation
1750
+ end
1751
+ end
1752
+
1620
1753
  class GoogleCloudRetailV2PredictRequest
1621
1754
  # @private
1622
1755
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1895,6 +2028,12 @@ module Google
1895
2028
  end
1896
2029
  end
1897
2030
 
2031
+ class GoogleCloudRetailV2ResumeModelRequest
2032
+ # @private
2033
+ class Representation < Google::Apis::Core::JsonRepresentation
2034
+ end
2035
+ end
2036
+
1898
2037
  class GoogleCloudRetailV2Rule
1899
2038
  # @private
1900
2039
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2094,6 +2233,8 @@ module Google
2094
2233
  collection :applied_controls, as: 'appliedControls'
2095
2234
  property :attribution_token, as: 'attributionToken'
2096
2235
  property :corrected_query, as: 'correctedQuery'
2236
+ collection :experiment_info, as: 'experimentInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo::Representation
2237
+
2097
2238
  collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
2098
2239
 
2099
2240
  collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec::Representation
@@ -2210,6 +2351,25 @@ module Google
2210
2351
  end
2211
2352
  end
2212
2353
 
2354
+ class GoogleCloudRetailV2TuneModelMetadata
2355
+ # @private
2356
+ class Representation < Google::Apis::Core::JsonRepresentation
2357
+ property :model, as: 'model'
2358
+ end
2359
+ end
2360
+
2361
+ class GoogleCloudRetailV2TuneModelRequest
2362
+ # @private
2363
+ class Representation < Google::Apis::Core::JsonRepresentation
2364
+ end
2365
+ end
2366
+
2367
+ class GoogleCloudRetailV2TuneModelResponse
2368
+ # @private
2369
+ class Representation < Google::Apis::Core::JsonRepresentation
2370
+ end
2371
+ end
2372
+
2213
2373
  class GoogleCloudRetailV2UserEvent
2214
2374
  # @private
2215
2375
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -583,8 +583,7 @@ module Google
583
583
  # returned Operations will be obsolete after 1 day, and GetOperation API will
584
584
  # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
585
585
  # associated with the stale updates will not be marked as done until being
586
- # obsolete. This feature is only available for users who have Retail Search
587
- # enabled. Enable Retail Search on Cloud Console before using this feature.
586
+ # obsolete.
588
587
  # @param [String] product
589
588
  # Required. Full resource name of Product, such as `projects/*/locations/global/
590
589
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -632,9 +631,7 @@ module Google
632
631
  # inventories. The returned Operations will be obsolete after 1 day, and
633
632
  # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
634
633
  # issued, the Operations associated with the stale updates will not be marked as
635
- # done until being obsolete. This feature is only available for users who have
636
- # Retail Search enabled. Enable Retail Search on Cloud Console before using this
637
- # feature.
634
+ # done until being obsolete.
638
635
  # @param [String] product
639
636
  # Required. Full resource name of Product, such as `projects/*/locations/global/
640
637
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -944,8 +941,7 @@ module Google
944
941
  # returned Operations will be obsolete after 1 day, and GetOperation API will
945
942
  # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
946
943
  # associated with the stale updates will not be marked as done until being
947
- # obsolete. This feature is only available for users who have Retail Search
948
- # enabled. Enable Retail Search on Cloud Console before using this feature.
944
+ # obsolete.
949
945
  # @param [String] product
950
946
  # Required. Full resource name of Product, such as `projects/*/locations/global/
951
947
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -991,9 +987,7 @@ module Google
991
987
  # inventories. The returned Operations will be obsolete after 1 day, and
992
988
  # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
993
989
  # issued, the Operations associated with the stale updates will not be marked as
994
- # done until being obsolete. This feature is only available for users who have
995
- # Retail Search enabled. Enable Retail Search on Cloud Console before using this
996
- # feature.
990
+ # done until being obsolete.
997
991
  # @param [String] product
998
992
  # Required. Full resource name of Product, such as `projects/*/locations/global/
999
993
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1049,9 +1043,7 @@ module Google
1049
1043
  # RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
1050
1044
  # and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
1051
1045
  # updates are issued, the Operations associated with the stale updates are not
1052
- # marked as done until they are obsolete. This feature is only available for
1053
- # users who have Retail Search enabled. Enable Retail Search on Cloud Console
1054
- # before using this feature.
1046
+ # marked as done until they are obsolete.
1055
1047
  # @param [String] name
1056
1048
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1057
1049
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1315,6 +1307,260 @@ module Google
1315
1307
  execute_or_queue_command(command, &block)
1316
1308
  end
1317
1309
 
1310
+ # Creates a new model.
1311
+ # @param [String] parent
1312
+ # Required. The parent resource under which to create the model. Format: `
1313
+ # projects/`project_number`/locations/`location_id`/catalogs/`catalog_id``
1314
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2Model] google_cloud_retail_v2_model_object
1315
+ # @param [Boolean] dry_run
1316
+ # Optional. Whether to run a dry run to validate the request (without actually
1317
+ # creating the model).
1318
+ # @param [String] fields
1319
+ # Selector specifying which fields to include in a partial response.
1320
+ # @param [String] quota_user
1321
+ # Available to use for quota purposes for server-side applications. Can be any
1322
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1323
+ # @param [Google::Apis::RequestOptions] options
1324
+ # Request-specific options
1325
+ #
1326
+ # @yield [result, err] Result & error if block supplied
1327
+ # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
1328
+ # @yieldparam err [StandardError] error object if request failed
1329
+ #
1330
+ # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
1331
+ #
1332
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1333
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1334
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1335
+ def create_project_location_catalog_model(parent, google_cloud_retail_v2_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
1336
+ command = make_simple_command(:post, 'v2/{+parent}/models', options)
1337
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1338
+ command.request_object = google_cloud_retail_v2_model_object
1339
+ command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
1340
+ command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
1341
+ command.params['parent'] = parent unless parent.nil?
1342
+ command.query['dryRun'] = dry_run unless dry_run.nil?
1343
+ command.query['fields'] = fields unless fields.nil?
1344
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1345
+ execute_or_queue_command(command, &block)
1346
+ end
1347
+
1348
+ # Deletes an existing model.
1349
+ # @param [String] name
1350
+ # Required. The resource name of the Model to delete. Format: `projects/`
1351
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1352
+ # `
1353
+ # @param [String] fields
1354
+ # Selector specifying which fields to include in a partial response.
1355
+ # @param [String] quota_user
1356
+ # Available to use for quota purposes for server-side applications. Can be any
1357
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1358
+ # @param [Google::Apis::RequestOptions] options
1359
+ # Request-specific options
1360
+ #
1361
+ # @yield [result, err] Result & error if block supplied
1362
+ # @yieldparam result [Google::Apis::RetailV2::GoogleProtobufEmpty] parsed result object
1363
+ # @yieldparam err [StandardError] error object if request failed
1364
+ #
1365
+ # @return [Google::Apis::RetailV2::GoogleProtobufEmpty]
1366
+ #
1367
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1368
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1369
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1370
+ def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
1371
+ command = make_simple_command(:delete, 'v2/{+name}', options)
1372
+ command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation
1373
+ command.response_class = Google::Apis::RetailV2::GoogleProtobufEmpty
1374
+ command.params['name'] = name unless name.nil?
1375
+ command.query['fields'] = fields unless fields.nil?
1376
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1377
+ execute_or_queue_command(command, &block)
1378
+ end
1379
+
1380
+ # Lists all the models linked to this event store.
1381
+ # @param [String] parent
1382
+ # Required. The parent for which to list models. Format: `projects/`
1383
+ # project_number`/locations/`location_id`/catalogs/`catalog_id``
1384
+ # @param [Fixnum] page_size
1385
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1386
+ # Max allowed value is 1000.
1387
+ # @param [String] page_token
1388
+ # Optional. A page token, received from a previous `ListModels` call. Provide
1389
+ # this to retrieve the subsequent page.
1390
+ # @param [String] fields
1391
+ # Selector specifying which fields to include in a partial response.
1392
+ # @param [String] quota_user
1393
+ # Available to use for quota purposes for server-side applications. Can be any
1394
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1395
+ # @param [Google::Apis::RequestOptions] options
1396
+ # Request-specific options
1397
+ #
1398
+ # @yield [result, err] Result & error if block supplied
1399
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse] parsed result object
1400
+ # @yieldparam err [StandardError] error object if request failed
1401
+ #
1402
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse]
1403
+ #
1404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1407
+ def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1408
+ command = make_simple_command(:get, 'v2/{+parent}/models', options)
1409
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse::Representation
1410
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse
1411
+ command.params['parent'] = parent unless parent.nil?
1412
+ command.query['pageSize'] = page_size unless page_size.nil?
1413
+ command.query['pageToken'] = page_token unless page_token.nil?
1414
+ command.query['fields'] = fields unless fields.nil?
1415
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1416
+ execute_or_queue_command(command, &block)
1417
+ end
1418
+
1419
+ # Update of model metadata. Only fields that currently can be updated are: `
1420
+ # filtering_option` and `periodic_tuning_state`. If other values are provided,
1421
+ # this API method ignores them.
1422
+ # @param [String] name
1423
+ # Required. The fully qualified resource name of the model. Format: `projects/`
1424
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1425
+ # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
1426
+ # 40.
1427
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2Model] google_cloud_retail_v2_model_object
1428
+ # @param [String] update_mask
1429
+ # Optional. Indicates which fields in the provided 'model' to update. If not set,
1430
+ # by default updates all fields.
1431
+ # @param [String] fields
1432
+ # Selector specifying which fields to include in a partial response.
1433
+ # @param [String] quota_user
1434
+ # Available to use for quota purposes for server-side applications. Can be any
1435
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1436
+ # @param [Google::Apis::RequestOptions] options
1437
+ # Request-specific options
1438
+ #
1439
+ # @yield [result, err] Result & error if block supplied
1440
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
1441
+ # @yieldparam err [StandardError] error object if request failed
1442
+ #
1443
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
1444
+ #
1445
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1446
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1447
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1448
+ def patch_project_location_catalog_model(name, google_cloud_retail_v2_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1449
+ command = make_simple_command(:patch, 'v2/{+name}', options)
1450
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1451
+ command.request_object = google_cloud_retail_v2_model_object
1452
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1453
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
1454
+ command.params['name'] = name unless name.nil?
1455
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1456
+ command.query['fields'] = fields unless fields.nil?
1457
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1458
+ execute_or_queue_command(command, &block)
1459
+ end
1460
+
1461
+ # Pauses the training of an existing model.
1462
+ # @param [String] name
1463
+ # Required. The name of the model to pause. Format: `projects/`project_number`/
1464
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1465
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PauseModelRequest] google_cloud_retail_v2_pause_model_request_object
1466
+ # @param [String] fields
1467
+ # Selector specifying which fields to include in a partial response.
1468
+ # @param [String] quota_user
1469
+ # Available to use for quota purposes for server-side applications. Can be any
1470
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1471
+ # @param [Google::Apis::RequestOptions] options
1472
+ # Request-specific options
1473
+ #
1474
+ # @yield [result, err] Result & error if block supplied
1475
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
1476
+ # @yieldparam err [StandardError] error object if request failed
1477
+ #
1478
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
1479
+ #
1480
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1481
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1482
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1483
+ def pause_project_location_catalog_model(name, google_cloud_retail_v2_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1484
+ command = make_simple_command(:post, 'v2/{+name}:pause', options)
1485
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PauseModelRequest::Representation
1486
+ command.request_object = google_cloud_retail_v2_pause_model_request_object
1487
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1488
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
1489
+ command.params['name'] = name unless name.nil?
1490
+ command.query['fields'] = fields unless fields.nil?
1491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1492
+ execute_or_queue_command(command, &block)
1493
+ end
1494
+
1495
+ # Resumes the training of an existing model.
1496
+ # @param [String] name
1497
+ # Required. The name of the model to resume. Format: `projects/`project_number`/
1498
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1499
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ResumeModelRequest] google_cloud_retail_v2_resume_model_request_object
1500
+ # @param [String] fields
1501
+ # Selector specifying which fields to include in a partial response.
1502
+ # @param [String] quota_user
1503
+ # Available to use for quota purposes for server-side applications. Can be any
1504
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1505
+ # @param [Google::Apis::RequestOptions] options
1506
+ # Request-specific options
1507
+ #
1508
+ # @yield [result, err] Result & error if block supplied
1509
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
1510
+ # @yieldparam err [StandardError] error object if request failed
1511
+ #
1512
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
1513
+ #
1514
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1515
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1516
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1517
+ def resume_project_location_catalog_model(name, google_cloud_retail_v2_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1518
+ command = make_simple_command(:post, 'v2/{+name}:resume', options)
1519
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ResumeModelRequest::Representation
1520
+ command.request_object = google_cloud_retail_v2_resume_model_request_object
1521
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
1522
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
1523
+ command.params['name'] = name unless name.nil?
1524
+ command.query['fields'] = fields unless fields.nil?
1525
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1526
+ execute_or_queue_command(command, &block)
1527
+ end
1528
+
1529
+ # Tunes an existing model.
1530
+ # @param [String] name
1531
+ # Required. The resource name of the model to tune. Format: `projects/`
1532
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1533
+ # `
1534
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2TuneModelRequest] google_cloud_retail_v2_tune_model_request_object
1535
+ # @param [String] fields
1536
+ # Selector specifying which fields to include in a partial response.
1537
+ # @param [String] quota_user
1538
+ # Available to use for quota purposes for server-side applications. Can be any
1539
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1540
+ # @param [Google::Apis::RequestOptions] options
1541
+ # Request-specific options
1542
+ #
1543
+ # @yield [result, err] Result & error if block supplied
1544
+ # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
1545
+ # @yieldparam err [StandardError] error object if request failed
1546
+ #
1547
+ # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
1548
+ #
1549
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1550
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1551
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1552
+ def tune_project_location_catalog_model(name, google_cloud_retail_v2_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1553
+ command = make_simple_command(:post, 'v2/{+name}:tune', options)
1554
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2TuneModelRequest::Representation
1555
+ command.request_object = google_cloud_retail_v2_tune_model_request_object
1556
+ command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
1557
+ command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
1558
+ command.params['name'] = name unless name.nil?
1559
+ command.query['fields'] = fields unless fields.nil?
1560
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1561
+ execute_or_queue_command(command, &block)
1562
+ end
1563
+
1318
1564
  # Gets the latest state of a long-running operation. Clients can use this method
1319
1565
  # to poll the operation result at intervals as recommended by the API service.
1320
1566
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.62.0
4
+ version: 0.64.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: 2023-01-22 00:00:00.000000000 Z
11
+ date: 2023-02-05 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_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.62.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.64.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []