google-apis-retail_v2alpha 0.66.0 → 0.68.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a67a9470ca21f0fadc2b763937539018c05e491594cd414a6c1fdf5640bc1695
|
4
|
+
data.tar.gz: 4c92cf6cbfbb93d85ae4c9b780d184a44683d2d23bd6419c3518db560fa57770
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f419f938d9b014be77f07e859413271b35fdb66c42d54061483a5841baf86f2d6007d6f68d8de0b174e73acd5af7b53c666f932e28a7c0b8e99bceb69bab9730
|
7
|
+
data.tar.gz: b34f9a9ec48ca5e724bc62ae4f4fe9c00af13c4279c7ab4e251de3927913eea49035f3539020d1d3d529063d92b452b01bbb767e889b245fd8f3f8f0af874af2
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-retail_v2alpha
|
2
2
|
|
3
|
+
### v0.68.0 (2023-02-12)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20230202
|
6
|
+
|
7
|
+
### v0.67.0 (2023-01-29)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20230119
|
10
|
+
|
3
11
|
### v0.66.0 (2023-01-22)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230117
|
@@ -339,6 +339,27 @@ module Google
|
|
339
339
|
end
|
340
340
|
end
|
341
341
|
|
342
|
+
# Metadata associated with a create operation.
|
343
|
+
class GoogleCloudRetailV2CreateModelMetadata
|
344
|
+
include Google::Apis::Core::Hashable
|
345
|
+
|
346
|
+
# The resource name of the model that this create applies to. Format: `projects/`
|
347
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
348
|
+
# `
|
349
|
+
# Corresponds to the JSON property `model`
|
350
|
+
# @return [String]
|
351
|
+
attr_accessor :model
|
352
|
+
|
353
|
+
def initialize(**args)
|
354
|
+
update!(**args)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Update properties of this object
|
358
|
+
def update!(**args)
|
359
|
+
@model = args[:model] if args.key?(:model)
|
360
|
+
end
|
361
|
+
end
|
362
|
+
|
342
363
|
# Response of the ImportCompletionDataRequest. If the long running operation is
|
343
364
|
# done, this message is returned by the google.longrunning.Operations.response
|
344
365
|
# field if the operation is successful.
|
@@ -496,6 +517,166 @@ module Google
|
|
496
517
|
end
|
497
518
|
end
|
498
519
|
|
520
|
+
# Metadata that describes the training and serving parameters of a Model. A
|
521
|
+
# Model can be associated with a ServingConfig and then queried through the
|
522
|
+
# Predict API.
|
523
|
+
class GoogleCloudRetailV2Model
|
524
|
+
include Google::Apis::Core::Hashable
|
525
|
+
|
526
|
+
# Output only. Timestamp the Recommendation Model was created at.
|
527
|
+
# Corresponds to the JSON property `createTime`
|
528
|
+
# @return [String]
|
529
|
+
attr_accessor :create_time
|
530
|
+
|
531
|
+
# Output only. The state of data requirements for this model: `DATA_OK` and `
|
532
|
+
# DATA_ERROR`. Recommendation model cannot be trained if the data is in `
|
533
|
+
# DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
|
534
|
+
# serving state is `ACTIVE`: models were trained successfully before, but cannot
|
535
|
+
# be refreshed because model no longer has sufficient data for training.
|
536
|
+
# Corresponds to the JSON property `dataState`
|
537
|
+
# @return [String]
|
538
|
+
attr_accessor :data_state
|
539
|
+
|
540
|
+
# Required. The display name of the model. Should be human readable, used to
|
541
|
+
# display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
|
542
|
+
# encoded string with limit of 1024 characters.
|
543
|
+
# Corresponds to the JSON property `displayName`
|
544
|
+
# @return [String]
|
545
|
+
attr_accessor :display_name
|
546
|
+
|
547
|
+
# Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
|
548
|
+
# attributes is enabled for the model.
|
549
|
+
# Corresponds to the JSON property `filteringOption`
|
550
|
+
# @return [String]
|
551
|
+
attr_accessor :filtering_option
|
552
|
+
|
553
|
+
# Output only. The timestamp when the latest successful tune finished.
|
554
|
+
# Corresponds to the JSON property `lastTuneTime`
|
555
|
+
# @return [String]
|
556
|
+
attr_accessor :last_tune_time
|
557
|
+
|
558
|
+
# Required. The fully qualified resource name of the model. Format: `projects/`
|
559
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
560
|
+
# ` catalog_id has char limit of 50. recommendation_model_id has char limit of
|
561
|
+
# 40.
|
562
|
+
# Corresponds to the JSON property `name`
|
563
|
+
# @return [String]
|
564
|
+
attr_accessor :name
|
565
|
+
|
566
|
+
# Optional. The optimization objective e.g. `cvr`. Currently supported values: `
|
567
|
+
# ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
|
568
|
+
# model type. Default depends on type of recommendation: `recommended-for-you` =>
|
569
|
+
# `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
|
570
|
+
# revenue_per_order` This field together with optimization_objective describe
|
571
|
+
# model metadata to use to control model training and serving. See https://cloud.
|
572
|
+
# google.com/retail/docs/models for more details on what the model metadata
|
573
|
+
# control and which combination of parameters are valid. For invalid
|
574
|
+
# combinations of parameters (e.g. type = `frequently-bought-together` and
|
575
|
+
# optimization_objective = `ctr`), you receive an error 400 if you try to create/
|
576
|
+
# update a recommendation with this set of knobs.
|
577
|
+
# Corresponds to the JSON property `optimizationObjective`
|
578
|
+
# @return [String]
|
579
|
+
attr_accessor :optimization_objective
|
580
|
+
|
581
|
+
# Optional. The state of periodic tuning. The period we use is 3 months - to do
|
582
|
+
# a one-off tune earlier use the `TuneModel` method. Default value is `
|
583
|
+
# PERIODIC_TUNING_ENABLED`.
|
584
|
+
# Corresponds to the JSON property `periodicTuningState`
|
585
|
+
# @return [String]
|
586
|
+
attr_accessor :periodic_tuning_state
|
587
|
+
|
588
|
+
# Output only. The list of valid serving configs associated with the
|
589
|
+
# PageOptimizationConfig.
|
590
|
+
# Corresponds to the JSON property `servingConfigLists`
|
591
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelServingConfigList>]
|
592
|
+
attr_accessor :serving_config_lists
|
593
|
+
|
594
|
+
# Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
|
595
|
+
# Corresponds to the JSON property `servingState`
|
596
|
+
# @return [String]
|
597
|
+
attr_accessor :serving_state
|
598
|
+
|
599
|
+
# Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
|
600
|
+
# . Since part of the cost of running the service is frequency of training -
|
601
|
+
# this can be used to determine when to train model in order to control cost. If
|
602
|
+
# not specified: the default value for `CreateModel` method is `TRAINING`. The
|
603
|
+
# default value for `UpdateModel` method is to keep the state the same as before.
|
604
|
+
# Corresponds to the JSON property `trainingState`
|
605
|
+
# @return [String]
|
606
|
+
attr_accessor :training_state
|
607
|
+
|
608
|
+
# Output only. The tune operation associated with the model. Can be used to
|
609
|
+
# determine if there is an ongoing tune for this recommendation. Empty field
|
610
|
+
# implies no tune is goig on.
|
611
|
+
# Corresponds to the JSON property `tuningOperation`
|
612
|
+
# @return [String]
|
613
|
+
attr_accessor :tuning_operation
|
614
|
+
|
615
|
+
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
616
|
+
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
617
|
+
# page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
|
618
|
+
# recently-viewed`(readonly value). This field together with
|
619
|
+
# optimization_objective describe model metadata to use to control model
|
620
|
+
# training and serving. See https://cloud.google.com/retail/docs/models for more
|
621
|
+
# details on what the model metadata control and which combination of parameters
|
622
|
+
# are valid. For invalid combinations of parameters (e.g. type = `frequently-
|
623
|
+
# bought-together` and optimization_objective = `ctr`), you receive an error 400
|
624
|
+
# if you try to create/update a recommendation with this set of knobs.
|
625
|
+
# Corresponds to the JSON property `type`
|
626
|
+
# @return [String]
|
627
|
+
attr_accessor :type
|
628
|
+
|
629
|
+
# Output only. Timestamp the Recommendation Model was last updated. E.g. if a
|
630
|
+
# Recommendation Model was paused - this would be the time the pause was
|
631
|
+
# initiated.
|
632
|
+
# Corresponds to the JSON property `updateTime`
|
633
|
+
# @return [String]
|
634
|
+
attr_accessor :update_time
|
635
|
+
|
636
|
+
def initialize(**args)
|
637
|
+
update!(**args)
|
638
|
+
end
|
639
|
+
|
640
|
+
# Update properties of this object
|
641
|
+
def update!(**args)
|
642
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
643
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
644
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
645
|
+
@filtering_option = args[:filtering_option] if args.key?(:filtering_option)
|
646
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
647
|
+
@name = args[:name] if args.key?(:name)
|
648
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
649
|
+
@periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
|
650
|
+
@serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
|
651
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
652
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
653
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
654
|
+
@type = args[:type] if args.key?(:type)
|
655
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
656
|
+
end
|
657
|
+
end
|
658
|
+
|
659
|
+
# Represents an ordered combination of valid serving configs, which can be used
|
660
|
+
# for `PAGE_OPTIMIZATION` recommendations.
|
661
|
+
class GoogleCloudRetailV2ModelServingConfigList
|
662
|
+
include Google::Apis::Core::Hashable
|
663
|
+
|
664
|
+
# Optional. A set of valid serving configs that may be used for `
|
665
|
+
# PAGE_OPTIMIZATION`.
|
666
|
+
# Corresponds to the JSON property `servingConfigIds`
|
667
|
+
# @return [Array<String>]
|
668
|
+
attr_accessor :serving_config_ids
|
669
|
+
|
670
|
+
def initialize(**args)
|
671
|
+
update!(**args)
|
672
|
+
end
|
673
|
+
|
674
|
+
# Update properties of this object
|
675
|
+
def update!(**args)
|
676
|
+
@serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
499
680
|
# Metadata related to the progress of the Purge operation. This will be returned
|
500
681
|
# by the google.longrunning.Operation.metadata field.
|
501
682
|
class GoogleCloudRetailV2PurgeMetadata
|
@@ -652,6 +833,40 @@ module Google
|
|
652
833
|
end
|
653
834
|
end
|
654
835
|
|
836
|
+
# Metadata associated with a tune operation.
|
837
|
+
class GoogleCloudRetailV2TuneModelMetadata
|
838
|
+
include Google::Apis::Core::Hashable
|
839
|
+
|
840
|
+
# The resource name of the model that this tune applies to. Format: `projects/`
|
841
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
842
|
+
# `
|
843
|
+
# Corresponds to the JSON property `model`
|
844
|
+
# @return [String]
|
845
|
+
attr_accessor :model
|
846
|
+
|
847
|
+
def initialize(**args)
|
848
|
+
update!(**args)
|
849
|
+
end
|
850
|
+
|
851
|
+
# Update properties of this object
|
852
|
+
def update!(**args)
|
853
|
+
@model = args[:model] if args.key?(:model)
|
854
|
+
end
|
855
|
+
end
|
856
|
+
|
857
|
+
# Response associated with a tune operation.
|
858
|
+
class GoogleCloudRetailV2TuneModelResponse
|
859
|
+
include Google::Apis::Core::Hashable
|
860
|
+
|
861
|
+
def initialize(**args)
|
862
|
+
update!(**args)
|
863
|
+
end
|
864
|
+
|
865
|
+
# Update properties of this object
|
866
|
+
def update!(**args)
|
867
|
+
end
|
868
|
+
end
|
869
|
+
|
655
870
|
# A summary of import result. The UserEventImportSummary summarizes the import
|
656
871
|
# status for user events.
|
657
872
|
class GoogleCloudRetailV2UserEventImportSummary
|
@@ -1045,10 +1260,10 @@ module Google
|
|
1045
1260
|
# imports: * `user_event` (default): One JSON UserEvent per line. * `
|
1046
1261
|
# user_event_ga360`: The schema is available here: https://support.google.com/
|
1047
1262
|
# analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
|
1048
|
-
# https://support.google.com/analytics/answer/7029846. Supported values for
|
1049
|
-
#
|
1050
|
-
# per line. * `denylist`: One JSON deny suggestion per line. * `
|
1051
|
-
# JSON allow suggestion per line.
|
1263
|
+
# https://support.google.com/analytics/answer/7029846. Supported values for
|
1264
|
+
# autocomplete imports: * `suggestions` (default): One JSON completion
|
1265
|
+
# suggestion per line. * `denylist`: One JSON deny suggestion per line. * `
|
1266
|
+
# allowlist`: One JSON allow suggestion per line.
|
1052
1267
|
# Corresponds to the JSON property `dataSchema`
|
1053
1268
|
# @return [String]
|
1054
1269
|
attr_accessor :data_schema
|
@@ -1291,7 +1506,7 @@ module Google
|
|
1291
1506
|
end
|
1292
1507
|
end
|
1293
1508
|
|
1294
|
-
# Response of the
|
1509
|
+
# Response of the autocomplete query.
|
1295
1510
|
class GoogleCloudRetailV2alphaCompleteQueryResponse
|
1296
1511
|
include Google::Apis::Core::Hashable
|
1297
1512
|
|
@@ -1792,6 +2007,62 @@ module Google
|
|
1792
2007
|
end
|
1793
2008
|
end
|
1794
2009
|
|
2010
|
+
# Metadata for active A/B testing Experiments.
|
2011
|
+
class GoogleCloudRetailV2alphaExperimentInfo
|
2012
|
+
include Google::Apis::Core::Hashable
|
2013
|
+
|
2014
|
+
# The fully qualified resource name of the experiment that provides the serving
|
2015
|
+
# config under test, should an active experiment exist. For example: `projects/*/
|
2016
|
+
# locations/global/catalogs/default_catalog/experiments/experiment_id`
|
2017
|
+
# Corresponds to the JSON property `experimentName`
|
2018
|
+
# @return [String]
|
2019
|
+
attr_accessor :experiment_name
|
2020
|
+
|
2021
|
+
# Metadata for active serving config A/B tests.
|
2022
|
+
# Corresponds to the JSON property `servingConfigExperiment`
|
2023
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment]
|
2024
|
+
attr_accessor :serving_config_experiment
|
2025
|
+
|
2026
|
+
def initialize(**args)
|
2027
|
+
update!(**args)
|
2028
|
+
end
|
2029
|
+
|
2030
|
+
# Update properties of this object
|
2031
|
+
def update!(**args)
|
2032
|
+
@experiment_name = args[:experiment_name] if args.key?(:experiment_name)
|
2033
|
+
@serving_config_experiment = args[:serving_config_experiment] if args.key?(:serving_config_experiment)
|
2034
|
+
end
|
2035
|
+
end
|
2036
|
+
|
2037
|
+
# Metadata for active serving config A/B tests.
|
2038
|
+
class GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment
|
2039
|
+
include Google::Apis::Core::Hashable
|
2040
|
+
|
2041
|
+
# The fully qualified resource name of the serving config VariantArm.
|
2042
|
+
# serving_config_id responsible for generating the search response. For example:
|
2043
|
+
# `projects/*/locations/*/catalogs/*/servingConfigs/*`.
|
2044
|
+
# Corresponds to the JSON property `experimentServingConfig`
|
2045
|
+
# @return [String]
|
2046
|
+
attr_accessor :experiment_serving_config
|
2047
|
+
|
2048
|
+
# The fully qualified resource name of the original SearchRequest.placement in
|
2049
|
+
# the search request prior to reassignment by experiment API. For example: `
|
2050
|
+
# projects/*/locations/*/catalogs/*/servingConfigs/*`.
|
2051
|
+
# Corresponds to the JSON property `originalServingConfig`
|
2052
|
+
# @return [String]
|
2053
|
+
attr_accessor :original_serving_config
|
2054
|
+
|
2055
|
+
def initialize(**args)
|
2056
|
+
update!(**args)
|
2057
|
+
end
|
2058
|
+
|
2059
|
+
# Update properties of this object
|
2060
|
+
def update!(**args)
|
2061
|
+
@experiment_serving_config = args[:experiment_serving_config] if args.key?(:experiment_serving_config)
|
2062
|
+
@original_serving_config = args[:original_serving_config] if args.key?(:original_serving_config)
|
2063
|
+
end
|
2064
|
+
end
|
2065
|
+
|
1795
2066
|
# Configuration of destination for Export related errors.
|
1796
2067
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
1797
2068
|
include Google::Apis::Core::Hashable
|
@@ -3029,8 +3300,9 @@ module Google
|
|
3029
3300
|
# filterSyntaxV2` is set to true under the `params` field, then attribute-based
|
3030
3301
|
# expressions are expected instead of the above described tag-based syntax.
|
3031
3302
|
# Examples: * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) *
|
3032
|
-
# (
|
3033
|
-
#
|
3303
|
+
# (brands: ANY("Pixel")) AND (colors: ANY("Red") OR categories: ANY("Phones"))
|
3304
|
+
# For more information, see [Filter recommendations](https://cloud.google.com/
|
3305
|
+
# retail/docs/filter-recs).
|
3034
3306
|
# Corresponds to the JSON property `filter`
|
3035
3307
|
# @return [String]
|
3036
3308
|
attr_accessor :filter
|
@@ -5287,6 +5559,12 @@ module Google
|
|
5287
5559
|
# @return [String]
|
5288
5560
|
attr_accessor :corrected_query
|
5289
5561
|
|
5562
|
+
# Metadata related to A/B testing Experiment associated with this response. Only
|
5563
|
+
# exists when an experiment is triggered.
|
5564
|
+
# Corresponds to the JSON property `experimentInfo`
|
5565
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfo>]
|
5566
|
+
attr_accessor :experiment_info
|
5567
|
+
|
5290
5568
|
# Results of facets requested by user.
|
5291
5569
|
# Corresponds to the JSON property `facets`
|
5292
5570
|
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>]
|
@@ -5338,6 +5616,7 @@ module Google
|
|
5338
5616
|
@applied_controls = args[:applied_controls] if args.key?(:applied_controls)
|
5339
5617
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
5340
5618
|
@corrected_query = args[:corrected_query] if args.key?(:corrected_query)
|
5619
|
+
@experiment_info = args[:experiment_info] if args.key?(:experiment_info)
|
5341
5620
|
@facets = args[:facets] if args.key?(:facets)
|
5342
5621
|
@invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
|
5343
5622
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.68.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 = "
|
25
|
+
REVISION = "20230202"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -88,6 +88,12 @@ module Google
|
|
88
88
|
include Google::Apis::Core::JsonObjectSupport
|
89
89
|
end
|
90
90
|
|
91
|
+
class GoogleCloudRetailV2CreateModelMetadata
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
93
|
+
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
95
|
+
end
|
96
|
+
|
91
97
|
class GoogleCloudRetailV2ImportCompletionDataResponse
|
92
98
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
93
99
|
|
@@ -118,6 +124,18 @@ module Google
|
|
118
124
|
include Google::Apis::Core::JsonObjectSupport
|
119
125
|
end
|
120
126
|
|
127
|
+
class GoogleCloudRetailV2Model
|
128
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
129
|
+
|
130
|
+
include Google::Apis::Core::JsonObjectSupport
|
131
|
+
end
|
132
|
+
|
133
|
+
class GoogleCloudRetailV2ModelServingConfigList
|
134
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
|
+
|
136
|
+
include Google::Apis::Core::JsonObjectSupport
|
137
|
+
end
|
138
|
+
|
121
139
|
class GoogleCloudRetailV2PurgeMetadata
|
122
140
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
123
141
|
|
@@ -178,6 +196,18 @@ module Google
|
|
178
196
|
include Google::Apis::Core::JsonObjectSupport
|
179
197
|
end
|
180
198
|
|
199
|
+
class GoogleCloudRetailV2TuneModelMetadata
|
200
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
201
|
+
|
202
|
+
include Google::Apis::Core::JsonObjectSupport
|
203
|
+
end
|
204
|
+
|
205
|
+
class GoogleCloudRetailV2TuneModelResponse
|
206
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
207
|
+
|
208
|
+
include Google::Apis::Core::JsonObjectSupport
|
209
|
+
end
|
210
|
+
|
181
211
|
class GoogleCloudRetailV2UserEventImportSummary
|
182
212
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
213
|
|
@@ -364,6 +394,18 @@ module Google
|
|
364
394
|
include Google::Apis::Core::JsonObjectSupport
|
365
395
|
end
|
366
396
|
|
397
|
+
class GoogleCloudRetailV2alphaExperimentInfo
|
398
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
|
+
|
400
|
+
include Google::Apis::Core::JsonObjectSupport
|
401
|
+
end
|
402
|
+
|
403
|
+
class GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment
|
404
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
|
+
|
406
|
+
include Google::Apis::Core::JsonObjectSupport
|
407
|
+
end
|
408
|
+
|
367
409
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
368
410
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
369
411
|
|
@@ -1297,6 +1339,13 @@ module Google
|
|
1297
1339
|
end
|
1298
1340
|
end
|
1299
1341
|
|
1342
|
+
class GoogleCloudRetailV2CreateModelMetadata
|
1343
|
+
# @private
|
1344
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1345
|
+
property :model, as: 'model'
|
1346
|
+
end
|
1347
|
+
end
|
1348
|
+
|
1300
1349
|
class GoogleCloudRetailV2ImportCompletionDataResponse
|
1301
1350
|
# @private
|
1302
1351
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1346,6 +1395,34 @@ module Google
|
|
1346
1395
|
end
|
1347
1396
|
end
|
1348
1397
|
|
1398
|
+
class GoogleCloudRetailV2Model
|
1399
|
+
# @private
|
1400
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1401
|
+
property :create_time, as: 'createTime'
|
1402
|
+
property :data_state, as: 'dataState'
|
1403
|
+
property :display_name, as: 'displayName'
|
1404
|
+
property :filtering_option, as: 'filteringOption'
|
1405
|
+
property :last_tune_time, as: 'lastTuneTime'
|
1406
|
+
property :name, as: 'name'
|
1407
|
+
property :optimization_objective, as: 'optimizationObjective'
|
1408
|
+
property :periodic_tuning_state, as: 'periodicTuningState'
|
1409
|
+
collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelServingConfigList, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelServingConfigList::Representation
|
1410
|
+
|
1411
|
+
property :serving_state, as: 'servingState'
|
1412
|
+
property :training_state, as: 'trainingState'
|
1413
|
+
property :tuning_operation, as: 'tuningOperation'
|
1414
|
+
property :type, as: 'type'
|
1415
|
+
property :update_time, as: 'updateTime'
|
1416
|
+
end
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
class GoogleCloudRetailV2ModelServingConfigList
|
1420
|
+
# @private
|
1421
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1422
|
+
collection :serving_config_ids, as: 'servingConfigIds'
|
1423
|
+
end
|
1424
|
+
end
|
1425
|
+
|
1349
1426
|
class GoogleCloudRetailV2PurgeMetadata
|
1350
1427
|
# @private
|
1351
1428
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1408,6 +1485,19 @@ module Google
|
|
1408
1485
|
end
|
1409
1486
|
end
|
1410
1487
|
|
1488
|
+
class GoogleCloudRetailV2TuneModelMetadata
|
1489
|
+
# @private
|
1490
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1491
|
+
property :model, as: 'model'
|
1492
|
+
end
|
1493
|
+
end
|
1494
|
+
|
1495
|
+
class GoogleCloudRetailV2TuneModelResponse
|
1496
|
+
# @private
|
1497
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1498
|
+
end
|
1499
|
+
end
|
1500
|
+
|
1411
1501
|
class GoogleCloudRetailV2UserEventImportSummary
|
1412
1502
|
# @private
|
1413
1503
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1696,6 +1786,23 @@ module Google
|
|
1696
1786
|
end
|
1697
1787
|
end
|
1698
1788
|
|
1789
|
+
class GoogleCloudRetailV2alphaExperimentInfo
|
1790
|
+
# @private
|
1791
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1792
|
+
property :experiment_name, as: 'experimentName'
|
1793
|
+
property :serving_config_experiment, as: 'servingConfigExperiment', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment::Representation
|
1794
|
+
|
1795
|
+
end
|
1796
|
+
end
|
1797
|
+
|
1798
|
+
class GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment
|
1799
|
+
# @private
|
1800
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1801
|
+
property :experiment_serving_config, as: 'experimentServingConfig'
|
1802
|
+
property :original_serving_config, as: 'originalServingConfig'
|
1803
|
+
end
|
1804
|
+
end
|
1805
|
+
|
1699
1806
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
1700
1807
|
# @private
|
1701
1808
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2542,6 +2649,8 @@ module Google
|
|
2542
2649
|
collection :applied_controls, as: 'appliedControls'
|
2543
2650
|
property :attribution_token, as: 'attributionToken'
|
2544
2651
|
property :corrected_query, as: 'correctedQuery'
|
2652
|
+
collection :experiment_info, as: 'experimentInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfo::Representation
|
2653
|
+
|
2545
2654
|
collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
|
2546
2655
|
|
2547
2656
|
collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec::Representation
|
@@ -653,8 +653,7 @@ module Google
|
|
653
653
|
# returned Operations will be obsolete after 1 day, and GetOperation API will
|
654
654
|
# return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
|
655
655
|
# associated with the stale updates will not be marked as done until being
|
656
|
-
# obsolete.
|
657
|
-
# enabled. Enable Retail Search on Cloud Console before using this feature.
|
656
|
+
# obsolete.
|
658
657
|
# @param [String] product
|
659
658
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
660
659
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -702,9 +701,7 @@ module Google
|
|
702
701
|
# inventories. The returned Operations will be obsolete after 1 day, and
|
703
702
|
# GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
|
704
703
|
# issued, the Operations associated with the stale updates will not be marked as
|
705
|
-
# done until being obsolete.
|
706
|
-
# Retail Search enabled. Enable Retail Search on Cloud Console before using this
|
707
|
-
# feature.
|
704
|
+
# done until being obsolete.
|
708
705
|
# @param [String] product
|
709
706
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
710
707
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -794,6 +791,12 @@ module Google
|
|
794
791
|
# Product.Type.PRIMARY Product with more than one variants. Otherwise, an
|
795
792
|
# INVALID_ARGUMENT error is returned. All inventory information for the named
|
796
793
|
# Product will be deleted.
|
794
|
+
# @param [Boolean] cascade_delete
|
795
|
+
# This value only applies to the case when the target product is of type PRIMARY.
|
796
|
+
# When deleting a product of VARIANT/COLLECTION type, this value will be
|
797
|
+
# ignored. When set to true, the subsequent variant products will be deleted.
|
798
|
+
# When set to false, if the primary product has active variant products, an
|
799
|
+
# error will be returned.
|
797
800
|
# @param [String] fields
|
798
801
|
# Selector specifying which fields to include in a partial response.
|
799
802
|
# @param [String] quota_user
|
@@ -811,11 +814,12 @@ module Google
|
|
811
814
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
812
815
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
813
816
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
814
|
-
def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
|
817
|
+
def delete_project_location_catalog_branch_product(name, cascade_delete: nil, fields: nil, quota_user: nil, options: nil, &block)
|
815
818
|
command = make_simple_command(:delete, 'v2alpha/{+name}', options)
|
816
819
|
command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
|
817
820
|
command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
|
818
821
|
command.params['name'] = name unless name.nil?
|
822
|
+
command.query['cascadeDelete'] = cascade_delete unless cascade_delete.nil?
|
819
823
|
command.query['fields'] = fields unless fields.nil?
|
820
824
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
821
825
|
execute_or_queue_command(command, &block)
|
@@ -1061,8 +1065,7 @@ module Google
|
|
1061
1065
|
# returned Operations will be obsolete after 1 day, and GetOperation API will
|
1062
1066
|
# return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
|
1063
1067
|
# associated with the stale updates will not be marked as done until being
|
1064
|
-
# obsolete.
|
1065
|
-
# enabled. Enable Retail Search on Cloud Console before using this feature.
|
1068
|
+
# obsolete.
|
1066
1069
|
# @param [String] product
|
1067
1070
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
1068
1071
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -1108,9 +1111,7 @@ module Google
|
|
1108
1111
|
# inventories. The returned Operations will be obsolete after 1 day, and
|
1109
1112
|
# GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
|
1110
1113
|
# issued, the Operations associated with the stale updates will not be marked as
|
1111
|
-
# done until being obsolete.
|
1112
|
-
# Retail Search enabled. Enable Retail Search on Cloud Console before using this
|
1113
|
-
# feature.
|
1114
|
+
# done until being obsolete.
|
1114
1115
|
# @param [String] product
|
1115
1116
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
1116
1117
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -1166,9 +1167,7 @@ module Google
|
|
1166
1167
|
# RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
|
1167
1168
|
# and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
|
1168
1169
|
# updates are issued, the Operations associated with the stale updates are not
|
1169
|
-
# marked as done until they are obsolete.
|
1170
|
-
# users who have Retail Search enabled. Enable Retail Search on Cloud Console
|
1171
|
-
# before using this feature.
|
1170
|
+
# marked as done until they are obsolete.
|
1172
1171
|
# @param [String] name
|
1173
1172
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
1174
1173
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
@@ -1502,6 +1501,37 @@ module Google
|
|
1502
1501
|
execute_or_queue_command(command, &block)
|
1503
1502
|
end
|
1504
1503
|
|
1504
|
+
# Gets a model.
|
1505
|
+
# @param [String] name
|
1506
|
+
# Required. The resource name of the Model to get. Format: `projects/`
|
1507
|
+
# project_number`/locations/`location_id`/catalogs/`catalog`/models/`model_id``
|
1508
|
+
# @param [String] fields
|
1509
|
+
# Selector specifying which fields to include in a partial response.
|
1510
|
+
# @param [String] quota_user
|
1511
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1512
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1513
|
+
# @param [Google::Apis::RequestOptions] options
|
1514
|
+
# Request-specific options
|
1515
|
+
#
|
1516
|
+
# @yield [result, err] Result & error if block supplied
|
1517
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
|
1518
|
+
# @yieldparam err [StandardError] error object if request failed
|
1519
|
+
#
|
1520
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
|
1521
|
+
#
|
1522
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1523
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1524
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1525
|
+
def get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
|
1526
|
+
command = make_simple_command(:get, 'v2alpha/{+name}', options)
|
1527
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
1528
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
|
1529
|
+
command.params['name'] = name unless name.nil?
|
1530
|
+
command.query['fields'] = fields unless fields.nil?
|
1531
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1532
|
+
execute_or_queue_command(command, &block)
|
1533
|
+
end
|
1534
|
+
|
1505
1535
|
# Lists all the models linked to this event store.
|
1506
1536
|
# @param [String] parent
|
1507
1537
|
# Required. The parent for which to list models. Format: `projects/`
|
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.
|
4
|
+
version: 0.68.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-
|
11
|
+
date: 2023-02-12 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.68.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: []
|