google-apis-retail_v2alpha 0.48.0 → 0.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 802ded10d047540ace34c876a963280595ec2f08b87da93fa0f6b0e7c00e653c
|
|
4
|
+
data.tar.gz: b4d92fdaeb95f1ea9894874a18530a5de1ccd8e6fb95796335c2440f8e27272a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d9df881c0b9bcf4bafdf505a132192e00e73389a1610894fbf403826d9ed23c838bf101e2a42ca8529e51cf9fc6dd69b319e6fbadff604a5abfaf2b89b651d2b
|
|
7
|
+
data.tar.gz: 9944516c716b1e1b0240680c11c6793f97b83882d9497811ca5662dd198064369ed1360ef3b6a027267ae264ce2e0e28c9a8ef96ca04f0786c0006ad1eddf3fe
|
data/CHANGELOG.md
CHANGED
|
@@ -1245,9 +1245,8 @@ module Google
|
|
|
1245
1245
|
|
|
1246
1246
|
# Custom attributes for the suggestion term. * For "user-data", the attributes
|
|
1247
1247
|
# 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.
|
|
1248
|
+
# retail", the attributes are product attributes generated by Cloud Retail. It
|
|
1249
|
+
# requires UserEvent.product_details is imported properly.
|
|
1251
1250
|
# Corresponds to the JSON property `attributes`
|
|
1252
1251
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
|
1253
1252
|
attr_accessor :attributes
|
|
@@ -1586,6 +1585,26 @@ module Google
|
|
|
1586
1585
|
end
|
|
1587
1586
|
end
|
|
1588
1587
|
|
|
1588
|
+
# Metadata associated with a create operation.
|
|
1589
|
+
class GoogleCloudRetailV2alphaCreateModelMetadata
|
|
1590
|
+
include Google::Apis::Core::Hashable
|
|
1591
|
+
|
|
1592
|
+
# The resource name of the model that this create applies to. Format: projects/`
|
|
1593
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1594
|
+
# Corresponds to the JSON property `model`
|
|
1595
|
+
# @return [String]
|
|
1596
|
+
attr_accessor :model
|
|
1597
|
+
|
|
1598
|
+
def initialize(**args)
|
|
1599
|
+
update!(**args)
|
|
1600
|
+
end
|
|
1601
|
+
|
|
1602
|
+
# Update properties of this object
|
|
1603
|
+
def update!(**args)
|
|
1604
|
+
@model = args[:model] if args.key?(:model)
|
|
1605
|
+
end
|
|
1606
|
+
end
|
|
1607
|
+
|
|
1589
1608
|
# A custom attribute that is not explicitly modeled in Product.
|
|
1590
1609
|
class GoogleCloudRetailV2alphaCustomAttribute
|
|
1591
1610
|
include Google::Apis::Core::Hashable
|
|
@@ -2260,6 +2279,31 @@ module Google
|
|
|
2260
2279
|
end
|
|
2261
2280
|
end
|
|
2262
2281
|
|
|
2282
|
+
# Response to a ListModelRequest.
|
|
2283
|
+
class GoogleCloudRetailV2alphaListModelsResponse
|
|
2284
|
+
include Google::Apis::Core::Hashable
|
|
2285
|
+
|
|
2286
|
+
# List of Models.
|
|
2287
|
+
# Corresponds to the JSON property `models`
|
|
2288
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel>]
|
|
2289
|
+
attr_accessor :models
|
|
2290
|
+
|
|
2291
|
+
# Pagination token, if not returned indicates the last page.
|
|
2292
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
2293
|
+
# @return [String]
|
|
2294
|
+
attr_accessor :next_page_token
|
|
2295
|
+
|
|
2296
|
+
def initialize(**args)
|
|
2297
|
+
update!(**args)
|
|
2298
|
+
end
|
|
2299
|
+
|
|
2300
|
+
# Update properties of this object
|
|
2301
|
+
def update!(**args)
|
|
2302
|
+
@models = args[:models] if args.key?(:models)
|
|
2303
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
2304
|
+
end
|
|
2305
|
+
end
|
|
2306
|
+
|
|
2263
2307
|
# Response message for ProductService.ListProducts method.
|
|
2264
2308
|
class GoogleCloudRetailV2alphaListProductsResponse
|
|
2265
2309
|
include Google::Apis::Core::Hashable
|
|
@@ -2455,6 +2499,244 @@ module Google
|
|
|
2455
2499
|
end
|
|
2456
2500
|
end
|
|
2457
2501
|
|
|
2502
|
+
# Metadata that describes the training and serving parameters of a Model. A
|
|
2503
|
+
# Model can be associated with a ServingConfig and then queried through the
|
|
2504
|
+
# Predict api.
|
|
2505
|
+
class GoogleCloudRetailV2alphaModel
|
|
2506
|
+
include Google::Apis::Core::Hashable
|
|
2507
|
+
|
|
2508
|
+
# Output only. Timestamp the Recommendation Model was created at.
|
|
2509
|
+
# Corresponds to the JSON property `createTime`
|
|
2510
|
+
# @return [String]
|
|
2511
|
+
attr_accessor :create_time
|
|
2512
|
+
|
|
2513
|
+
# Output only. The state of data requirements for this model: DATA_OK and
|
|
2514
|
+
# DATA_ERROR. Recommendation model cannot be trained if the data is in
|
|
2515
|
+
# DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
|
|
2516
|
+
# serving state is ACTIVE: models were trained successfully before, but cannot
|
|
2517
|
+
# be refreshed because model no longer has sufficient data for training.
|
|
2518
|
+
# Corresponds to the JSON property `dataState`
|
|
2519
|
+
# @return [String]
|
|
2520
|
+
attr_accessor :data_state
|
|
2521
|
+
|
|
2522
|
+
# Required. The display name of the model. Should be human readable, used to
|
|
2523
|
+
# display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
|
|
2524
|
+
# string with limit of 1024 characters.
|
|
2525
|
+
# Corresponds to the JSON property `displayName`
|
|
2526
|
+
# @return [String]
|
|
2527
|
+
attr_accessor :display_name
|
|
2528
|
+
|
|
2529
|
+
# Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
|
|
2530
|
+
# attributes is enabled for the model.
|
|
2531
|
+
# Corresponds to the JSON property `filteringOption`
|
|
2532
|
+
# @return [String]
|
|
2533
|
+
attr_accessor :filtering_option
|
|
2534
|
+
|
|
2535
|
+
# Output only. The timestamp when the latest successful tune finished.
|
|
2536
|
+
# Corresponds to the JSON property `lastTuneTime`
|
|
2537
|
+
# @return [String]
|
|
2538
|
+
attr_accessor :last_tune_time
|
|
2539
|
+
|
|
2540
|
+
# Required. The fully qualified resource name of the model. Format: projects/`
|
|
2541
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
2542
|
+
# catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
|
|
2543
|
+
# Corresponds to the JSON property `name`
|
|
2544
|
+
# @return [String]
|
|
2545
|
+
attr_accessor :name
|
|
2546
|
+
|
|
2547
|
+
# Optional. The optimization objective e.g. `cvr`. Currently supported values: `
|
|
2548
|
+
# ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
|
|
2549
|
+
# model type. Default depends on type of recommendation: `recommended-for-you` =>
|
|
2550
|
+
# `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
|
|
2551
|
+
# revenue_per_order`
|
|
2552
|
+
# Corresponds to the JSON property `optimizationObjective`
|
|
2553
|
+
# @return [String]
|
|
2554
|
+
attr_accessor :optimization_objective
|
|
2555
|
+
|
|
2556
|
+
# The PageOptimizationConfig for model training. This determines how many panels
|
|
2557
|
+
# to optimize for, and which serving configurations to consider for each panel.
|
|
2558
|
+
# The purpose of this model is to optimize which ServingConfig to show on which
|
|
2559
|
+
# panels in way that optimizes the visitors shopping journey.
|
|
2560
|
+
# Corresponds to the JSON property `pageOptimizationConfig`
|
|
2561
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
|
|
2562
|
+
attr_accessor :page_optimization_config
|
|
2563
|
+
|
|
2564
|
+
# Optional. The state of periodic tuning. The period we use is 3 months - to do
|
|
2565
|
+
# a one-off tune earlier use the TuneModel method. Default value is
|
|
2566
|
+
# PERIODIC_TUNING_ENABLED.
|
|
2567
|
+
# Corresponds to the JSON property `periodicTuningState`
|
|
2568
|
+
# @return [String]
|
|
2569
|
+
attr_accessor :periodic_tuning_state
|
|
2570
|
+
|
|
2571
|
+
# Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
|
|
2572
|
+
# Corresponds to the JSON property `servingState`
|
|
2573
|
+
# @return [String]
|
|
2574
|
+
attr_accessor :serving_state
|
|
2575
|
+
|
|
2576
|
+
# Optional. The training state that the model is in (e.g. TRAINING or PAUSED).
|
|
2577
|
+
# Since part of the cost of running the service is frequency of training - this
|
|
2578
|
+
# can be used to determine when to train model in order to control cost. If not
|
|
2579
|
+
# specified: the default value for CreateModel method is TRAINING. the default
|
|
2580
|
+
# value for UpdateModel method is to keep the state the same as before.
|
|
2581
|
+
# Corresponds to the JSON property `trainingState`
|
|
2582
|
+
# @return [String]
|
|
2583
|
+
attr_accessor :training_state
|
|
2584
|
+
|
|
2585
|
+
# Output only. The tune operation associated with the model. Can be used to
|
|
2586
|
+
# determine if there is an ongoing tune for this recommendation. Empty field
|
|
2587
|
+
# implies no tune is goig on.
|
|
2588
|
+
# Corresponds to the JSON property `tuningOperation`
|
|
2589
|
+
# @return [String]
|
|
2590
|
+
attr_accessor :tuning_operation
|
|
2591
|
+
|
|
2592
|
+
# Required. The type of model e.g. `home-page`. Currently supported values: `
|
|
2593
|
+
# recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
|
|
2594
|
+
# page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(
|
|
2595
|
+
# readonly value).
|
|
2596
|
+
# Corresponds to the JSON property `type`
|
|
2597
|
+
# @return [String]
|
|
2598
|
+
attr_accessor :type
|
|
2599
|
+
|
|
2600
|
+
# Output only. Timestamp the Recommendation Model was last updated. E.g. if a
|
|
2601
|
+
# Recommendation Model was paused - this would be the time the pause was
|
|
2602
|
+
# initiated.
|
|
2603
|
+
# Corresponds to the JSON property `updateTime`
|
|
2604
|
+
# @return [String]
|
|
2605
|
+
attr_accessor :update_time
|
|
2606
|
+
|
|
2607
|
+
def initialize(**args)
|
|
2608
|
+
update!(**args)
|
|
2609
|
+
end
|
|
2610
|
+
|
|
2611
|
+
# Update properties of this object
|
|
2612
|
+
def update!(**args)
|
|
2613
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
|
2614
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
|
2615
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
2616
|
+
@filtering_option = args[:filtering_option] if args.key?(:filtering_option)
|
|
2617
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
|
2618
|
+
@name = args[:name] if args.key?(:name)
|
|
2619
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
|
2620
|
+
@page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
|
|
2621
|
+
@periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
|
|
2622
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
|
2623
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
|
2624
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
|
2625
|
+
@type = args[:type] if args.key?(:type)
|
|
2626
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
|
2627
|
+
end
|
|
2628
|
+
end
|
|
2629
|
+
|
|
2630
|
+
# The PageOptimizationConfig for model training. This determines how many panels
|
|
2631
|
+
# to optimize for, and which serving configurations to consider for each panel.
|
|
2632
|
+
# The purpose of this model is to optimize which ServingConfig to show on which
|
|
2633
|
+
# panels in way that optimizes the visitors shopping journey.
|
|
2634
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfig
|
|
2635
|
+
include Google::Apis::Core::Hashable
|
|
2636
|
+
|
|
2637
|
+
# Required. The type of UserEvent this page optimization is shown for. Each page
|
|
2638
|
+
# has an associated event type - this will be the corresponding event type for
|
|
2639
|
+
# the page that the page optimization model is used on. Supported types: * `add-
|
|
2640
|
+
# to-cart`: Products being added to cart. * `detail-page-view`: Products detail
|
|
2641
|
+
# page viewed. * `home-page-view`: Homepage viewed * `category-page-view`:
|
|
2642
|
+
# Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `
|
|
2643
|
+
# home-page-view` only allows models with type `recommended-for-you`. All other
|
|
2644
|
+
# page_optimization_event_type allow all Model.types.
|
|
2645
|
+
# Corresponds to the JSON property `pageOptimizationEventType`
|
|
2646
|
+
# @return [String]
|
|
2647
|
+
attr_accessor :page_optimization_event_type
|
|
2648
|
+
|
|
2649
|
+
# Required. A list of panel configurations. Limit = 5.
|
|
2650
|
+
# Corresponds to the JSON property `panels`
|
|
2651
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>]
|
|
2652
|
+
attr_accessor :panels
|
|
2653
|
+
|
|
2654
|
+
# Optional. How to restrict results across panels e.g. can the same
|
|
2655
|
+
# ServingConfig be shown on multiple panels at once. If unspecified, default to `
|
|
2656
|
+
# UNIQUE_MODEL_RESTRICTION`.
|
|
2657
|
+
# Corresponds to the JSON property `restriction`
|
|
2658
|
+
# @return [String]
|
|
2659
|
+
attr_accessor :restriction
|
|
2660
|
+
|
|
2661
|
+
def initialize(**args)
|
|
2662
|
+
update!(**args)
|
|
2663
|
+
end
|
|
2664
|
+
|
|
2665
|
+
# Update properties of this object
|
|
2666
|
+
def update!(**args)
|
|
2667
|
+
@page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
|
|
2668
|
+
@panels = args[:panels] if args.key?(:panels)
|
|
2669
|
+
@restriction = args[:restriction] if args.key?(:restriction)
|
|
2670
|
+
end
|
|
2671
|
+
end
|
|
2672
|
+
|
|
2673
|
+
# A candidate to consider for a given panel. Currently only ServingConfig are
|
|
2674
|
+
# valid candidates.
|
|
2675
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
|
|
2676
|
+
include Google::Apis::Core::Hashable
|
|
2677
|
+
|
|
2678
|
+
# This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
|
|
2679
|
+
# full name: `projects/*/locations/global/catalogs/default_catalog/
|
|
2680
|
+
# servingConfigs/my_candidate_config` this would be 'my_candidate_config'
|
|
2681
|
+
# Corresponds to the JSON property `servingConfigId`
|
|
2682
|
+
# @return [String]
|
|
2683
|
+
attr_accessor :serving_config_id
|
|
2684
|
+
|
|
2685
|
+
def initialize(**args)
|
|
2686
|
+
update!(**args)
|
|
2687
|
+
end
|
|
2688
|
+
|
|
2689
|
+
# Update properties of this object
|
|
2690
|
+
def update!(**args)
|
|
2691
|
+
@serving_config_id = args[:serving_config_id] if args.key?(:serving_config_id)
|
|
2692
|
+
end
|
|
2693
|
+
end
|
|
2694
|
+
|
|
2695
|
+
# An individual panel with a list of ServingConfigs to consider for it.
|
|
2696
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
|
|
2697
|
+
include Google::Apis::Core::Hashable
|
|
2698
|
+
|
|
2699
|
+
# Required. The candidates to consider on the panel. Limit = 10.
|
|
2700
|
+
# Corresponds to the JSON property `candidates`
|
|
2701
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
|
|
2702
|
+
attr_accessor :candidates
|
|
2703
|
+
|
|
2704
|
+
# A candidate to consider for a given panel. Currently only ServingConfig are
|
|
2705
|
+
# valid candidates.
|
|
2706
|
+
# Corresponds to the JSON property `defaultCandidate`
|
|
2707
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate]
|
|
2708
|
+
attr_accessor :default_candidate
|
|
2709
|
+
|
|
2710
|
+
# Optional. The name to display for the panel.
|
|
2711
|
+
# Corresponds to the JSON property `displayName`
|
|
2712
|
+
# @return [String]
|
|
2713
|
+
attr_accessor :display_name
|
|
2714
|
+
|
|
2715
|
+
def initialize(**args)
|
|
2716
|
+
update!(**args)
|
|
2717
|
+
end
|
|
2718
|
+
|
|
2719
|
+
# Update properties of this object
|
|
2720
|
+
def update!(**args)
|
|
2721
|
+
@candidates = args[:candidates] if args.key?(:candidates)
|
|
2722
|
+
@default_candidate = args[:default_candidate] if args.key?(:default_candidate)
|
|
2723
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
2724
|
+
end
|
|
2725
|
+
end
|
|
2726
|
+
|
|
2727
|
+
# Request for pausing training of a model.
|
|
2728
|
+
class GoogleCloudRetailV2alphaPauseModelRequest
|
|
2729
|
+
include Google::Apis::Core::Hashable
|
|
2730
|
+
|
|
2731
|
+
def initialize(**args)
|
|
2732
|
+
update!(**args)
|
|
2733
|
+
end
|
|
2734
|
+
|
|
2735
|
+
# Update properties of this object
|
|
2736
|
+
def update!(**args)
|
|
2737
|
+
end
|
|
2738
|
+
end
|
|
2739
|
+
|
|
2458
2740
|
# Request message for Predict method.
|
|
2459
2741
|
class GoogleCloudRetailV2alphaPredictRequest
|
|
2460
2742
|
include Google::Apis::Core::Hashable
|
|
@@ -2476,7 +2758,7 @@ module Google
|
|
|
2476
2758
|
# in `PredictRequest.params` to receive empty results instead. Note that the API
|
|
2477
2759
|
# will never return items with storageStatus of "EXPIRED" or "DELETED"
|
|
2478
2760
|
# regardless of filter choices. If `filterSyntaxV2` is set to true under the `
|
|
2479
|
-
# params` field, then attribute
|
|
2761
|
+
# params` field, then attribute-based expressions are expected instead of the
|
|
2480
2762
|
# above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
|
|
2481
2763
|
# NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
|
|
2482
2764
|
# ANY("Red") OR categories: ANY("Phones"))
|
|
@@ -2507,7 +2789,7 @@ module Google
|
|
|
2507
2789
|
# @return [Fixnum]
|
|
2508
2790
|
attr_accessor :page_size
|
|
2509
2791
|
|
|
2510
|
-
# This field is not used for now,
|
|
2792
|
+
# This field is not used for now, leave it unset.
|
|
2511
2793
|
# Corresponds to the JSON property `pageToken`
|
|
2512
2794
|
# @return [String]
|
|
2513
2795
|
attr_accessor :page_token
|
|
@@ -2529,8 +2811,8 @@ module Google
|
|
|
2529
2811
|
# it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
|
|
2530
2812
|
# high-diversity', 'auto-diversity'`. This gives request-level control and
|
|
2531
2813
|
# adjusts prediction results based on product category. * `filterSyntaxV2`:
|
|
2532
|
-
# Boolean. False by default. If set to true, the `filter` field
|
|
2533
|
-
#
|
|
2814
|
+
# Boolean. False by default. If set to true, the `filter` field is interpreteted
|
|
2815
|
+
# according to the new, attribute-based syntax.
|
|
2534
2816
|
# Corresponds to the JSON property `params`
|
|
2535
2817
|
# @return [Hash<String,Object>]
|
|
2536
2818
|
attr_accessor :params
|
|
@@ -3794,6 +4076,19 @@ module Google
|
|
|
3794
4076
|
end
|
|
3795
4077
|
end
|
|
3796
4078
|
|
|
4079
|
+
# Request for resuming training of a model.
|
|
4080
|
+
class GoogleCloudRetailV2alphaResumeModelRequest
|
|
4081
|
+
include Google::Apis::Core::Hashable
|
|
4082
|
+
|
|
4083
|
+
def initialize(**args)
|
|
4084
|
+
update!(**args)
|
|
4085
|
+
end
|
|
4086
|
+
|
|
4087
|
+
# Update properties of this object
|
|
4088
|
+
def update!(**args)
|
|
4089
|
+
end
|
|
4090
|
+
end
|
|
4091
|
+
|
|
3797
4092
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
|
3798
4093
|
# triggered. * An action specifies what occurs on that trigger. Currently only
|
|
3799
4094
|
# boost rules are supported. Currently only supported by the search endpoint.
|
|
@@ -3821,13 +4116,13 @@ module Google
|
|
|
3821
4116
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleDoNotAssociateAction]
|
|
3822
4117
|
attr_accessor :do_not_associate_action
|
|
3823
4118
|
|
|
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.
|
|
4119
|
+
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
|
4120
|
+
# or more Condition.query_terms provided is combined with OR operator. * Action
|
|
4121
|
+
# Input: The request query and filter that are applied to the retrieved products,
|
|
4122
|
+
# in addition to any filters already provided with the SearchRequest. The AND
|
|
4123
|
+
# operator is used to combine the query's existing filters with the filter rule(
|
|
4124
|
+
# s). NOTE: May result in 0 results when filters conflict. * Action Result:
|
|
4125
|
+
# Filters the returned objects to be ONLY those that passed the filter.
|
|
3831
4126
|
# Corresponds to the JSON property `filterAction`
|
|
3832
4127
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleFilterAction]
|
|
3833
4128
|
attr_accessor :filter_action
|
|
@@ -3847,8 +4142,8 @@ module Google
|
|
|
3847
4142
|
attr_accessor :oneway_synonyms_action
|
|
3848
4143
|
|
|
3849
4144
|
# Redirects a shopper to a specific page. * Rule Condition: - Must specify
|
|
3850
|
-
# Condition. * Action Input: Request Query * Action Result:
|
|
3851
|
-
# provided uri.
|
|
4145
|
+
# Condition.query_terms. * Action Input: Request Query * Action Result:
|
|
4146
|
+
# Redirects shopper to provided uri.
|
|
3852
4147
|
# Corresponds to the JSON property `redirectAction`
|
|
3853
4148
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRedirectAction]
|
|
3854
4149
|
attr_accessor :redirect_action
|
|
@@ -3958,13 +4253,13 @@ module Google
|
|
|
3958
4253
|
end
|
|
3959
4254
|
end
|
|
3960
4255
|
|
|
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.
|
|
4256
|
+
# * Rule Condition: - No Condition.query_terms provided is a global match. - 1
|
|
4257
|
+
# or more Condition.query_terms provided is combined with OR operator. * Action
|
|
4258
|
+
# Input: The request query and filter that are applied to the retrieved products,
|
|
4259
|
+
# in addition to any filters already provided with the SearchRequest. The AND
|
|
4260
|
+
# operator is used to combine the query's existing filters with the filter rule(
|
|
4261
|
+
# s). NOTE: May result in 0 results when filters conflict. * Action Result:
|
|
4262
|
+
# Filters the returned objects to be ONLY those that passed the filter.
|
|
3968
4263
|
class GoogleCloudRetailV2alphaRuleFilterAction
|
|
3969
4264
|
include Google::Apis::Core::Hashable
|
|
3970
4265
|
|
|
@@ -4045,8 +4340,8 @@ module Google
|
|
|
4045
4340
|
end
|
|
4046
4341
|
|
|
4047
4342
|
# Redirects a shopper to a specific page. * Rule Condition: - Must specify
|
|
4048
|
-
# Condition. * Action Input: Request Query * Action Result:
|
|
4049
|
-
# provided uri.
|
|
4343
|
+
# Condition.query_terms. * Action Input: Request Query * Action Result:
|
|
4344
|
+
# Redirects shopper to provided uri.
|
|
4050
4345
|
class GoogleCloudRetailV2alphaRuleRedirectAction
|
|
4051
4346
|
include Google::Apis::Core::Hashable
|
|
4052
4347
|
|
|
@@ -4692,7 +4987,7 @@ module Google
|
|
|
4692
4987
|
|
|
4693
4988
|
# Contains the spell corrected query, if found. If the spell correction type is
|
|
4694
4989
|
# AUTOMATIC, then the search results are based on corrected_query. Otherwise the
|
|
4695
|
-
# original query
|
|
4990
|
+
# original query is used for search.
|
|
4696
4991
|
# Corresponds to the JSON property `correctedQuery`
|
|
4697
4992
|
# @return [String]
|
|
4698
4993
|
attr_accessor :corrected_query
|
|
@@ -5200,6 +5495,53 @@ module Google
|
|
|
5200
5495
|
end
|
|
5201
5496
|
end
|
|
5202
5497
|
|
|
5498
|
+
# Metadata associated with a tune operation.
|
|
5499
|
+
class GoogleCloudRetailV2alphaTuneModelMetadata
|
|
5500
|
+
include Google::Apis::Core::Hashable
|
|
5501
|
+
|
|
5502
|
+
# The resource name of the model that this tune applies to. Format: projects/`
|
|
5503
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
5504
|
+
# Corresponds to the JSON property `model`
|
|
5505
|
+
# @return [String]
|
|
5506
|
+
attr_accessor :model
|
|
5507
|
+
|
|
5508
|
+
def initialize(**args)
|
|
5509
|
+
update!(**args)
|
|
5510
|
+
end
|
|
5511
|
+
|
|
5512
|
+
# Update properties of this object
|
|
5513
|
+
def update!(**args)
|
|
5514
|
+
@model = args[:model] if args.key?(:model)
|
|
5515
|
+
end
|
|
5516
|
+
end
|
|
5517
|
+
|
|
5518
|
+
# Request to manually start a tuning process now (instead of waiting for the
|
|
5519
|
+
# periodically scheduled tuning to happen).
|
|
5520
|
+
class GoogleCloudRetailV2alphaTuneModelRequest
|
|
5521
|
+
include Google::Apis::Core::Hashable
|
|
5522
|
+
|
|
5523
|
+
def initialize(**args)
|
|
5524
|
+
update!(**args)
|
|
5525
|
+
end
|
|
5526
|
+
|
|
5527
|
+
# Update properties of this object
|
|
5528
|
+
def update!(**args)
|
|
5529
|
+
end
|
|
5530
|
+
end
|
|
5531
|
+
|
|
5532
|
+
# Response associated with a tune operation.
|
|
5533
|
+
class GoogleCloudRetailV2alphaTuneModelResponse
|
|
5534
|
+
include Google::Apis::Core::Hashable
|
|
5535
|
+
|
|
5536
|
+
def initialize(**args)
|
|
5537
|
+
update!(**args)
|
|
5538
|
+
end
|
|
5539
|
+
|
|
5540
|
+
# Update properties of this object
|
|
5541
|
+
def update!(**args)
|
|
5542
|
+
end
|
|
5543
|
+
end
|
|
5544
|
+
|
|
5203
5545
|
# UserEvent captures all metadata information Retail API needs to know about how
|
|
5204
5546
|
# end users interact with customers' website.
|
|
5205
5547
|
class GoogleCloudRetailV2alphaUserEvent
|
|
@@ -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.49.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.9.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20220716"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -328,6 +328,12 @@ module Google
|
|
|
328
328
|
include Google::Apis::Core::JsonObjectSupport
|
|
329
329
|
end
|
|
330
330
|
|
|
331
|
+
class GoogleCloudRetailV2alphaCreateModelMetadata
|
|
332
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
333
|
+
|
|
334
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
335
|
+
end
|
|
336
|
+
|
|
331
337
|
class GoogleCloudRetailV2alphaCustomAttribute
|
|
332
338
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
333
339
|
|
|
@@ -448,6 +454,12 @@ module Google
|
|
|
448
454
|
include Google::Apis::Core::JsonObjectSupport
|
|
449
455
|
end
|
|
450
456
|
|
|
457
|
+
class GoogleCloudRetailV2alphaListModelsResponse
|
|
458
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
459
|
+
|
|
460
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
461
|
+
end
|
|
462
|
+
|
|
451
463
|
class GoogleCloudRetailV2alphaListProductsResponse
|
|
452
464
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
453
465
|
|
|
@@ -478,6 +490,36 @@ module Google
|
|
|
478
490
|
include Google::Apis::Core::JsonObjectSupport
|
|
479
491
|
end
|
|
480
492
|
|
|
493
|
+
class GoogleCloudRetailV2alphaModel
|
|
494
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
495
|
+
|
|
496
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfig
|
|
500
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
501
|
+
|
|
502
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
503
|
+
end
|
|
504
|
+
|
|
505
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
|
|
506
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
507
|
+
|
|
508
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
509
|
+
end
|
|
510
|
+
|
|
511
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
|
|
512
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
513
|
+
|
|
514
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
515
|
+
end
|
|
516
|
+
|
|
517
|
+
class GoogleCloudRetailV2alphaPauseModelRequest
|
|
518
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
519
|
+
|
|
520
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
521
|
+
end
|
|
522
|
+
|
|
481
523
|
class GoogleCloudRetailV2alphaPredictRequest
|
|
482
524
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
483
525
|
|
|
@@ -664,6 +706,12 @@ module Google
|
|
|
664
706
|
include Google::Apis::Core::JsonObjectSupport
|
|
665
707
|
end
|
|
666
708
|
|
|
709
|
+
class GoogleCloudRetailV2alphaResumeModelRequest
|
|
710
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
711
|
+
|
|
712
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
713
|
+
end
|
|
714
|
+
|
|
667
715
|
class GoogleCloudRetailV2alphaRule
|
|
668
716
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
669
717
|
|
|
@@ -832,6 +880,24 @@ module Google
|
|
|
832
880
|
include Google::Apis::Core::JsonObjectSupport
|
|
833
881
|
end
|
|
834
882
|
|
|
883
|
+
class GoogleCloudRetailV2alphaTuneModelMetadata
|
|
884
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
885
|
+
|
|
886
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
887
|
+
end
|
|
888
|
+
|
|
889
|
+
class GoogleCloudRetailV2alphaTuneModelRequest
|
|
890
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
891
|
+
|
|
892
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
893
|
+
end
|
|
894
|
+
|
|
895
|
+
class GoogleCloudRetailV2alphaTuneModelResponse
|
|
896
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
897
|
+
|
|
898
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
899
|
+
end
|
|
900
|
+
|
|
835
901
|
class GoogleCloudRetailV2alphaUserEvent
|
|
836
902
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
837
903
|
|
|
@@ -1476,6 +1542,13 @@ module Google
|
|
|
1476
1542
|
end
|
|
1477
1543
|
end
|
|
1478
1544
|
|
|
1545
|
+
class GoogleCloudRetailV2alphaCreateModelMetadata
|
|
1546
|
+
# @private
|
|
1547
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1548
|
+
property :model, as: 'model'
|
|
1549
|
+
end
|
|
1550
|
+
end
|
|
1551
|
+
|
|
1479
1552
|
class GoogleCloudRetailV2alphaCustomAttribute
|
|
1480
1553
|
# @private
|
|
1481
1554
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1666,6 +1739,15 @@ module Google
|
|
|
1666
1739
|
end
|
|
1667
1740
|
end
|
|
1668
1741
|
|
|
1742
|
+
class GoogleCloudRetailV2alphaListModelsResponse
|
|
1743
|
+
# @private
|
|
1744
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1745
|
+
collection :models, as: 'models', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1746
|
+
|
|
1747
|
+
property :next_page_token, as: 'nextPageToken'
|
|
1748
|
+
end
|
|
1749
|
+
end
|
|
1750
|
+
|
|
1669
1751
|
class GoogleCloudRetailV2alphaListProductsResponse
|
|
1670
1752
|
# @private
|
|
1671
1753
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1716,6 +1798,61 @@ module Google
|
|
|
1716
1798
|
end
|
|
1717
1799
|
end
|
|
1718
1800
|
|
|
1801
|
+
class GoogleCloudRetailV2alphaModel
|
|
1802
|
+
# @private
|
|
1803
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1804
|
+
property :create_time, as: 'createTime'
|
|
1805
|
+
property :data_state, as: 'dataState'
|
|
1806
|
+
property :display_name, as: 'displayName'
|
|
1807
|
+
property :filtering_option, as: 'filteringOption'
|
|
1808
|
+
property :last_tune_time, as: 'lastTuneTime'
|
|
1809
|
+
property :name, as: 'name'
|
|
1810
|
+
property :optimization_objective, as: 'optimizationObjective'
|
|
1811
|
+
property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
|
|
1812
|
+
|
|
1813
|
+
property :periodic_tuning_state, as: 'periodicTuningState'
|
|
1814
|
+
property :serving_state, as: 'servingState'
|
|
1815
|
+
property :training_state, as: 'trainingState'
|
|
1816
|
+
property :tuning_operation, as: 'tuningOperation'
|
|
1817
|
+
property :type, as: 'type'
|
|
1818
|
+
property :update_time, as: 'updateTime'
|
|
1819
|
+
end
|
|
1820
|
+
end
|
|
1821
|
+
|
|
1822
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfig
|
|
1823
|
+
# @private
|
|
1824
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1825
|
+
property :page_optimization_event_type, as: 'pageOptimizationEventType'
|
|
1826
|
+
collection :panels, as: 'panels', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel::Representation
|
|
1827
|
+
|
|
1828
|
+
property :restriction, as: 'restriction'
|
|
1829
|
+
end
|
|
1830
|
+
end
|
|
1831
|
+
|
|
1832
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
|
|
1833
|
+
# @private
|
|
1834
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1835
|
+
property :serving_config_id, as: 'servingConfigId'
|
|
1836
|
+
end
|
|
1837
|
+
end
|
|
1838
|
+
|
|
1839
|
+
class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
|
|
1840
|
+
# @private
|
|
1841
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1842
|
+
collection :candidates, as: 'candidates', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
|
|
1843
|
+
|
|
1844
|
+
property :default_candidate, as: 'defaultCandidate', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
|
|
1845
|
+
|
|
1846
|
+
property :display_name, as: 'displayName'
|
|
1847
|
+
end
|
|
1848
|
+
end
|
|
1849
|
+
|
|
1850
|
+
class GoogleCloudRetailV2alphaPauseModelRequest
|
|
1851
|
+
# @private
|
|
1852
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1853
|
+
end
|
|
1854
|
+
end
|
|
1855
|
+
|
|
1719
1856
|
class GoogleCloudRetailV2alphaPredictRequest
|
|
1720
1857
|
# @private
|
|
1721
1858
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2018,6 +2155,12 @@ module Google
|
|
|
2018
2155
|
end
|
|
2019
2156
|
end
|
|
2020
2157
|
|
|
2158
|
+
class GoogleCloudRetailV2alphaResumeModelRequest
|
|
2159
|
+
# @private
|
|
2160
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2161
|
+
end
|
|
2162
|
+
end
|
|
2163
|
+
|
|
2021
2164
|
class GoogleCloudRetailV2alphaRule
|
|
2022
2165
|
# @private
|
|
2023
2166
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2327,6 +2470,25 @@ module Google
|
|
|
2327
2470
|
end
|
|
2328
2471
|
end
|
|
2329
2472
|
|
|
2473
|
+
class GoogleCloudRetailV2alphaTuneModelMetadata
|
|
2474
|
+
# @private
|
|
2475
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2476
|
+
property :model, as: 'model'
|
|
2477
|
+
end
|
|
2478
|
+
end
|
|
2479
|
+
|
|
2480
|
+
class GoogleCloudRetailV2alphaTuneModelRequest
|
|
2481
|
+
# @private
|
|
2482
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2483
|
+
end
|
|
2484
|
+
end
|
|
2485
|
+
|
|
2486
|
+
class GoogleCloudRetailV2alphaTuneModelResponse
|
|
2487
|
+
# @private
|
|
2488
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2489
|
+
end
|
|
2490
|
+
end
|
|
2491
|
+
|
|
2330
2492
|
class GoogleCloudRetailV2alphaUserEvent
|
|
2331
2493
|
# @private
|
|
2332
2494
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1347,6 +1347,257 @@ module Google
|
|
|
1347
1347
|
execute_or_queue_command(command, &block)
|
|
1348
1348
|
end
|
|
1349
1349
|
|
|
1350
|
+
# Creates a new model.
|
|
1351
|
+
# @param [String] parent
|
|
1352
|
+
# Required. The parent resource under which to create the model. Format:
|
|
1353
|
+
# projects/`project_number`/locations/`location_id`/catalogs/`catalog_id`
|
|
1354
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
|
|
1355
|
+
# @param [Boolean] dry_run
|
|
1356
|
+
# Optional. Whether to run a dry_run to validate the request (without actually
|
|
1357
|
+
# creating the model).
|
|
1358
|
+
# @param [String] fields
|
|
1359
|
+
# Selector specifying which fields to include in a partial response.
|
|
1360
|
+
# @param [String] quota_user
|
|
1361
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1362
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1363
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1364
|
+
# Request-specific options
|
|
1365
|
+
#
|
|
1366
|
+
# @yield [result, err] Result & error if block supplied
|
|
1367
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
|
1368
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1369
|
+
#
|
|
1370
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
|
1371
|
+
#
|
|
1372
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1373
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1374
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1375
|
+
def create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1376
|
+
command = make_simple_command(:post, 'v2alpha/{+parent}/models', options)
|
|
1377
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1378
|
+
command.request_object = google_cloud_retail_v2alpha_model_object
|
|
1379
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
|
1380
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
|
1381
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1382
|
+
command.query['dryRun'] = dry_run unless dry_run.nil?
|
|
1383
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1384
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1385
|
+
execute_or_queue_command(command, &block)
|
|
1386
|
+
end
|
|
1387
|
+
|
|
1388
|
+
# Deletes an existing model.
|
|
1389
|
+
# @param [String] name
|
|
1390
|
+
# Required. The resource name of the [Model] to delete. Format: projects/`
|
|
1391
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1392
|
+
# @param [String] fields
|
|
1393
|
+
# Selector specifying which fields to include in a partial response.
|
|
1394
|
+
# @param [String] quota_user
|
|
1395
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1396
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1397
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1398
|
+
# Request-specific options
|
|
1399
|
+
#
|
|
1400
|
+
# @yield [result, err] Result & error if block supplied
|
|
1401
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
|
|
1402
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1403
|
+
#
|
|
1404
|
+
# @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
|
|
1405
|
+
#
|
|
1406
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1407
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1408
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1409
|
+
def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1410
|
+
command = make_simple_command(:delete, 'v2alpha/{+name}', options)
|
|
1411
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
|
|
1412
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
|
|
1413
|
+
command.params['name'] = name unless name.nil?
|
|
1414
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1415
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1416
|
+
execute_or_queue_command(command, &block)
|
|
1417
|
+
end
|
|
1418
|
+
|
|
1419
|
+
# Lists all the models linked to this event store.
|
|
1420
|
+
# @param [String] parent
|
|
1421
|
+
# Required. The parent for which to list models. Format: projects/`
|
|
1422
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`
|
|
1423
|
+
# @param [Fixnum] page_size
|
|
1424
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
|
1425
|
+
# Max allowed value is 1000.
|
|
1426
|
+
# @param [String] page_token
|
|
1427
|
+
# Optional. A page token, received from a previous `ListModels` call. Provide
|
|
1428
|
+
# this to retrieve the subsequent page.
|
|
1429
|
+
# @param [String] fields
|
|
1430
|
+
# Selector specifying which fields to include in a partial response.
|
|
1431
|
+
# @param [String] quota_user
|
|
1432
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1433
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1434
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1435
|
+
# Request-specific options
|
|
1436
|
+
#
|
|
1437
|
+
# @yield [result, err] Result & error if block supplied
|
|
1438
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse] parsed result object
|
|
1439
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1440
|
+
#
|
|
1441
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse]
|
|
1442
|
+
#
|
|
1443
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1444
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1445
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1446
|
+
def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1447
|
+
command = make_simple_command(:get, 'v2alpha/{+parent}/models', options)
|
|
1448
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse::Representation
|
|
1449
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse
|
|
1450
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1451
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1452
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1453
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1454
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1455
|
+
execute_or_queue_command(command, &block)
|
|
1456
|
+
end
|
|
1457
|
+
|
|
1458
|
+
# Update of model metadata. Only fields that currently can be updated are:
|
|
1459
|
+
# filtering_option, periodic_tuning_state. If other values are provided, this
|
|
1460
|
+
# API method will ignore them.
|
|
1461
|
+
# @param [String] name
|
|
1462
|
+
# Required. The fully qualified resource name of the model. Format: projects/`
|
|
1463
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1464
|
+
# catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
|
|
1465
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
|
|
1466
|
+
# @param [String] update_mask
|
|
1467
|
+
# Optional. Indicates which fields in the provided 'model' to update. If not set,
|
|
1468
|
+
# will by default update all fields.
|
|
1469
|
+
# @param [String] fields
|
|
1470
|
+
# Selector specifying which fields to include in a partial response.
|
|
1471
|
+
# @param [String] quota_user
|
|
1472
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1473
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1474
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1475
|
+
# Request-specific options
|
|
1476
|
+
#
|
|
1477
|
+
# @yield [result, err] Result & error if block supplied
|
|
1478
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
|
|
1479
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1480
|
+
#
|
|
1481
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
|
|
1482
|
+
#
|
|
1483
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1484
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1485
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1486
|
+
def patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1487
|
+
command = make_simple_command(:patch, 'v2alpha/{+name}', options)
|
|
1488
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1489
|
+
command.request_object = google_cloud_retail_v2alpha_model_object
|
|
1490
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1491
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
|
|
1492
|
+
command.params['name'] = name unless name.nil?
|
|
1493
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1494
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1495
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1496
|
+
execute_or_queue_command(command, &block)
|
|
1497
|
+
end
|
|
1498
|
+
|
|
1499
|
+
# Pauses the training of an existing model.
|
|
1500
|
+
# @param [String] name
|
|
1501
|
+
# Required. The name of the model to pause. Format: projects/`project_number`/
|
|
1502
|
+
# locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1503
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest] google_cloud_retail_v2alpha_pause_model_request_object
|
|
1504
|
+
# @param [String] fields
|
|
1505
|
+
# Selector specifying which fields to include in a partial response.
|
|
1506
|
+
# @param [String] quota_user
|
|
1507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1509
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1510
|
+
# Request-specific options
|
|
1511
|
+
#
|
|
1512
|
+
# @yield [result, err] Result & error if block supplied
|
|
1513
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
|
|
1514
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1515
|
+
#
|
|
1516
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
|
|
1517
|
+
#
|
|
1518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1521
|
+
def pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1522
|
+
command = make_simple_command(:post, 'v2alpha/{+name}:pause', options)
|
|
1523
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest::Representation
|
|
1524
|
+
command.request_object = google_cloud_retail_v2alpha_pause_model_request_object
|
|
1525
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1526
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
|
|
1527
|
+
command.params['name'] = name unless name.nil?
|
|
1528
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1529
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1530
|
+
execute_or_queue_command(command, &block)
|
|
1531
|
+
end
|
|
1532
|
+
|
|
1533
|
+
# Resumes the training of an existing model.
|
|
1534
|
+
# @param [String] name
|
|
1535
|
+
# Required. The name of the model to resume. Format: projects/`project_number`/
|
|
1536
|
+
# locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1537
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest] google_cloud_retail_v2alpha_resume_model_request_object
|
|
1538
|
+
# @param [String] fields
|
|
1539
|
+
# Selector specifying which fields to include in a partial response.
|
|
1540
|
+
# @param [String] quota_user
|
|
1541
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1542
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1543
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1544
|
+
# Request-specific options
|
|
1545
|
+
#
|
|
1546
|
+
# @yield [result, err] Result & error if block supplied
|
|
1547
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
|
|
1548
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1549
|
+
#
|
|
1550
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
|
|
1551
|
+
#
|
|
1552
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1553
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1554
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1555
|
+
def resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1556
|
+
command = make_simple_command(:post, 'v2alpha/{+name}:resume', options)
|
|
1557
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest::Representation
|
|
1558
|
+
command.request_object = google_cloud_retail_v2alpha_resume_model_request_object
|
|
1559
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
|
|
1560
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
|
|
1561
|
+
command.params['name'] = name unless name.nil?
|
|
1562
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1563
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1564
|
+
execute_or_queue_command(command, &block)
|
|
1565
|
+
end
|
|
1566
|
+
|
|
1567
|
+
# Tunes an existing model.
|
|
1568
|
+
# @param [String] name
|
|
1569
|
+
# Required. The resource name of the model to tune. Format: projects/`
|
|
1570
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
|
|
1571
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest] google_cloud_retail_v2alpha_tune_model_request_object
|
|
1572
|
+
# @param [String] fields
|
|
1573
|
+
# Selector specifying which fields to include in a partial response.
|
|
1574
|
+
# @param [String] quota_user
|
|
1575
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1576
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1577
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1578
|
+
# Request-specific options
|
|
1579
|
+
#
|
|
1580
|
+
# @yield [result, err] Result & error if block supplied
|
|
1581
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
|
1582
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1583
|
+
#
|
|
1584
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
|
1585
|
+
#
|
|
1586
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1587
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1588
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1589
|
+
def tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1590
|
+
command = make_simple_command(:post, 'v2alpha/{+name}:tune', options)
|
|
1591
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest::Representation
|
|
1592
|
+
command.request_object = google_cloud_retail_v2alpha_tune_model_request_object
|
|
1593
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
|
1594
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
|
1595
|
+
command.params['name'] = name unless name.nil?
|
|
1596
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1597
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1598
|
+
execute_or_queue_command(command, &block)
|
|
1599
|
+
end
|
|
1600
|
+
|
|
1350
1601
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
1351
1602
|
# to poll the operation result at intervals as recommended by the API service.
|
|
1352
1603
|
# @param [String] name
|
|
@@ -1426,9 +1677,9 @@ module Google
|
|
|
1426
1677
|
|
|
1427
1678
|
# Makes a recommendation prediction.
|
|
1428
1679
|
# @param [String] placement
|
|
1429
|
-
# Required. Full resource name of the format:
|
|
1430
|
-
# global/catalogs/default_catalog/servingConfigs
|
|
1431
|
-
# locations/global/catalogs/default_catalog/placements
|
|
1680
|
+
# Required. Full resource name of the format: ``placement=projects/*/locations/
|
|
1681
|
+
# global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
|
|
1682
|
+
# locations/global/catalogs/default_catalog/placements/*``. We recommend using
|
|
1432
1683
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
1433
1684
|
# the Recommendations AI serving config or placement. Before you can request
|
|
1434
1685
|
# predictions from your model, you must create at least one serving config or
|
|
@@ -1732,9 +1983,9 @@ module Google
|
|
|
1732
1983
|
|
|
1733
1984
|
# Makes a recommendation prediction.
|
|
1734
1985
|
# @param [String] placement
|
|
1735
|
-
# Required. Full resource name of the format:
|
|
1736
|
-
# global/catalogs/default_catalog/servingConfigs
|
|
1737
|
-
# locations/global/catalogs/default_catalog/placements
|
|
1986
|
+
# Required. Full resource name of the format: ``placement=projects/*/locations/
|
|
1987
|
+
# global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
|
|
1988
|
+
# locations/global/catalogs/default_catalog/placements/*``. We recommend using
|
|
1738
1989
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
1739
1990
|
# the Recommendations AI serving config or placement. Before you can request
|
|
1740
1991
|
# predictions from your model, you must create at least one serving config or
|
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.49.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-07-
|
|
11
|
+
date: 2022-07-25 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.49.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: []
|