google-apis-retail_v2alpha 0.47.0 → 0.50.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -960,6 +960,31 @@ module Google
|
|
960
960
|
end
|
961
961
|
end
|
962
962
|
|
963
|
+
# A BigQuery output result.
|
964
|
+
class GoogleCloudRetailV2alphaBigQueryOutputResult
|
965
|
+
include Google::Apis::Core::Hashable
|
966
|
+
|
967
|
+
# The ID of a BigQuery Dataset.
|
968
|
+
# Corresponds to the JSON property `datasetId`
|
969
|
+
# @return [String]
|
970
|
+
attr_accessor :dataset_id
|
971
|
+
|
972
|
+
# The ID of a BigQuery Table.
|
973
|
+
# Corresponds to the JSON property `tableId`
|
974
|
+
# @return [String]
|
975
|
+
attr_accessor :table_id
|
976
|
+
|
977
|
+
def initialize(**args)
|
978
|
+
update!(**args)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Update properties of this object
|
982
|
+
def update!(**args)
|
983
|
+
@dataset_id = args[:dataset_id] if args.key?(:dataset_id)
|
984
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
985
|
+
end
|
986
|
+
end
|
987
|
+
|
963
988
|
# BigQuery source import data from.
|
964
989
|
class GoogleCloudRetailV2alphaBigQuerySource
|
965
990
|
include Google::Apis::Core::Hashable
|
@@ -1092,11 +1117,11 @@ module Google
|
|
1092
1117
|
# Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
|
1093
1118
|
# CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
|
1094
1119
|
# CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
|
1095
|
-
# loaded CatalogAttributes. Only CatalogAttributes that are
|
1096
|
-
# products can be deleted. CatalogAttributes that are
|
1097
|
-
# be deleted; however, their
|
1098
|
-
#
|
1099
|
-
# for this field to update.
|
1120
|
+
# loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
|
1121
|
+
# in use by products nor predefined can be deleted. CatalogAttributes that are
|
1122
|
+
# either in use by products or are predefined cannot be deleted; however, their
|
1123
|
+
# configuration properties will reset to default values upon removal request.
|
1124
|
+
# After catalog changes, it takes about 10 minutes for this field to update.
|
1100
1125
|
# Corresponds to the JSON property `inUse`
|
1101
1126
|
# @return [Boolean]
|
1102
1127
|
attr_accessor :in_use
|
@@ -1245,9 +1270,8 @@ module Google
|
|
1245
1270
|
|
1246
1271
|
# Custom attributes for the suggestion term. * For "user-data", the attributes
|
1247
1272
|
# are additional custom attributes ingested through BigQuery. * For "cloud-
|
1248
|
-
# retail", the attributes are product attributes generated by Cloud Retail.
|
1249
|
-
#
|
1250
|
-
# interested in enabling it.
|
1273
|
+
# retail", the attributes are product attributes generated by Cloud Retail. It
|
1274
|
+
# requires UserEvent.product_details is imported properly.
|
1251
1275
|
# Corresponds to the JSON property `attributes`
|
1252
1276
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
1253
1277
|
attr_accessor :attributes
|
@@ -1586,6 +1610,26 @@ module Google
|
|
1586
1610
|
end
|
1587
1611
|
end
|
1588
1612
|
|
1613
|
+
# Metadata associated with a create operation.
|
1614
|
+
class GoogleCloudRetailV2alphaCreateModelMetadata
|
1615
|
+
include Google::Apis::Core::Hashable
|
1616
|
+
|
1617
|
+
# The resource name of the model that this create applies to. Format: projects/`
|
1618
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
1619
|
+
# Corresponds to the JSON property `model`
|
1620
|
+
# @return [String]
|
1621
|
+
attr_accessor :model
|
1622
|
+
|
1623
|
+
def initialize(**args)
|
1624
|
+
update!(**args)
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# Update properties of this object
|
1628
|
+
def update!(**args)
|
1629
|
+
@model = args[:model] if args.key?(:model)
|
1630
|
+
end
|
1631
|
+
end
|
1632
|
+
|
1589
1633
|
# A custom attribute that is not explicitly modeled in Product.
|
1590
1634
|
class GoogleCloudRetailV2alphaCustomAttribute
|
1591
1635
|
include Google::Apis::Core::Hashable
|
@@ -1707,6 +1751,11 @@ module Google
|
|
1707
1751
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig]
|
1708
1752
|
attr_accessor :errors_config
|
1709
1753
|
|
1754
|
+
# Output result.
|
1755
|
+
# Corresponds to the JSON property `outputResult`
|
1756
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult]
|
1757
|
+
attr_accessor :output_result
|
1758
|
+
|
1710
1759
|
def initialize(**args)
|
1711
1760
|
update!(**args)
|
1712
1761
|
end
|
@@ -1715,6 +1764,7 @@ module Google
|
|
1715
1764
|
def update!(**args)
|
1716
1765
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
1717
1766
|
@errors_config = args[:errors_config] if args.key?(:errors_config)
|
1767
|
+
@output_result = args[:output_result] if args.key?(:output_result)
|
1718
1768
|
end
|
1719
1769
|
end
|
1720
1770
|
|
@@ -1734,6 +1784,11 @@ module Google
|
|
1734
1784
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig]
|
1735
1785
|
attr_accessor :errors_config
|
1736
1786
|
|
1787
|
+
# Output result.
|
1788
|
+
# Corresponds to the JSON property `outputResult`
|
1789
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult]
|
1790
|
+
attr_accessor :output_result
|
1791
|
+
|
1737
1792
|
def initialize(**args)
|
1738
1793
|
update!(**args)
|
1739
1794
|
end
|
@@ -1742,6 +1797,7 @@ module Google
|
|
1742
1797
|
def update!(**args)
|
1743
1798
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
1744
1799
|
@errors_config = args[:errors_config] if args.key?(:errors_config)
|
1800
|
+
@output_result = args[:output_result] if args.key?(:output_result)
|
1745
1801
|
end
|
1746
1802
|
end
|
1747
1803
|
|
@@ -2260,6 +2316,31 @@ module Google
|
|
2260
2316
|
end
|
2261
2317
|
end
|
2262
2318
|
|
2319
|
+
# Response to a ListModelRequest.
|
2320
|
+
class GoogleCloudRetailV2alphaListModelsResponse
|
2321
|
+
include Google::Apis::Core::Hashable
|
2322
|
+
|
2323
|
+
# List of Models.
|
2324
|
+
# Corresponds to the JSON property `models`
|
2325
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel>]
|
2326
|
+
attr_accessor :models
|
2327
|
+
|
2328
|
+
# Pagination token, if not returned indicates the last page.
|
2329
|
+
# Corresponds to the JSON property `nextPageToken`
|
2330
|
+
# @return [String]
|
2331
|
+
attr_accessor :next_page_token
|
2332
|
+
|
2333
|
+
def initialize(**args)
|
2334
|
+
update!(**args)
|
2335
|
+
end
|
2336
|
+
|
2337
|
+
# Update properties of this object
|
2338
|
+
def update!(**args)
|
2339
|
+
@models = args[:models] if args.key?(:models)
|
2340
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2341
|
+
end
|
2342
|
+
end
|
2343
|
+
|
2263
2344
|
# Response message for ProductService.ListProducts method.
|
2264
2345
|
class GoogleCloudRetailV2alphaListProductsResponse
|
2265
2346
|
include Google::Apis::Core::Hashable
|
@@ -2455,6 +2536,291 @@ module Google
|
|
2455
2536
|
end
|
2456
2537
|
end
|
2457
2538
|
|
2539
|
+
# Metadata that describes the training and serving parameters of a Model. A
|
2540
|
+
# Model can be associated with a ServingConfig and then queried through the
|
2541
|
+
# Predict api.
|
2542
|
+
class GoogleCloudRetailV2alphaModel
|
2543
|
+
include Google::Apis::Core::Hashable
|
2544
|
+
|
2545
|
+
# Output only. Timestamp the Recommendation Model was created at.
|
2546
|
+
# Corresponds to the JSON property `createTime`
|
2547
|
+
# @return [String]
|
2548
|
+
attr_accessor :create_time
|
2549
|
+
|
2550
|
+
# Output only. The state of data requirements for this model: DATA_OK and
|
2551
|
+
# DATA_ERROR. Recommendation model cannot be trained if the data is in
|
2552
|
+
# DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
|
2553
|
+
# serving state is ACTIVE: models were trained successfully before, but cannot
|
2554
|
+
# be refreshed because model no longer has sufficient data for training.
|
2555
|
+
# Corresponds to the JSON property `dataState`
|
2556
|
+
# @return [String]
|
2557
|
+
attr_accessor :data_state
|
2558
|
+
|
2559
|
+
# Required. The display name of the model. Should be human readable, used to
|
2560
|
+
# display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
|
2561
|
+
# string with limit of 1024 characters.
|
2562
|
+
# Corresponds to the JSON property `displayName`
|
2563
|
+
# @return [String]
|
2564
|
+
attr_accessor :display_name
|
2565
|
+
|
2566
|
+
# Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
|
2567
|
+
# attributes is enabled for the model.
|
2568
|
+
# Corresponds to the JSON property `filteringOption`
|
2569
|
+
# @return [String]
|
2570
|
+
attr_accessor :filtering_option
|
2571
|
+
|
2572
|
+
# Output only. The timestamp when the latest successful tune finished.
|
2573
|
+
# Corresponds to the JSON property `lastTuneTime`
|
2574
|
+
# @return [String]
|
2575
|
+
attr_accessor :last_tune_time
|
2576
|
+
|
2577
|
+
# Required. The fully qualified resource name of the model. Format: projects/`
|
2578
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
2579
|
+
# catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
|
2580
|
+
# Corresponds to the JSON property `name`
|
2581
|
+
# @return [String]
|
2582
|
+
attr_accessor :name
|
2583
|
+
|
2584
|
+
# Optional. The optimization objective e.g. `cvr`. Currently supported values: `
|
2585
|
+
# ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
|
2586
|
+
# model type. Default depends on type of recommendation: `recommended-for-you` =>
|
2587
|
+
# `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
|
2588
|
+
# revenue_per_order`
|
2589
|
+
# Corresponds to the JSON property `optimizationObjective`
|
2590
|
+
# @return [String]
|
2591
|
+
attr_accessor :optimization_objective
|
2592
|
+
|
2593
|
+
# The PageOptimizationConfig for model training. This determines how many panels
|
2594
|
+
# to optimize for, and which serving configurations to consider for each panel.
|
2595
|
+
# The purpose of this model is to optimize which ServingConfig to show on which
|
2596
|
+
# panels in way that optimizes the visitors shopping journey.
|
2597
|
+
# Corresponds to the JSON property `pageOptimizationConfig`
|
2598
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
|
2599
|
+
attr_accessor :page_optimization_config
|
2600
|
+
|
2601
|
+
# Optional. The state of periodic tuning. The period we use is 3 months - to do
|
2602
|
+
# a one-off tune earlier use the TuneModel method. Default value is
|
2603
|
+
# PERIODIC_TUNING_ENABLED.
|
2604
|
+
# Corresponds to the JSON property `periodicTuningState`
|
2605
|
+
# @return [String]
|
2606
|
+
attr_accessor :periodic_tuning_state
|
2607
|
+
|
2608
|
+
# Output only. The list of valid serving configs associated with the
|
2609
|
+
# PageOptimizationConfig.
|
2610
|
+
# Corresponds to the JSON property `servingConfigLists`
|
2611
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelServingConfigList>]
|
2612
|
+
attr_accessor :serving_config_lists
|
2613
|
+
|
2614
|
+
# Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
|
2615
|
+
# Corresponds to the JSON property `servingState`
|
2616
|
+
# @return [String]
|
2617
|
+
attr_accessor :serving_state
|
2618
|
+
|
2619
|
+
# Optional. The training state that the model is in (e.g. TRAINING or PAUSED).
|
2620
|
+
# Since part of the cost of running the service is frequency of training - this
|
2621
|
+
# can be used to determine when to train model in order to control cost. If not
|
2622
|
+
# specified: the default value for CreateModel method is TRAINING. the default
|
2623
|
+
# value for UpdateModel method is to keep the state the same as before.
|
2624
|
+
# Corresponds to the JSON property `trainingState`
|
2625
|
+
# @return [String]
|
2626
|
+
attr_accessor :training_state
|
2627
|
+
|
2628
|
+
# Output only. The tune operation associated with the model. Can be used to
|
2629
|
+
# determine if there is an ongoing tune for this recommendation. Empty field
|
2630
|
+
# implies no tune is goig on.
|
2631
|
+
# Corresponds to the JSON property `tuningOperation`
|
2632
|
+
# @return [String]
|
2633
|
+
attr_accessor :tuning_operation
|
2634
|
+
|
2635
|
+
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
2636
|
+
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
2637
|
+
# page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(
|
2638
|
+
# readonly value).
|
2639
|
+
# Corresponds to the JSON property `type`
|
2640
|
+
# @return [String]
|
2641
|
+
attr_accessor :type
|
2642
|
+
|
2643
|
+
# Output only. Timestamp the Recommendation Model was last updated. E.g. if a
|
2644
|
+
# Recommendation Model was paused - this would be the time the pause was
|
2645
|
+
# initiated.
|
2646
|
+
# Corresponds to the JSON property `updateTime`
|
2647
|
+
# @return [String]
|
2648
|
+
attr_accessor :update_time
|
2649
|
+
|
2650
|
+
def initialize(**args)
|
2651
|
+
update!(**args)
|
2652
|
+
end
|
2653
|
+
|
2654
|
+
# Update properties of this object
|
2655
|
+
def update!(**args)
|
2656
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
2657
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
2658
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
2659
|
+
@filtering_option = args[:filtering_option] if args.key?(:filtering_option)
|
2660
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
2661
|
+
@name = args[:name] if args.key?(:name)
|
2662
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
2663
|
+
@page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
|
2664
|
+
@periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
|
2665
|
+
@serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
|
2666
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
2667
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
2668
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
2669
|
+
@type = args[:type] if args.key?(:type)
|
2670
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
2671
|
+
end
|
2672
|
+
end
|
2673
|
+
|
2674
|
+
# The PageOptimizationConfig for model training. This determines how many panels
|
2675
|
+
# to optimize for, and which serving configurations to consider for each panel.
|
2676
|
+
# The purpose of this model is to optimize which ServingConfig to show on which
|
2677
|
+
# panels in way that optimizes the visitors shopping journey.
|
2678
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfig
|
2679
|
+
include Google::Apis::Core::Hashable
|
2680
|
+
|
2681
|
+
# Required. The type of UserEvent this page optimization is shown for. Each page
|
2682
|
+
# has an associated event type - this will be the corresponding event type for
|
2683
|
+
# the page that the page optimization model is used on. Supported types: * `add-
|
2684
|
+
# to-cart`: Products being added to cart. * `detail-page-view`: Products detail
|
2685
|
+
# page viewed. * `home-page-view`: Homepage viewed * `category-page-view`:
|
2686
|
+
# Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `
|
2687
|
+
# home-page-view` only allows models with type `recommended-for-you`. All other
|
2688
|
+
# page_optimization_event_type allow all Model.types.
|
2689
|
+
# Corresponds to the JSON property `pageOptimizationEventType`
|
2690
|
+
# @return [String]
|
2691
|
+
attr_accessor :page_optimization_event_type
|
2692
|
+
|
2693
|
+
# Required. A list of panel configurations. Limit = 5.
|
2694
|
+
# Corresponds to the JSON property `panels`
|
2695
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>]
|
2696
|
+
attr_accessor :panels
|
2697
|
+
|
2698
|
+
# Optional. How to restrict results across panels e.g. can the same
|
2699
|
+
# ServingConfig be shown on multiple panels at once. If unspecified, default to `
|
2700
|
+
# UNIQUE_MODEL_RESTRICTION`.
|
2701
|
+
# Corresponds to the JSON property `restriction`
|
2702
|
+
# @return [String]
|
2703
|
+
attr_accessor :restriction
|
2704
|
+
|
2705
|
+
def initialize(**args)
|
2706
|
+
update!(**args)
|
2707
|
+
end
|
2708
|
+
|
2709
|
+
# Update properties of this object
|
2710
|
+
def update!(**args)
|
2711
|
+
@page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
|
2712
|
+
@panels = args[:panels] if args.key?(:panels)
|
2713
|
+
@restriction = args[:restriction] if args.key?(:restriction)
|
2714
|
+
end
|
2715
|
+
end
|
2716
|
+
|
2717
|
+
# A candidate to consider for a given panel. Currently only ServingConfig are
|
2718
|
+
# valid candidates.
|
2719
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
|
2720
|
+
include Google::Apis::Core::Hashable
|
2721
|
+
|
2722
|
+
# This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
|
2723
|
+
# full name: `projects/*/locations/global/catalogs/default_catalog/
|
2724
|
+
# servingConfigs/my_candidate_config` this would be 'my_candidate_config'
|
2725
|
+
# Corresponds to the JSON property `servingConfigId`
|
2726
|
+
# @return [String]
|
2727
|
+
attr_accessor :serving_config_id
|
2728
|
+
|
2729
|
+
def initialize(**args)
|
2730
|
+
update!(**args)
|
2731
|
+
end
|
2732
|
+
|
2733
|
+
# Update properties of this object
|
2734
|
+
def update!(**args)
|
2735
|
+
@serving_config_id = args[:serving_config_id] if args.key?(:serving_config_id)
|
2736
|
+
end
|
2737
|
+
end
|
2738
|
+
|
2739
|
+
# An individual panel with a list of ServingConfigs to consider for it.
|
2740
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
|
2741
|
+
include Google::Apis::Core::Hashable
|
2742
|
+
|
2743
|
+
# Required. The candidates to consider on the panel. Limit = 10.
|
2744
|
+
# Corresponds to the JSON property `candidates`
|
2745
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
|
2746
|
+
attr_accessor :candidates
|
2747
|
+
|
2748
|
+
# A candidate to consider for a given panel. Currently only ServingConfig are
|
2749
|
+
# valid candidates.
|
2750
|
+
# Corresponds to the JSON property `defaultCandidate`
|
2751
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate]
|
2752
|
+
attr_accessor :default_candidate
|
2753
|
+
|
2754
|
+
# Optional. The name to display for the panel.
|
2755
|
+
# Corresponds to the JSON property `displayName`
|
2756
|
+
# @return [String]
|
2757
|
+
attr_accessor :display_name
|
2758
|
+
|
2759
|
+
def initialize(**args)
|
2760
|
+
update!(**args)
|
2761
|
+
end
|
2762
|
+
|
2763
|
+
# Update properties of this object
|
2764
|
+
def update!(**args)
|
2765
|
+
@candidates = args[:candidates] if args.key?(:candidates)
|
2766
|
+
@default_candidate = args[:default_candidate] if args.key?(:default_candidate)
|
2767
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
2768
|
+
end
|
2769
|
+
end
|
2770
|
+
|
2771
|
+
# Represents an ordered combination of valid serving configs, which / may be
|
2772
|
+
# used for PAGE_OPTIMIZATION recommendations.
|
2773
|
+
class GoogleCloudRetailV2alphaModelServingConfigList
|
2774
|
+
include Google::Apis::Core::Hashable
|
2775
|
+
|
2776
|
+
# Optional. A set of valid serving configs that may be used for
|
2777
|
+
# PAGE_OPTIMIZATION.
|
2778
|
+
# Corresponds to the JSON property `servingConfigIds`
|
2779
|
+
# @return [Array<String>]
|
2780
|
+
attr_accessor :serving_config_ids
|
2781
|
+
|
2782
|
+
def initialize(**args)
|
2783
|
+
update!(**args)
|
2784
|
+
end
|
2785
|
+
|
2786
|
+
# Update properties of this object
|
2787
|
+
def update!(**args)
|
2788
|
+
@serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
|
2789
|
+
end
|
2790
|
+
end
|
2791
|
+
|
2792
|
+
# Output result.
|
2793
|
+
class GoogleCloudRetailV2alphaOutputResult
|
2794
|
+
include Google::Apis::Core::Hashable
|
2795
|
+
|
2796
|
+
# Export result in BigQuery.
|
2797
|
+
# Corresponds to the JSON property `bigqueryResult`
|
2798
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBigQueryOutputResult>]
|
2799
|
+
attr_accessor :bigquery_result
|
2800
|
+
|
2801
|
+
def initialize(**args)
|
2802
|
+
update!(**args)
|
2803
|
+
end
|
2804
|
+
|
2805
|
+
# Update properties of this object
|
2806
|
+
def update!(**args)
|
2807
|
+
@bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
|
2808
|
+
end
|
2809
|
+
end
|
2810
|
+
|
2811
|
+
# Request for pausing training of a model.
|
2812
|
+
class GoogleCloudRetailV2alphaPauseModelRequest
|
2813
|
+
include Google::Apis::Core::Hashable
|
2814
|
+
|
2815
|
+
def initialize(**args)
|
2816
|
+
update!(**args)
|
2817
|
+
end
|
2818
|
+
|
2819
|
+
# Update properties of this object
|
2820
|
+
def update!(**args)
|
2821
|
+
end
|
2822
|
+
end
|
2823
|
+
|
2458
2824
|
# Request message for Predict method.
|
2459
2825
|
class GoogleCloudRetailV2alphaPredictRequest
|
2460
2826
|
include Google::Apis::Core::Hashable
|
@@ -2476,7 +2842,7 @@ module Google
|
|
2476
2842
|
# in `PredictRequest.params` to receive empty results instead. Note that the API
|
2477
2843
|
# will never return items with storageStatus of "EXPIRED" or "DELETED"
|
2478
2844
|
# regardless of filter choices. If `filterSyntaxV2` is set to true under the `
|
2479
|
-
# params` field, then attribute
|
2845
|
+
# params` field, then attribute-based expressions are expected instead of the
|
2480
2846
|
# above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
|
2481
2847
|
# NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
|
2482
2848
|
# ANY("Red") OR categories: ANY("Phones"))
|
@@ -2507,7 +2873,7 @@ module Google
|
|
2507
2873
|
# @return [Fixnum]
|
2508
2874
|
attr_accessor :page_size
|
2509
2875
|
|
2510
|
-
#
|
2876
|
+
# This field is not used for now, leave it unset.
|
2511
2877
|
# Corresponds to the JSON property `pageToken`
|
2512
2878
|
# @return [String]
|
2513
2879
|
attr_accessor :page_token
|
@@ -2529,8 +2895,8 @@ module Google
|
|
2529
2895
|
# it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
|
2530
2896
|
# high-diversity', 'auto-diversity'`. This gives request-level control and
|
2531
2897
|
# adjusts prediction results based on product category. * `filterSyntaxV2`:
|
2532
|
-
# Boolean. False by default. If set to true, the `filter` field
|
2533
|
-
#
|
2898
|
+
# Boolean. False by default. If set to true, the `filter` field is interpreteted
|
2899
|
+
# according to the new, attribute-based syntax.
|
2534
2900
|
# Corresponds to the JSON property `params`
|
2535
2901
|
# @return [Hash<String,Object>]
|
2536
2902
|
attr_accessor :params
|
@@ -3794,6 +4160,19 @@ module Google
|
|
3794
4160
|
end
|
3795
4161
|
end
|
3796
4162
|
|
4163
|
+
# Request for resuming training of a model.
|
4164
|
+
class GoogleCloudRetailV2alphaResumeModelRequest
|
4165
|
+
include Google::Apis::Core::Hashable
|
4166
|
+
|
4167
|
+
def initialize(**args)
|
4168
|
+
update!(**args)
|
4169
|
+
end
|
4170
|
+
|
4171
|
+
# Update properties of this object
|
4172
|
+
def update!(**args)
|
4173
|
+
end
|
4174
|
+
end
|
4175
|
+
|
3797
4176
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
3798
4177
|
# triggered. * An action specifies what occurs on that trigger. Currently only
|
3799
4178
|
# boost rules are supported. Currently only supported by the search endpoint.
|
@@ -3821,13 +4200,13 @@ module Google
|
|
3821
4200
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleDoNotAssociateAction]
|
3822
4201
|
attr_accessor :do_not_associate_action
|
3823
4202
|
|
3824
|
-
# * Rule Condition: - No Condition provided is a global match. - 1
|
3825
|
-
# Condition provided is combined with OR operator. * Action
|
3826
|
-
# query and filter that
|
3827
|
-
# to any filters already provided with the SearchRequest. The AND
|
3828
|
-
# used to combine the query's existing filters with the filter rule(
|
3829
|
-
# May result in 0 results when filters conflict. * Action Result:
|
3830
|
-
# returned objects to be ONLY those that passed the filter.
|
4203
|
+
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
4204
|
+
# or more Condition.query_terms provided is combined with OR operator. * Action
|
4205
|
+
# Input: The request query and filter that are applied to the retrieved products,
|
4206
|
+
# in addition to any filters already provided with the SearchRequest. The AND
|
4207
|
+
# operator is used to combine the query's existing filters with the filter rule(
|
4208
|
+
# s). NOTE: May result in 0 results when filters conflict. * Action Result:
|
4209
|
+
# Filters the returned objects to be ONLY those that passed the filter.
|
3831
4210
|
# Corresponds to the JSON property `filterAction`
|
3832
4211
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleFilterAction]
|
3833
4212
|
attr_accessor :filter_action
|
@@ -3847,8 +4226,8 @@ module Google
|
|
3847
4226
|
attr_accessor :oneway_synonyms_action
|
3848
4227
|
|
3849
4228
|
# Redirects a shopper to a specific page. * Rule Condition: - Must specify
|
3850
|
-
# Condition. * Action Input: Request Query * Action Result:
|
3851
|
-
# provided uri.
|
4229
|
+
# Condition.query_terms. * Action Input: Request Query * Action Result:
|
4230
|
+
# Redirects shopper to provided uri.
|
3852
4231
|
# Corresponds to the JSON property `redirectAction`
|
3853
4232
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRedirectAction]
|
3854
4233
|
attr_accessor :redirect_action
|
@@ -3958,13 +4337,13 @@ module Google
|
|
3958
4337
|
end
|
3959
4338
|
end
|
3960
4339
|
|
3961
|
-
# * Rule Condition: - No Condition provided is a global match. - 1
|
3962
|
-
# Condition provided is combined with OR operator. * Action
|
3963
|
-
# query and filter that
|
3964
|
-
# to any filters already provided with the SearchRequest. The AND
|
3965
|
-
# used to combine the query's existing filters with the filter rule(
|
3966
|
-
# May result in 0 results when filters conflict. * Action Result:
|
3967
|
-
# returned objects to be ONLY those that passed the filter.
|
4340
|
+
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
4341
|
+
# or more Condition.query_terms provided is combined with OR operator. * Action
|
4342
|
+
# Input: The request query and filter that are applied to the retrieved products,
|
4343
|
+
# in addition to any filters already provided with the SearchRequest. The AND
|
4344
|
+
# operator is used to combine the query's existing filters with the filter rule(
|
4345
|
+
# s). NOTE: May result in 0 results when filters conflict. * Action Result:
|
4346
|
+
# Filters the returned objects to be ONLY those that passed the filter.
|
3968
4347
|
class GoogleCloudRetailV2alphaRuleFilterAction
|
3969
4348
|
include Google::Apis::Core::Hashable
|
3970
4349
|
|
@@ -4045,8 +4424,8 @@ module Google
|
|
4045
4424
|
end
|
4046
4425
|
|
4047
4426
|
# Redirects a shopper to a specific page. * Rule Condition: - Must specify
|
4048
|
-
# Condition. * Action Input: Request Query * Action Result:
|
4049
|
-
# provided uri.
|
4427
|
+
# Condition.query_terms. * Action Input: Request Query * Action Result:
|
4428
|
+
# Redirects shopper to provided uri.
|
4050
4429
|
class GoogleCloudRetailV2alphaRuleRedirectAction
|
4051
4430
|
include Google::Apis::Core::Hashable
|
4052
4431
|
|
@@ -4692,7 +5071,7 @@ module Google
|
|
4692
5071
|
|
4693
5072
|
# Contains the spell corrected query, if found. If the spell correction type is
|
4694
5073
|
# AUTOMATIC, then the search results are based on corrected_query. Otherwise the
|
4695
|
-
# original query
|
5074
|
+
# original query is used for search.
|
4696
5075
|
# Corresponds to the JSON property `correctedQuery`
|
4697
5076
|
# @return [String]
|
4698
5077
|
attr_accessor :corrected_query
|
@@ -5200,6 +5579,53 @@ module Google
|
|
5200
5579
|
end
|
5201
5580
|
end
|
5202
5581
|
|
5582
|
+
# Metadata associated with a tune operation.
|
5583
|
+
class GoogleCloudRetailV2alphaTuneModelMetadata
|
5584
|
+
include Google::Apis::Core::Hashable
|
5585
|
+
|
5586
|
+
# The resource name of the model that this tune applies to. Format: projects/`
|
5587
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
5588
|
+
# Corresponds to the JSON property `model`
|
5589
|
+
# @return [String]
|
5590
|
+
attr_accessor :model
|
5591
|
+
|
5592
|
+
def initialize(**args)
|
5593
|
+
update!(**args)
|
5594
|
+
end
|
5595
|
+
|
5596
|
+
# Update properties of this object
|
5597
|
+
def update!(**args)
|
5598
|
+
@model = args[:model] if args.key?(:model)
|
5599
|
+
end
|
5600
|
+
end
|
5601
|
+
|
5602
|
+
# Request to manually start a tuning process now (instead of waiting for the
|
5603
|
+
# periodically scheduled tuning to happen).
|
5604
|
+
class GoogleCloudRetailV2alphaTuneModelRequest
|
5605
|
+
include Google::Apis::Core::Hashable
|
5606
|
+
|
5607
|
+
def initialize(**args)
|
5608
|
+
update!(**args)
|
5609
|
+
end
|
5610
|
+
|
5611
|
+
# Update properties of this object
|
5612
|
+
def update!(**args)
|
5613
|
+
end
|
5614
|
+
end
|
5615
|
+
|
5616
|
+
# Response associated with a tune operation.
|
5617
|
+
class GoogleCloudRetailV2alphaTuneModelResponse
|
5618
|
+
include Google::Apis::Core::Hashable
|
5619
|
+
|
5620
|
+
def initialize(**args)
|
5621
|
+
update!(**args)
|
5622
|
+
end
|
5623
|
+
|
5624
|
+
# Update properties of this object
|
5625
|
+
def update!(**args)
|
5626
|
+
end
|
5627
|
+
end
|
5628
|
+
|
5203
5629
|
# UserEvent captures all metadata information Retail API needs to know about how
|
5204
5630
|
# end users interact with customers' website.
|
5205
5631
|
class GoogleCloudRetailV2alphaUserEvent
|
@@ -5622,6 +6048,31 @@ module Google
|
|
5622
6048
|
end
|
5623
6049
|
end
|
5624
6050
|
|
6051
|
+
# A BigQuery output result.
|
6052
|
+
class GoogleCloudRetailV2betaBigQueryOutputResult
|
6053
|
+
include Google::Apis::Core::Hashable
|
6054
|
+
|
6055
|
+
# The ID of a BigQuery Dataset.
|
6056
|
+
# Corresponds to the JSON property `datasetId`
|
6057
|
+
# @return [String]
|
6058
|
+
attr_accessor :dataset_id
|
6059
|
+
|
6060
|
+
# The ID of a BigQuery Table.
|
6061
|
+
# Corresponds to the JSON property `tableId`
|
6062
|
+
# @return [String]
|
6063
|
+
attr_accessor :table_id
|
6064
|
+
|
6065
|
+
def initialize(**args)
|
6066
|
+
update!(**args)
|
6067
|
+
end
|
6068
|
+
|
6069
|
+
# Update properties of this object
|
6070
|
+
def update!(**args)
|
6071
|
+
@dataset_id = args[:dataset_id] if args.key?(:dataset_id)
|
6072
|
+
@table_id = args[:table_id] if args.key?(:table_id)
|
6073
|
+
end
|
6074
|
+
end
|
6075
|
+
|
5625
6076
|
# Configuration of destination for Export related errors.
|
5626
6077
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
5627
6078
|
include Google::Apis::Core::Hashable
|
@@ -5686,6 +6137,11 @@ module Google
|
|
5686
6137
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig]
|
5687
6138
|
attr_accessor :errors_config
|
5688
6139
|
|
6140
|
+
# Output result.
|
6141
|
+
# Corresponds to the JSON property `outputResult`
|
6142
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult]
|
6143
|
+
attr_accessor :output_result
|
6144
|
+
|
5689
6145
|
def initialize(**args)
|
5690
6146
|
update!(**args)
|
5691
6147
|
end
|
@@ -5694,6 +6150,7 @@ module Google
|
|
5694
6150
|
def update!(**args)
|
5695
6151
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
5696
6152
|
@errors_config = args[:errors_config] if args.key?(:errors_config)
|
6153
|
+
@output_result = args[:output_result] if args.key?(:output_result)
|
5697
6154
|
end
|
5698
6155
|
end
|
5699
6156
|
|
@@ -5713,6 +6170,11 @@ module Google
|
|
5713
6170
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig]
|
5714
6171
|
attr_accessor :errors_config
|
5715
6172
|
|
6173
|
+
# Output result.
|
6174
|
+
# Corresponds to the JSON property `outputResult`
|
6175
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult]
|
6176
|
+
attr_accessor :output_result
|
6177
|
+
|
5716
6178
|
def initialize(**args)
|
5717
6179
|
update!(**args)
|
5718
6180
|
end
|
@@ -5721,6 +6183,7 @@ module Google
|
|
5721
6183
|
def update!(**args)
|
5722
6184
|
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
5723
6185
|
@errors_config = args[:errors_config] if args.key?(:errors_config)
|
6186
|
+
@output_result = args[:output_result] if args.key?(:output_result)
|
5724
6187
|
end
|
5725
6188
|
end
|
5726
6189
|
|
@@ -5881,6 +6344,25 @@ module Google
|
|
5881
6344
|
end
|
5882
6345
|
end
|
5883
6346
|
|
6347
|
+
# Output result.
|
6348
|
+
class GoogleCloudRetailV2betaOutputResult
|
6349
|
+
include Google::Apis::Core::Hashable
|
6350
|
+
|
6351
|
+
# Export result in BigQuery.
|
6352
|
+
# Corresponds to the JSON property `bigqueryResult`
|
6353
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaBigQueryOutputResult>]
|
6354
|
+
attr_accessor :bigquery_result
|
6355
|
+
|
6356
|
+
def initialize(**args)
|
6357
|
+
update!(**args)
|
6358
|
+
end
|
6359
|
+
|
6360
|
+
# Update properties of this object
|
6361
|
+
def update!(**args)
|
6362
|
+
@bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
|
6363
|
+
end
|
6364
|
+
end
|
6365
|
+
|
5884
6366
|
# Metadata related to the progress of the Purge operation. This will be returned
|
5885
6367
|
# by the google.longrunning.Operation.metadata field.
|
5886
6368
|
class GoogleCloudRetailV2betaPurgeMetadata
|