google-apis-retail_v2beta 0.50.0 → 0.53.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -365,8 +365,8 @@ module Google
|
|
365
365
|
include Google::Apis::Core::Hashable
|
366
366
|
|
367
367
|
# Google Cloud Storage prefix for import errors. This must be an empty, existing
|
368
|
-
# Cloud Storage directory. Import errors
|
369
|
-
#
|
368
|
+
# Cloud Storage directory. Import errors are written to sharded files in this
|
369
|
+
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
370
370
|
# Corresponds to the JSON property `gcsPrefix`
|
371
371
|
# @return [String]
|
372
372
|
attr_accessor :gcs_prefix
|
@@ -381,8 +381,8 @@ module Google
|
|
381
381
|
end
|
382
382
|
end
|
383
383
|
|
384
|
-
# Metadata related to the progress of the Import operation. This
|
385
|
-
#
|
384
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
385
|
+
# the google.longrunning.Operation.metadata field.
|
386
386
|
class GoogleCloudRetailV2ImportMetadata
|
387
387
|
include Google::Apis::Core::Hashable
|
388
388
|
|
@@ -397,9 +397,9 @@ module Google
|
|
397
397
|
attr_accessor :failure_count
|
398
398
|
|
399
399
|
# Pub/Sub topic for receiving notification. If this field is set, when the
|
400
|
-
# import is finished, a notification
|
401
|
-
#
|
402
|
-
#
|
400
|
+
# import is finished, a notification is sent to specified Pub/Sub topic. The
|
401
|
+
# message data is JSON string of a Operation. Format of the Pub/Sub topic is `
|
402
|
+
# projects/`project`/topics/`topic``.
|
403
403
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
404
404
|
# @return [String]
|
405
405
|
attr_accessor :notification_pubsub_topic
|
@@ -531,7 +531,7 @@ module Google
|
|
531
531
|
end
|
532
532
|
end
|
533
533
|
|
534
|
-
# Metadata for RejoinUserEvents method.
|
534
|
+
# Metadata for `RejoinUserEvents` method.
|
535
535
|
class GoogleCloudRetailV2RejoinUserEventsMetadata
|
536
536
|
include Google::Apis::Core::Hashable
|
537
537
|
|
@@ -544,7 +544,7 @@ module Google
|
|
544
544
|
end
|
545
545
|
end
|
546
546
|
|
547
|
-
# Response message for RejoinUserEvents method.
|
547
|
+
# Response message for `RejoinUserEvents` method.
|
548
548
|
class GoogleCloudRetailV2RejoinUserEventsResponse
|
549
549
|
include Google::Apis::Core::Hashable
|
550
550
|
|
@@ -768,8 +768,9 @@ module Google
|
|
768
768
|
class GoogleCloudRetailV2alphaCreateModelMetadata
|
769
769
|
include Google::Apis::Core::Hashable
|
770
770
|
|
771
|
-
# The resource name of the model that this create applies to. Format: projects/`
|
771
|
+
# The resource name of the model that this create applies to. Format: `projects/`
|
772
772
|
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
773
|
+
# `
|
773
774
|
# Corresponds to the JSON property `model`
|
774
775
|
# @return [String]
|
775
776
|
attr_accessor :model
|
@@ -805,8 +806,8 @@ module Google
|
|
805
806
|
end
|
806
807
|
end
|
807
808
|
|
808
|
-
# Metadata related to the progress of the Export operation. This
|
809
|
-
#
|
809
|
+
# Metadata related to the progress of the Export operation. This is returned by
|
810
|
+
# the google.longrunning.Operation.metadata field.
|
810
811
|
class GoogleCloudRetailV2alphaExportMetadata
|
811
812
|
include Google::Apis::Core::Hashable
|
812
813
|
|
@@ -924,8 +925,8 @@ module Google
|
|
924
925
|
include Google::Apis::Core::Hashable
|
925
926
|
|
926
927
|
# Google Cloud Storage prefix for import errors. This must be an empty, existing
|
927
|
-
# Cloud Storage directory. Import errors
|
928
|
-
#
|
928
|
+
# Cloud Storage directory. Import errors are written to sharded files in this
|
929
|
+
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
929
930
|
# Corresponds to the JSON property `gcsPrefix`
|
930
931
|
# @return [String]
|
931
932
|
attr_accessor :gcs_prefix
|
@@ -940,8 +941,8 @@ module Google
|
|
940
941
|
end
|
941
942
|
end
|
942
943
|
|
943
|
-
# Metadata related to the progress of the Import operation. This
|
944
|
-
#
|
944
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
945
|
+
# the google.longrunning.Operation.metadata field.
|
945
946
|
class GoogleCloudRetailV2alphaImportMetadata
|
946
947
|
include Google::Apis::Core::Hashable
|
947
948
|
|
@@ -956,9 +957,9 @@ module Google
|
|
956
957
|
attr_accessor :failure_count
|
957
958
|
|
958
959
|
# Pub/Sub topic for receiving notification. If this field is set, when the
|
959
|
-
# import is finished, a notification
|
960
|
-
#
|
961
|
-
#
|
960
|
+
# import is finished, a notification is sent to specified Pub/Sub topic. The
|
961
|
+
# message data is JSON string of a Operation. Format of the Pub/Sub topic is `
|
962
|
+
# projects/`project`/topics/`topic``.
|
962
963
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
963
964
|
# @return [String]
|
964
965
|
attr_accessor :notification_pubsub_topic
|
@@ -1063,7 +1064,7 @@ module Google
|
|
1063
1064
|
|
1064
1065
|
# Metadata that describes the training and serving parameters of a Model. A
|
1065
1066
|
# Model can be associated with a ServingConfig and then queried through the
|
1066
|
-
# Predict
|
1067
|
+
# Predict API.
|
1067
1068
|
class GoogleCloudRetailV2alphaModel
|
1068
1069
|
include Google::Apis::Core::Hashable
|
1069
1070
|
|
@@ -1072,23 +1073,23 @@ module Google
|
|
1072
1073
|
# @return [String]
|
1073
1074
|
attr_accessor :create_time
|
1074
1075
|
|
1075
|
-
# Output only. The state of data requirements for this model: DATA_OK and
|
1076
|
-
# DATA_ERROR
|
1077
|
-
# DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
|
1078
|
-
# serving state is ACTIVE
|
1076
|
+
# Output only. The state of data requirements for this model: `DATA_OK` and `
|
1077
|
+
# DATA_ERROR`. Recommendation model cannot be trained if the data is in `
|
1078
|
+
# DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
|
1079
|
+
# serving state is `ACTIVE`: models were trained successfully before, but cannot
|
1079
1080
|
# be refreshed because model no longer has sufficient data for training.
|
1080
1081
|
# Corresponds to the JSON property `dataState`
|
1081
1082
|
# @return [String]
|
1082
1083
|
attr_accessor :data_state
|
1083
1084
|
|
1084
1085
|
# Required. The display name of the model. Should be human readable, used to
|
1085
|
-
# display Recommendation Models in the Retail Cloud
|
1086
|
+
# display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
|
1086
1087
|
# encoded string with limit of 1024 characters.
|
1087
1088
|
# Corresponds to the JSON property `displayName`
|
1088
1089
|
# @return [String]
|
1089
1090
|
attr_accessor :display_name
|
1090
1091
|
|
1091
|
-
# Optional. If RECOMMENDATIONS_FILTERING_ENABLED
|
1092
|
+
# Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
|
1092
1093
|
# attributes is enabled for the model.
|
1093
1094
|
# Corresponds to the JSON property `filteringOption`
|
1094
1095
|
# @return [String]
|
@@ -1099,9 +1100,10 @@ module Google
|
|
1099
1100
|
# @return [String]
|
1100
1101
|
attr_accessor :last_tune_time
|
1101
1102
|
|
1102
|
-
# Required. The fully qualified resource name of the model. Format: projects/`
|
1103
|
+
# Required. The fully qualified resource name of the model. Format: `projects/`
|
1103
1104
|
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
1104
|
-
# catalog_id has char limit of 50. recommendation_model_id has char limit of
|
1105
|
+
# ` catalog_id has char limit of 50. recommendation_model_id has char limit of
|
1106
|
+
# 40.
|
1105
1107
|
# Corresponds to the JSON property `name`
|
1106
1108
|
# @return [String]
|
1107
1109
|
attr_accessor :name
|
@@ -1124,8 +1126,8 @@ module Google
|
|
1124
1126
|
attr_accessor :page_optimization_config
|
1125
1127
|
|
1126
1128
|
# Optional. The state of periodic tuning. The period we use is 3 months - to do
|
1127
|
-
# a one-off tune earlier use the TuneModel method. Default value is
|
1128
|
-
# PERIODIC_TUNING_ENABLED
|
1129
|
+
# a one-off tune earlier use the `TuneModel` method. Default value is `
|
1130
|
+
# PERIODIC_TUNING_ENABLED`.
|
1129
1131
|
# Corresponds to the JSON property `periodicTuningState`
|
1130
1132
|
# @return [String]
|
1131
1133
|
attr_accessor :periodic_tuning_state
|
@@ -1136,16 +1138,16 @@ module Google
|
|
1136
1138
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelServingConfigList>]
|
1137
1139
|
attr_accessor :serving_config_lists
|
1138
1140
|
|
1139
|
-
# Output only. The serving state of the model: ACTIVE
|
1141
|
+
# Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
|
1140
1142
|
# Corresponds to the JSON property `servingState`
|
1141
1143
|
# @return [String]
|
1142
1144
|
attr_accessor :serving_state
|
1143
1145
|
|
1144
|
-
# Optional. The training state that the model is in (e.g. TRAINING or PAUSED)
|
1145
|
-
# Since part of the cost of running the service is frequency of training -
|
1146
|
-
# can be used to determine when to train model in order to control cost. If
|
1147
|
-
# specified: the default value for CreateModel method is TRAINING
|
1148
|
-
# value for UpdateModel method is to keep the state the same as before.
|
1146
|
+
# Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
|
1147
|
+
# . Since part of the cost of running the service is frequency of training -
|
1148
|
+
# this can be used to determine when to train model in order to control cost. If
|
1149
|
+
# not specified: the default value for `CreateModel` method is `TRAINING`. The
|
1150
|
+
# default value for `UpdateModel` method is to keep the state the same as before.
|
1149
1151
|
# Corresponds to the JSON property `trainingState`
|
1150
1152
|
# @return [String]
|
1151
1153
|
attr_accessor :training_state
|
@@ -1159,7 +1161,7 @@ module Google
|
|
1159
1161
|
|
1160
1162
|
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
1161
1163
|
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
1162
|
-
# page-optimization`,
|
1164
|
+
# page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(
|
1163
1165
|
# readonly value).
|
1164
1166
|
# Corresponds to the JSON property `type`
|
1165
1167
|
# @return [String]
|
@@ -1244,9 +1246,10 @@ module Google
|
|
1244
1246
|
class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
|
1245
1247
|
include Google::Apis::Core::Hashable
|
1246
1248
|
|
1247
|
-
# This has to be a valid ServingConfig identifier.
|
1248
|
-
# full name: `projects/*/locations/global/catalogs/
|
1249
|
-
# servingConfigs/my_candidate_config
|
1249
|
+
# This has to be a valid ServingConfig identifier. For example, for a
|
1250
|
+
# ServingConfig with full name: `projects/*/locations/global/catalogs/
|
1251
|
+
# default_catalog/servingConfigs/my_candidate_config`, this would be `
|
1252
|
+
# my_candidate_config`.
|
1250
1253
|
# Corresponds to the JSON property `servingConfigId`
|
1251
1254
|
# @return [String]
|
1252
1255
|
attr_accessor :serving_config_id
|
@@ -1293,13 +1296,13 @@ module Google
|
|
1293
1296
|
end
|
1294
1297
|
end
|
1295
1298
|
|
1296
|
-
# Represents an ordered combination of valid serving configs, which
|
1297
|
-
#
|
1299
|
+
# Represents an ordered combination of valid serving configs, which can be used
|
1300
|
+
# for `PAGE_OPTIMIZATION` recommendations.
|
1298
1301
|
class GoogleCloudRetailV2alphaModelServingConfigList
|
1299
1302
|
include Google::Apis::Core::Hashable
|
1300
1303
|
|
1301
|
-
# Optional. A set of valid serving configs that may be used for
|
1302
|
-
# PAGE_OPTIMIZATION
|
1304
|
+
# Optional. A set of valid serving configs that may be used for `
|
1305
|
+
# PAGE_OPTIMIZATION`.
|
1303
1306
|
# Corresponds to the JSON property `servingConfigIds`
|
1304
1307
|
# @return [Array<String>]
|
1305
1308
|
attr_accessor :serving_config_ids
|
@@ -1436,7 +1439,7 @@ module Google
|
|
1436
1439
|
end
|
1437
1440
|
end
|
1438
1441
|
|
1439
|
-
# Metadata for RejoinUserEvents method.
|
1442
|
+
# Metadata for `RejoinUserEvents` method.
|
1440
1443
|
class GoogleCloudRetailV2alphaRejoinUserEventsMetadata
|
1441
1444
|
include Google::Apis::Core::Hashable
|
1442
1445
|
|
@@ -1449,7 +1452,7 @@ module Google
|
|
1449
1452
|
end
|
1450
1453
|
end
|
1451
1454
|
|
1452
|
-
# Response message for RejoinUserEvents method.
|
1455
|
+
# Response message for `RejoinUserEvents` method.
|
1453
1456
|
class GoogleCloudRetailV2alphaRejoinUserEventsResponse
|
1454
1457
|
include Google::Apis::Core::Hashable
|
1455
1458
|
|
@@ -1587,8 +1590,9 @@ module Google
|
|
1587
1590
|
class GoogleCloudRetailV2alphaTuneModelMetadata
|
1588
1591
|
include Google::Apis::Core::Hashable
|
1589
1592
|
|
1590
|
-
# The resource name of the model that this tune applies to. Format: projects/`
|
1593
|
+
# The resource name of the model that this tune applies to. Format: `projects/`
|
1591
1594
|
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
1595
|
+
# `
|
1592
1596
|
# Corresponds to the JSON property `model`
|
1593
1597
|
# @return [String]
|
1594
1598
|
attr_accessor :model
|
@@ -2264,7 +2268,7 @@ module Google
|
|
2264
2268
|
# CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
|
2265
2269
|
# recent searches satisfy the follow rules: * They are ordered from latest to
|
2266
2270
|
# oldest. * They are matched with CompleteQueryRequest.query case insensitively.
|
2267
|
-
# * They are transformed to lower
|
2271
|
+
# * They are transformed to lower case. * They are UTF-8 safe. Recent searches
|
2268
2272
|
# are deduplicated. More recent searches will be reserved when duplication
|
2269
2273
|
# happens.
|
2270
2274
|
# Corresponds to the JSON property `recentSearchResults`
|
@@ -2526,8 +2530,8 @@ module Google
|
|
2526
2530
|
|
2527
2531
|
# The value of the term to match on. Value cannot be empty. Value can have at
|
2528
2532
|
# most 3 terms if specified as a partial match. Each space separated string is
|
2529
|
-
# considered as one term.
|
2530
|
-
# 4 terms and not allowed for partial match.
|
2533
|
+
# considered as one term. For example, "a b c" is 3 terms and allowed, but " a b
|
2534
|
+
# c d" is 4 terms and not allowed for a partial match.
|
2531
2535
|
# Corresponds to the JSON property `value`
|
2532
2536
|
# @return [String]
|
2533
2537
|
attr_accessor :value
|
@@ -2569,14 +2573,14 @@ module Google
|
|
2569
2573
|
end
|
2570
2574
|
end
|
2571
2575
|
|
2572
|
-
# Configures dynamic
|
2573
|
-
# search
|
2576
|
+
# Configures dynamic metadata that can be linked to a ServingConfig and affect
|
2577
|
+
# search or recommendation results at serving time.
|
2574
2578
|
class GoogleCloudRetailV2betaControl
|
2575
2579
|
include Google::Apis::Core::Hashable
|
2576
2580
|
|
2577
|
-
# Output only. List of serving configuration ids that
|
2578
|
-
#
|
2579
|
-
# an output only
|
2581
|
+
# Output only. List of serving configuration ids that are associated with this
|
2582
|
+
# control in the same Catalog. Note the association is managed via the
|
2583
|
+
# ServingConfig, this is an output only denormalized view.
|
2580
2584
|
# Corresponds to the JSON property `associatedServingConfigIds`
|
2581
2585
|
# @return [Array<String>]
|
2582
2586
|
attr_accessor :associated_serving_config_ids
|
@@ -2600,13 +2604,21 @@ module Google
|
|
2600
2604
|
attr_accessor :name
|
2601
2605
|
|
2602
2606
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
2603
|
-
# triggered. * An action specifies what occurs on that trigger. Currently
|
2604
|
-
#
|
2607
|
+
# triggered. * An action specifies what occurs on that trigger. Currently rules
|
2608
|
+
# only work for controls with SOLUTION_TYPE_SEARCH.
|
2605
2609
|
# Corresponds to the JSON property `rule`
|
2606
2610
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule]
|
2607
2611
|
attr_accessor :rule
|
2608
2612
|
|
2609
|
-
#
|
2613
|
+
# Specifies the use case for the control. Affects what condition fields can be
|
2614
|
+
# set. Only settable by search controls. Will default to
|
2615
|
+
# SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
|
2616
|
+
# search_solution_use_case per control.
|
2617
|
+
# Corresponds to the JSON property `searchSolutionUseCase`
|
2618
|
+
# @return [Array<String>]
|
2619
|
+
attr_accessor :search_solution_use_case
|
2620
|
+
|
2621
|
+
# Required. Immutable. The solution types that the control is used for.
|
2610
2622
|
# Currently we support setting only one type of solution at creation time. Only `
|
2611
2623
|
# SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
|
2612
2624
|
# provided at creation time, will default to SOLUTION_TYPE_SEARCH.
|
@@ -2625,6 +2637,7 @@ module Google
|
|
2625
2637
|
@facet_spec = args[:facet_spec] if args.key?(:facet_spec)
|
2626
2638
|
@name = args[:name] if args.key?(:name)
|
2627
2639
|
@rule = args[:rule] if args.key?(:rule)
|
2640
|
+
@search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
|
2628
2641
|
@solution_types = args[:solution_types] if args.key?(:solution_types)
|
2629
2642
|
end
|
2630
2643
|
end
|
@@ -2707,8 +2720,8 @@ module Google
|
|
2707
2720
|
end
|
2708
2721
|
end
|
2709
2722
|
|
2710
|
-
# Metadata related to the progress of the Export operation. This
|
2711
|
-
#
|
2723
|
+
# Metadata related to the progress of the Export operation. This is returned by
|
2724
|
+
# the google.longrunning.Operation.metadata field.
|
2712
2725
|
class GoogleCloudRetailV2betaExportMetadata
|
2713
2726
|
include Google::Apis::Core::Hashable
|
2714
2727
|
|
@@ -2836,7 +2849,7 @@ module Google
|
|
2836
2849
|
end
|
2837
2850
|
end
|
2838
2851
|
|
2839
|
-
# Google Cloud Storage location for input content.
|
2852
|
+
# Google Cloud Storage location for input content.
|
2840
2853
|
class GoogleCloudRetailV2betaGcsSource
|
2841
2854
|
include Google::Apis::Core::Hashable
|
2842
2855
|
|
@@ -2847,8 +2860,8 @@ module Google
|
|
2847
2860
|
# recommendations-ai/docs/upload-catalog#mc). Supported values for user events
|
2848
2861
|
# imports: * `user_event` (default): One JSON UserEvent per line. * `
|
2849
2862
|
# user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
|
2850
|
-
# Supported values for control imports: *
|
2851
|
-
# per line. Supported values for catalog attribute imports: *
|
2863
|
+
# Supported values for control imports: * `control` (default): One JSON Control
|
2864
|
+
# per line. Supported values for catalog attribute imports: * `catalog_attribute`
|
2852
2865
|
# (default): One CSV CatalogAttribute per line.
|
2853
2866
|
# Corresponds to the JSON property `dataSchema`
|
2854
2867
|
# @return [String]
|
@@ -2958,9 +2971,9 @@ module Google
|
|
2958
2971
|
attr_accessor :input_config
|
2959
2972
|
|
2960
2973
|
# Pub/Sub topic for receiving notification. If this field is set, when the
|
2961
|
-
# import is finished, a notification
|
2962
|
-
#
|
2963
|
-
#
|
2974
|
+
# import is finished, a notification is sent to specified Pub/Sub topic. The
|
2975
|
+
# message data is JSON string of a Operation. Format of the Pub/Sub topic is `
|
2976
|
+
# projects/`project`/topics/`topic``.
|
2964
2977
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
2965
2978
|
# @return [String]
|
2966
2979
|
attr_accessor :notification_pubsub_topic
|
@@ -3002,8 +3015,8 @@ module Google
|
|
3002
3015
|
include Google::Apis::Core::Hashable
|
3003
3016
|
|
3004
3017
|
# Google Cloud Storage prefix for import errors. This must be an empty, existing
|
3005
|
-
# Cloud Storage directory. Import errors
|
3006
|
-
#
|
3018
|
+
# Cloud Storage directory. Import errors are written to sharded files in this
|
3019
|
+
# directory, one per line, as a JSON-encoded `google.rpc.Status` message.
|
3007
3020
|
# Corresponds to the JSON property `gcsPrefix`
|
3008
3021
|
# @return [String]
|
3009
3022
|
attr_accessor :gcs_prefix
|
@@ -3018,8 +3031,8 @@ module Google
|
|
3018
3031
|
end
|
3019
3032
|
end
|
3020
3033
|
|
3021
|
-
# Metadata related to the progress of the Import operation. This
|
3022
|
-
#
|
3034
|
+
# Metadata related to the progress of the Import operation. This is returned by
|
3035
|
+
# the google.longrunning.Operation.metadata field.
|
3023
3036
|
class GoogleCloudRetailV2betaImportMetadata
|
3024
3037
|
include Google::Apis::Core::Hashable
|
3025
3038
|
|
@@ -3034,9 +3047,9 @@ module Google
|
|
3034
3047
|
attr_accessor :failure_count
|
3035
3048
|
|
3036
3049
|
# Pub/Sub topic for receiving notification. If this field is set, when the
|
3037
|
-
# import is finished, a notification
|
3038
|
-
#
|
3039
|
-
#
|
3050
|
+
# import is finished, a notification is sent to specified Pub/Sub topic. The
|
3051
|
+
# message data is JSON string of a Operation. Format of the Pub/Sub topic is `
|
3052
|
+
# projects/`project`/topics/`topic``.
|
3040
3053
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
3041
3054
|
# @return [String]
|
3042
3055
|
attr_accessor :notification_pubsub_topic
|
@@ -3087,12 +3100,12 @@ module Google
|
|
3087
3100
|
attr_accessor :input_config
|
3088
3101
|
|
3089
3102
|
# Full Pub/Sub topic name for receiving notification. If this field is set, when
|
3090
|
-
# the import is finished, a notification
|
3091
|
-
#
|
3092
|
-
#
|
3093
|
-
#
|
3094
|
-
#
|
3095
|
-
#
|
3103
|
+
# the import is finished, a notification is sent to specified Pub/Sub topic. The
|
3104
|
+
# message data is JSON string of a Operation. Format of the Pub/Sub topic is `
|
3105
|
+
# projects/`project`/topics/`topic``. It has to be within the same project as
|
3106
|
+
# ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
|
3107
|
+
# gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
|
3108
|
+
# topic.
|
3096
3109
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
3097
3110
|
# @return [String]
|
3098
3111
|
attr_accessor :notification_pubsub_topic
|
@@ -3108,8 +3121,8 @@ module Google
|
|
3108
3121
|
# @return [String]
|
3109
3122
|
attr_accessor :request_id
|
3110
3123
|
|
3111
|
-
# Indicates which fields in the provided imported
|
3112
|
-
# set,
|
3124
|
+
# Indicates which fields in the provided imported `products` to update. If not
|
3125
|
+
# set, all fields are updated.
|
3113
3126
|
# Corresponds to the JSON property `updateMask`
|
3114
3127
|
# @return [String]
|
3115
3128
|
attr_accessor :update_mask
|
@@ -3303,6 +3316,31 @@ module Google
|
|
3303
3316
|
end
|
3304
3317
|
end
|
3305
3318
|
|
3319
|
+
# Response to a ListModelRequest.
|
3320
|
+
class GoogleCloudRetailV2betaListModelsResponse
|
3321
|
+
include Google::Apis::Core::Hashable
|
3322
|
+
|
3323
|
+
# List of Models.
|
3324
|
+
# Corresponds to the JSON property `models`
|
3325
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel>]
|
3326
|
+
attr_accessor :models
|
3327
|
+
|
3328
|
+
# Pagination token, if not returned indicates the last page.
|
3329
|
+
# Corresponds to the JSON property `nextPageToken`
|
3330
|
+
# @return [String]
|
3331
|
+
attr_accessor :next_page_token
|
3332
|
+
|
3333
|
+
def initialize(**args)
|
3334
|
+
update!(**args)
|
3335
|
+
end
|
3336
|
+
|
3337
|
+
# Update properties of this object
|
3338
|
+
def update!(**args)
|
3339
|
+
@models = args[:models] if args.key?(:models)
|
3340
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
3341
|
+
end
|
3342
|
+
end
|
3343
|
+
|
3306
3344
|
# Response message for ProductService.ListProducts method.
|
3307
3345
|
class GoogleCloudRetailV2betaListProductsResponse
|
3308
3346
|
include Google::Apis::Core::Hashable
|
@@ -3423,8 +3461,8 @@ module Google
|
|
3423
3461
|
attr_accessor :branch_id
|
3424
3462
|
|
3425
3463
|
# String representing the destination to import for, all if left empty. List of
|
3426
|
-
# possible values
|
3427
|
-
# answer/7501026
|
3464
|
+
# possible values is given in [Included destination](https://support.google.com/
|
3465
|
+
# merchants/answer/7501026). List of allowed string values: "Shopping_ads", "
|
3428
3466
|
# Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings"
|
3429
3467
|
# , "Free_local_listings" NOTE: The string values are case sensitive.
|
3430
3468
|
# Corresponds to the JSON property `destinations`
|
@@ -3489,6 +3527,154 @@ module Google
|
|
3489
3527
|
end
|
3490
3528
|
end
|
3491
3529
|
|
3530
|
+
# Metadata that describes the training and serving parameters of a Model. A
|
3531
|
+
# Model can be associated with a ServingConfig and then queried through the
|
3532
|
+
# Predict API.
|
3533
|
+
class GoogleCloudRetailV2betaModel
|
3534
|
+
include Google::Apis::Core::Hashable
|
3535
|
+
|
3536
|
+
# Output only. Timestamp the Recommendation Model was created at.
|
3537
|
+
# Corresponds to the JSON property `createTime`
|
3538
|
+
# @return [String]
|
3539
|
+
attr_accessor :create_time
|
3540
|
+
|
3541
|
+
# Output only. The state of data requirements for this model: `DATA_OK` and `
|
3542
|
+
# DATA_ERROR`. Recommendation model cannot be trained if the data is in `
|
3543
|
+
# DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
|
3544
|
+
# serving state is `ACTIVE`: models were trained successfully before, but cannot
|
3545
|
+
# be refreshed because model no longer has sufficient data for training.
|
3546
|
+
# Corresponds to the JSON property `dataState`
|
3547
|
+
# @return [String]
|
3548
|
+
attr_accessor :data_state
|
3549
|
+
|
3550
|
+
# Required. The display name of the model. Should be human readable, used to
|
3551
|
+
# display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
|
3552
|
+
# encoded string with limit of 1024 characters.
|
3553
|
+
# Corresponds to the JSON property `displayName`
|
3554
|
+
# @return [String]
|
3555
|
+
attr_accessor :display_name
|
3556
|
+
|
3557
|
+
# Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
|
3558
|
+
# attributes is enabled for the model.
|
3559
|
+
# Corresponds to the JSON property `filteringOption`
|
3560
|
+
# @return [String]
|
3561
|
+
attr_accessor :filtering_option
|
3562
|
+
|
3563
|
+
# Output only. The timestamp when the latest successful tune finished.
|
3564
|
+
# Corresponds to the JSON property `lastTuneTime`
|
3565
|
+
# @return [String]
|
3566
|
+
attr_accessor :last_tune_time
|
3567
|
+
|
3568
|
+
# Required. The fully qualified resource name of the model. Format: `projects/`
|
3569
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
3570
|
+
# ` catalog_id has char limit of 50. recommendation_model_id has char limit of
|
3571
|
+
# 40.
|
3572
|
+
# Corresponds to the JSON property `name`
|
3573
|
+
# @return [String]
|
3574
|
+
attr_accessor :name
|
3575
|
+
|
3576
|
+
# Optional. The optimization objective e.g. `cvr`. Currently supported values: `
|
3577
|
+
# ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
|
3578
|
+
# model type. Default depends on type of recommendation: `recommended-for-you` =>
|
3579
|
+
# `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
|
3580
|
+
# revenue_per_order`
|
3581
|
+
# Corresponds to the JSON property `optimizationObjective`
|
3582
|
+
# @return [String]
|
3583
|
+
attr_accessor :optimization_objective
|
3584
|
+
|
3585
|
+
# Optional. The state of periodic tuning. The period we use is 3 months - to do
|
3586
|
+
# a one-off tune earlier use the `TuneModel` method. Default value is `
|
3587
|
+
# PERIODIC_TUNING_ENABLED`.
|
3588
|
+
# Corresponds to the JSON property `periodicTuningState`
|
3589
|
+
# @return [String]
|
3590
|
+
attr_accessor :periodic_tuning_state
|
3591
|
+
|
3592
|
+
# Output only. The list of valid serving configs associated with the
|
3593
|
+
# PageOptimizationConfig.
|
3594
|
+
# Corresponds to the JSON property `servingConfigLists`
|
3595
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelServingConfigList>]
|
3596
|
+
attr_accessor :serving_config_lists
|
3597
|
+
|
3598
|
+
# Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
|
3599
|
+
# Corresponds to the JSON property `servingState`
|
3600
|
+
# @return [String]
|
3601
|
+
attr_accessor :serving_state
|
3602
|
+
|
3603
|
+
# Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
|
3604
|
+
# . Since part of the cost of running the service is frequency of training -
|
3605
|
+
# this can be used to determine when to train model in order to control cost. If
|
3606
|
+
# not specified: the default value for `CreateModel` method is `TRAINING`. The
|
3607
|
+
# default value for `UpdateModel` method is to keep the state the same as before.
|
3608
|
+
# Corresponds to the JSON property `trainingState`
|
3609
|
+
# @return [String]
|
3610
|
+
attr_accessor :training_state
|
3611
|
+
|
3612
|
+
# Output only. The tune operation associated with the model. Can be used to
|
3613
|
+
# determine if there is an ongoing tune for this recommendation. Empty field
|
3614
|
+
# implies no tune is goig on.
|
3615
|
+
# Corresponds to the JSON property `tuningOperation`
|
3616
|
+
# @return [String]
|
3617
|
+
attr_accessor :tuning_operation
|
3618
|
+
|
3619
|
+
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
3620
|
+
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
3621
|
+
# page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(
|
3622
|
+
# readonly value).
|
3623
|
+
# Corresponds to the JSON property `type`
|
3624
|
+
# @return [String]
|
3625
|
+
attr_accessor :type
|
3626
|
+
|
3627
|
+
# Output only. Timestamp the Recommendation Model was last updated. E.g. if a
|
3628
|
+
# Recommendation Model was paused - this would be the time the pause was
|
3629
|
+
# initiated.
|
3630
|
+
# Corresponds to the JSON property `updateTime`
|
3631
|
+
# @return [String]
|
3632
|
+
attr_accessor :update_time
|
3633
|
+
|
3634
|
+
def initialize(**args)
|
3635
|
+
update!(**args)
|
3636
|
+
end
|
3637
|
+
|
3638
|
+
# Update properties of this object
|
3639
|
+
def update!(**args)
|
3640
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
3641
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
3642
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
3643
|
+
@filtering_option = args[:filtering_option] if args.key?(:filtering_option)
|
3644
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
3645
|
+
@name = args[:name] if args.key?(:name)
|
3646
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
3647
|
+
@periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
|
3648
|
+
@serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
|
3649
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
3650
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
3651
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
3652
|
+
@type = args[:type] if args.key?(:type)
|
3653
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
3654
|
+
end
|
3655
|
+
end
|
3656
|
+
|
3657
|
+
# Represents an ordered combination of valid serving configs, which can be used
|
3658
|
+
# for `PAGE_OPTIMIZATION` recommendations.
|
3659
|
+
class GoogleCloudRetailV2betaModelServingConfigList
|
3660
|
+
include Google::Apis::Core::Hashable
|
3661
|
+
|
3662
|
+
# Optional. A set of valid serving configs that may be used for `
|
3663
|
+
# PAGE_OPTIMIZATION`.
|
3664
|
+
# Corresponds to the JSON property `servingConfigIds`
|
3665
|
+
# @return [Array<String>]
|
3666
|
+
attr_accessor :serving_config_ids
|
3667
|
+
|
3668
|
+
def initialize(**args)
|
3669
|
+
update!(**args)
|
3670
|
+
end
|
3671
|
+
|
3672
|
+
# Update properties of this object
|
3673
|
+
def update!(**args)
|
3674
|
+
@serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
|
3675
|
+
end
|
3676
|
+
end
|
3677
|
+
|
3492
3678
|
# Output result.
|
3493
3679
|
class GoogleCloudRetailV2betaOutputResult
|
3494
3680
|
include Google::Apis::Core::Hashable
|
@@ -3508,6 +3694,19 @@ module Google
|
|
3508
3694
|
end
|
3509
3695
|
end
|
3510
3696
|
|
3697
|
+
# Request for pausing training of a model.
|
3698
|
+
class GoogleCloudRetailV2betaPauseModelRequest
|
3699
|
+
include Google::Apis::Core::Hashable
|
3700
|
+
|
3701
|
+
def initialize(**args)
|
3702
|
+
update!(**args)
|
3703
|
+
end
|
3704
|
+
|
3705
|
+
# Update properties of this object
|
3706
|
+
def update!(**args)
|
3707
|
+
end
|
3708
|
+
end
|
3709
|
+
|
3511
3710
|
# Request message for Predict method.
|
3512
3711
|
class GoogleCloudRetailV2betaPredictRequest
|
3513
3712
|
include Google::Apis::Core::Hashable
|
@@ -3552,15 +3751,15 @@ module Google
|
|
3552
3751
|
# @return [Hash<String,String>]
|
3553
3752
|
attr_accessor :labels
|
3554
3753
|
|
3555
|
-
# Maximum number of results to return
|
3556
|
-
#
|
3754
|
+
# Maximum number of results to return. Set this property to the number of
|
3755
|
+
# prediction results needed. If zero, the service will choose a reasonable
|
3557
3756
|
# default. The maximum allowed value is 100. Values above 100 will be coerced to
|
3558
3757
|
# 100.
|
3559
3758
|
# Corresponds to the JSON property `pageSize`
|
3560
3759
|
# @return [Fixnum]
|
3561
3760
|
attr_accessor :page_size
|
3562
3761
|
|
3563
|
-
# This field is not used
|
3762
|
+
# This field is not used; leave it unset.
|
3564
3763
|
# Corresponds to the JSON property `pageToken`
|
3565
3764
|
# @return [String]
|
3566
3765
|
attr_accessor :page_token
|
@@ -3849,11 +4048,11 @@ module Google
|
|
3849
4048
|
# belonging to several parallel categories. Strongly recommended using the full
|
3850
4049
|
# path for better search / recommendation quality. To represent full path of
|
3851
4050
|
# category, use '>' sign to separate different hierarchies. If '>' is part of
|
3852
|
-
# the category name,
|
3853
|
-
#
|
3854
|
-
#
|
3855
|
-
#
|
3856
|
-
#
|
4051
|
+
# the category name, replace it with other character(s). For example, if a shoes
|
4052
|
+
# product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports &
|
4053
|
+
# Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "
|
4054
|
+
# categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic
|
4055
|
+
# Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
|
3857
4056
|
# INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
|
3858
4057
|
# Empty values are not allowed. Each value must be a UTF-8 encoded string with
|
3859
4058
|
# a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
@@ -3961,6 +4160,13 @@ module Google
|
|
3961
4160
|
# @return [String]
|
3962
4161
|
attr_accessor :language_code
|
3963
4162
|
|
4163
|
+
# Output only. A list of local inventories specific to different places. This is
|
4164
|
+
# only available for users who have Retail Search enabled, and it can be managed
|
4165
|
+
# by AddLocalInventories and RemoveLocalInventories APIs.
|
4166
|
+
# Corresponds to the JSON property `localInventories`
|
4167
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaLocalInventory>]
|
4168
|
+
attr_accessor :local_inventories
|
4169
|
+
|
3964
4170
|
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
3965
4171
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
3966
4172
|
# limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
@@ -4139,6 +4345,7 @@ module Google
|
|
4139
4345
|
@id = args[:id] if args.key?(:id)
|
4140
4346
|
@images = args[:images] if args.key?(:images)
|
4141
4347
|
@language_code = args[:language_code] if args.key?(:language_code)
|
4348
|
+
@local_inventories = args[:local_inventories] if args.key?(:local_inventories)
|
4142
4349
|
@materials = args[:materials] if args.key?(:materials)
|
4143
4350
|
@name = args[:name] if args.key?(:name)
|
4144
4351
|
@patterns = args[:patterns] if args.key?(:patterns)
|
@@ -4216,7 +4423,7 @@ module Google
|
|
4216
4423
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBigQuerySource]
|
4217
4424
|
attr_accessor :big_query_source
|
4218
4425
|
|
4219
|
-
# Google Cloud Storage location for input content.
|
4426
|
+
# Google Cloud Storage location for input content.
|
4220
4427
|
# Corresponds to the JSON property `gcsSource`
|
4221
4428
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGcsSource]
|
4222
4429
|
attr_accessor :gcs_source
|
@@ -4465,7 +4672,7 @@ module Google
|
|
4465
4672
|
end
|
4466
4673
|
end
|
4467
4674
|
|
4468
|
-
# Metadata for RejoinUserEvents method.
|
4675
|
+
# Metadata for `RejoinUserEvents` method.
|
4469
4676
|
class GoogleCloudRetailV2betaRejoinUserEventsMetadata
|
4470
4677
|
include Google::Apis::Core::Hashable
|
4471
4678
|
|
@@ -4483,8 +4690,8 @@ module Google
|
|
4483
4690
|
include Google::Apis::Core::Hashable
|
4484
4691
|
|
4485
4692
|
# The type of the user event rejoin to define the scope and range of the user
|
4486
|
-
# events to be rejoined with the latest product catalog. Defaults to
|
4487
|
-
# USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
|
4693
|
+
# events to be rejoined with the latest product catalog. Defaults to `
|
4694
|
+
# USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to an
|
4488
4695
|
# invalid integer value.
|
4489
4696
|
# Corresponds to the JSON property `userEventRejoinScope`
|
4490
4697
|
# @return [String]
|
@@ -4500,7 +4707,7 @@ module Google
|
|
4500
4707
|
end
|
4501
4708
|
end
|
4502
4709
|
|
4503
|
-
# Response message for RejoinUserEvents method.
|
4710
|
+
# Response message for `RejoinUserEvents` method.
|
4504
4711
|
class GoogleCloudRetailV2betaRejoinUserEventsResponse
|
4505
4712
|
include Google::Apis::Core::Hashable
|
4506
4713
|
|
@@ -4738,9 +4945,22 @@ module Google
|
|
4738
4945
|
end
|
4739
4946
|
end
|
4740
4947
|
|
4948
|
+
# Request for resuming training of a model.
|
4949
|
+
class GoogleCloudRetailV2betaResumeModelRequest
|
4950
|
+
include Google::Apis::Core::Hashable
|
4951
|
+
|
4952
|
+
def initialize(**args)
|
4953
|
+
update!(**args)
|
4954
|
+
end
|
4955
|
+
|
4956
|
+
# Update properties of this object
|
4957
|
+
def update!(**args)
|
4958
|
+
end
|
4959
|
+
end
|
4960
|
+
|
4741
4961
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
4742
|
-
# triggered. * An action specifies what occurs on that trigger. Currently
|
4743
|
-
#
|
4962
|
+
# triggered. * An action specifies what occurs on that trigger. Currently rules
|
4963
|
+
# only work for controls with SOLUTION_TYPE_SEARCH.
|
4744
4964
|
class GoogleCloudRetailV2betaRule
|
4745
4965
|
include Google::Apis::Core::Hashable
|
4746
4966
|
|
@@ -4766,7 +4986,7 @@ module Google
|
|
4766
4986
|
attr_accessor :do_not_associate_action
|
4767
4987
|
|
4768
4988
|
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
4769
|
-
# or more Condition.query_terms provided
|
4989
|
+
# or more Condition.query_terms provided are combined with OR operator. * Action
|
4770
4990
|
# Input: The request query and filter that are applied to the retrieved products,
|
4771
4991
|
# in addition to any filters already provided with the SearchRequest. The AND
|
4772
4992
|
# operator is used to combine the query's existing filters with the filter rule(
|
@@ -4903,7 +5123,7 @@ module Google
|
|
4903
5123
|
end
|
4904
5124
|
|
4905
5125
|
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
4906
|
-
# or more Condition.query_terms provided
|
5126
|
+
# or more Condition.query_terms provided are combined with OR operator. * Action
|
4907
5127
|
# Input: The request query and filter that are applied to the retrieved products,
|
4908
5128
|
# in addition to any filters already provided with the SearchRequest. The AND
|
4909
5129
|
# operator is used to combine the query's existing filters with the filter rule(
|
@@ -5149,9 +5369,9 @@ module Google
|
|
5149
5369
|
# navigation queries to achieve good search quality. The format should be the
|
5150
5370
|
# same as UserEvent.page_categories; To represent full path of category, use '>'
|
5151
5371
|
# sign to separate different hierarchies. If '>' is part of the category name,
|
5152
|
-
#
|
5153
|
-
#
|
5154
|
-
#
|
5372
|
+
# replace it with other character(s). Category pages include special pages such
|
5373
|
+
# as sales or promotions. For instance, a special sale page may have the
|
5374
|
+
# category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
|
5155
5375
|
# Corresponds to the JSON property `pageCategories`
|
5156
5376
|
# @return [Array<String>]
|
5157
5377
|
attr_accessor :page_categories
|
@@ -5877,9 +6097,7 @@ module Google
|
|
5877
6097
|
end
|
5878
6098
|
|
5879
6099
|
# Configures metadata that is used to generate serving time results (e.g. search
|
5880
|
-
# results or recommendation predictions).
|
5881
|
-
# search and predict request and together with the Catalog.default_branch,
|
5882
|
-
# generates results.
|
6100
|
+
# results or recommendation predictions).
|
5883
6101
|
class GoogleCloudRetailV2betaServingConfig
|
5884
6102
|
include Google::Apis::Core::Hashable
|
5885
6103
|
|
@@ -5902,16 +6120,21 @@ module Google
|
|
5902
6120
|
# @return [String]
|
5903
6121
|
attr_accessor :display_name
|
5904
6122
|
|
5905
|
-
# How much diversity to use in recommendation model results e.g.
|
5906
|
-
# diversity
|
5907
|
-
#
|
6123
|
+
# How much diversity to use in recommendation model results e.g. `medium-
|
6124
|
+
# diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
|
6125
|
+
# `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
|
5908
6126
|
# not specified, we choose default based on recommendation model type. Default
|
5909
|
-
# value:
|
6127
|
+
# value: `no-diversity`. Can only be set if solution_types is
|
5910
6128
|
# SOLUTION_TYPE_RECOMMENDATION.
|
5911
6129
|
# Corresponds to the JSON property `diversityLevel`
|
5912
6130
|
# @return [String]
|
5913
6131
|
attr_accessor :diversity_level
|
5914
6132
|
|
6133
|
+
# What kind of diversity to use - data driven or rule based.
|
6134
|
+
# Corresponds to the JSON property `diversityType`
|
6135
|
+
# @return [String]
|
6136
|
+
attr_accessor :diversity_type
|
6137
|
+
|
5915
6138
|
# Condition do not associate specifications. If multiple do not associate
|
5916
6139
|
# conditions match, all matching do not associate controls in the list will
|
5917
6140
|
# execute. - Order does not matter. - Maximum number of specifications is 100.
|
@@ -5925,10 +6148,10 @@ module Google
|
|
5925
6148
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec]
|
5926
6149
|
attr_accessor :dynamic_facet_spec
|
5927
6150
|
|
5928
|
-
# Whether to add additional category filters on the
|
5929
|
-
# not specified, we enable it by default. Allowed values are: *
|
5930
|
-
# match
|
5931
|
-
# customer's filters. *
|
6151
|
+
# Whether to add additional category filters on the `similar-items` model. If
|
6152
|
+
# not specified, we enable it by default. Allowed values are: * `no-category-
|
6153
|
+
# match`: No additional filtering of original results from the model and the
|
6154
|
+
# customer's filters. * `relaxed-category-match`: Only keep results with
|
5932
6155
|
# categories that match at least one item categories in the PredictRequests's
|
5933
6156
|
# context item. * If customer also sends filters in the PredictRequest, then the
|
5934
6157
|
# results will satisfy both conditions (user given and category match). Can only
|
@@ -5962,7 +6185,7 @@ module Google
|
|
5962
6185
|
# @return [Array<String>]
|
5963
6186
|
attr_accessor :ignore_control_ids
|
5964
6187
|
|
5965
|
-
# The id of the model to use at serving time. Currently only
|
6188
|
+
# The id of the model in the same Catalog to use at serving time. Currently only
|
5966
6189
|
# RecommendationModels are supported: https://cloud.google.com/retail/
|
5967
6190
|
# recommendations-ai/docs/create-models Can be changed but only to a compatible
|
5968
6191
|
# model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
|
@@ -5986,13 +6209,18 @@ module Google
|
|
5986
6209
|
# @return [Array<String>]
|
5987
6210
|
attr_accessor :oneway_synonyms_control_ids
|
5988
6211
|
|
6212
|
+
# The specification for personalization.
|
6213
|
+
# Corresponds to the JSON property `personalizationSpec`
|
6214
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec]
|
6215
|
+
attr_accessor :personalization_spec
|
6216
|
+
|
5989
6217
|
# How much price ranking we want in serving results. Price reranking causes
|
5990
6218
|
# product items with a similar recommendation probability to be ordered by price,
|
5991
6219
|
# with the highest-priced items first. This setting could result in a decrease
|
5992
|
-
# in click-through and conversion rates. Allowed values are: *
|
5993
|
-
# reranking
|
5994
|
-
# reranking
|
5995
|
-
# value:
|
6220
|
+
# in click-through and conversion rates. Allowed values are: * `no-price-
|
6221
|
+
# reranking` * `low-price-raranking` * `medium-price-reranking` * `high-price-
|
6222
|
+
# reranking` If not specified, we choose default based on model type. Default
|
6223
|
+
# value: `no-price-reranking`. Can only be set if solution_types is
|
5996
6224
|
# SOLUTION_TYPE_RECOMMENDATION.
|
5997
6225
|
# Corresponds to the JSON property `priceRerankingLevel`
|
5998
6226
|
# @return [String]
|
@@ -6036,6 +6264,7 @@ module Google
|
|
6036
6264
|
@boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
|
6037
6265
|
@display_name = args[:display_name] if args.key?(:display_name)
|
6038
6266
|
@diversity_level = args[:diversity_level] if args.key?(:diversity_level)
|
6267
|
+
@diversity_type = args[:diversity_type] if args.key?(:diversity_type)
|
6039
6268
|
@do_not_associate_control_ids = args[:do_not_associate_control_ids] if args.key?(:do_not_associate_control_ids)
|
6040
6269
|
@dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
|
6041
6270
|
@enable_category_filter_level = args[:enable_category_filter_level] if args.key?(:enable_category_filter_level)
|
@@ -6045,6 +6274,7 @@ module Google
|
|
6045
6274
|
@model_id = args[:model_id] if args.key?(:model_id)
|
6046
6275
|
@name = args[:name] if args.key?(:name)
|
6047
6276
|
@oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
|
6277
|
+
@personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
|
6048
6278
|
@price_reranking_level = args[:price_reranking_level] if args.key?(:price_reranking_level)
|
6049
6279
|
@redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
|
6050
6280
|
@replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
|
@@ -6167,6 +6397,20 @@ module Google
|
|
6167
6397
|
end
|
6168
6398
|
end
|
6169
6399
|
|
6400
|
+
# Request to manually start a tuning process now (instead of waiting for the
|
6401
|
+
# periodically scheduled tuning to happen).
|
6402
|
+
class GoogleCloudRetailV2betaTuneModelRequest
|
6403
|
+
include Google::Apis::Core::Hashable
|
6404
|
+
|
6405
|
+
def initialize(**args)
|
6406
|
+
update!(**args)
|
6407
|
+
end
|
6408
|
+
|
6409
|
+
# Update properties of this object
|
6410
|
+
def update!(**args)
|
6411
|
+
end
|
6412
|
+
end
|
6413
|
+
|
6170
6414
|
# UserEvent captures all metadata information Retail API needs to know about how
|
6171
6415
|
# end users interact with customers' website.
|
6172
6416
|
class GoogleCloudRetailV2betaUserEvent
|
@@ -6275,12 +6519,12 @@ module Google
|
|
6275
6519
|
|
6276
6520
|
# The categories associated with a category page. To represent full path of
|
6277
6521
|
# category, use '>' sign to separate different hierarchies. If '>' is part of
|
6278
|
-
# the category name,
|
6279
|
-
#
|
6280
|
-
#
|
6281
|
-
#
|
6282
|
-
#
|
6283
|
-
#
|
6522
|
+
# the category name, replace it with other character(s). Category pages include
|
6523
|
+
# special pages such as sales or promotions. For instance, a special sale page
|
6524
|
+
# may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black
|
6525
|
+
# Friday Deals"]. Required for `category-page-view` events. At least one of
|
6526
|
+
# search_query or page_categories is required for `search` events. Other event
|
6527
|
+
# types should not set this field. Otherwise, an INVALID_ARGUMENT error is
|
6284
6528
|
# returned.
|
6285
6529
|
# Corresponds to the JSON property `pageCategories`
|
6286
6530
|
# @return [Array<String>]
|
@@ -6449,7 +6693,7 @@ module Google
|
|
6449
6693
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBigQuerySource]
|
6450
6694
|
attr_accessor :big_query_source
|
6451
6695
|
|
6452
|
-
# Google Cloud Storage location for input content.
|
6696
|
+
# Google Cloud Storage location for input content.
|
6453
6697
|
# Corresponds to the JSON property `gcsSource`
|
6454
6698
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGcsSource]
|
6455
6699
|
attr_accessor :gcs_source
|