google-apis-retail_v2beta 0.52.0 → 0.53.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 62c5559b761e0f6763e50d8ba4e26f997c73bba6c905b1371c9486293fb761e1
4
- data.tar.gz: 6b3220a80a77f005943c38ada331dbe2886fc61321249fd4ee5041e818feed37
3
+ metadata.gz: 7509b6e3e4fd81071312d1a7d77195b46df2b0457f433ce4bfd30f7dbedb2b85
4
+ data.tar.gz: 8c1977fb5bc94abf9ebc5ba98edc1ffebf7c8cbc76dc9d601fa6f19fd3a1cfe0
5
5
  SHA512:
6
- metadata.gz: bd7aaa8fbeb426371b33a217805bfe63206324db935103e48178c548eafda3820214b54d583c1874cec372ff28bc003668d31fe20f1580e2d1d52e4599ef77f0
7
- data.tar.gz: e8022ddce410eed1c5bd21f39efd376caf57a89e774c24d4ecc6ae4cedb25ebb1f4482db35b32aff68de9a90cda410c11c166074efcc7ed52fd630e864371cf6
6
+ metadata.gz: aad9bdcc714a2e57aa498edc484493885efefcf764fdb44772730408f7e9ab36bbc96dfe3c350e258432cafc48534b2b556a0bda7968697f541c508967d25a80
7
+ data.tar.gz: 41a21958305cc9cdaed0a8b7252b3bbc864fa19c1fd0e445f25b53b955f7a3d919878e307a5eed88a273971a5fc772144fca967eca7682761a9e48f22c5e41d3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.53.0 (2022-08-24)
4
+
5
+ * Regenerated from discovery document revision 20220822
6
+
3
7
  ### v0.52.0 (2022-08-21)
4
8
 
5
9
  * Unspecified changes
@@ -531,7 +531,7 @@ module Google
531
531
  end
532
532
  end
533
533
 
534
- # Metadata for RejoinUserEvents method.
534
+ # Metadata for `RejoinUserEvents` method.
535
535
  class GoogleCloudRetailV2RejoinUserEventsMetadata
536
536
  include Google::Apis::Core::Hashable
537
537
 
@@ -544,7 +544,7 @@ module Google
544
544
  end
545
545
  end
546
546
 
547
- # Response message for RejoinUserEvents method.
547
+ # Response message for `RejoinUserEvents` method.
548
548
  class GoogleCloudRetailV2RejoinUserEventsResponse
549
549
  include Google::Apis::Core::Hashable
550
550
 
@@ -768,8 +768,9 @@ module Google
768
768
  class GoogleCloudRetailV2alphaCreateModelMetadata
769
769
  include Google::Apis::Core::Hashable
770
770
 
771
- # The resource name of the model that this create applies to. Format: projects/`
771
+ # The resource name of the model that this create applies to. Format: `projects/`
772
772
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
773
+ # `
773
774
  # Corresponds to the JSON property `model`
774
775
  # @return [String]
775
776
  attr_accessor :model
@@ -805,8 +806,8 @@ module Google
805
806
  end
806
807
  end
807
808
 
808
- # Metadata related to the progress of the Export operation. This will be
809
- # returned by the google.longrunning.Operation.metadata field.
809
+ # Metadata related to the progress of the Export operation. This is returned by
810
+ # the google.longrunning.Operation.metadata field.
810
811
  class GoogleCloudRetailV2alphaExportMetadata
811
812
  include Google::Apis::Core::Hashable
812
813
 
@@ -1438,7 +1439,7 @@ module Google
1438
1439
  end
1439
1440
  end
1440
1441
 
1441
- # Metadata for RejoinUserEvents method.
1442
+ # Metadata for `RejoinUserEvents` method.
1442
1443
  class GoogleCloudRetailV2alphaRejoinUserEventsMetadata
1443
1444
  include Google::Apis::Core::Hashable
1444
1445
 
@@ -1451,7 +1452,7 @@ module Google
1451
1452
  end
1452
1453
  end
1453
1454
 
1454
- # Response message for RejoinUserEvents method.
1455
+ # Response message for `RejoinUserEvents` method.
1455
1456
  class GoogleCloudRetailV2alphaRejoinUserEventsResponse
1456
1457
  include Google::Apis::Core::Hashable
1457
1458
 
@@ -1589,8 +1590,9 @@ module Google
1589
1590
  class GoogleCloudRetailV2alphaTuneModelMetadata
1590
1591
  include Google::Apis::Core::Hashable
1591
1592
 
1592
- # The resource name of the model that this tune applies to. Format: projects/`
1593
+ # The resource name of the model that this tune applies to. Format: `projects/`
1593
1594
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1595
+ # `
1594
1596
  # Corresponds to the JSON property `model`
1595
1597
  # @return [String]
1596
1598
  attr_accessor :model
@@ -2528,8 +2530,8 @@ module Google
2528
2530
 
2529
2531
  # The value of the term to match on. Value cannot be empty. Value can have at
2530
2532
  # most 3 terms if specified as a partial match. Each space separated string is
2531
- # considered as one term. Example) "a b c" is 3 terms and allowed, " a b c d" is
2532
- # 4 terms and not allowed for partial match.
2533
+ # considered as one term. For example, "a b c" is 3 terms and allowed, but " a b
2534
+ # c d" is 4 terms and not allowed for a partial match.
2533
2535
  # Corresponds to the JSON property `value`
2534
2536
  # @return [String]
2535
2537
  attr_accessor :value
@@ -2571,14 +2573,14 @@ module Google
2571
2573
  end
2572
2574
  end
2573
2575
 
2574
- # Configures dynamic serving time metadata that is used to pre and post process
2575
- # search/recommendation model results.
2576
+ # Configures dynamic metadata that can be linked to a ServingConfig and affect
2577
+ # search or recommendation results at serving time.
2576
2578
  class GoogleCloudRetailV2betaControl
2577
2579
  include Google::Apis::Core::Hashable
2578
2580
 
2579
- # Output only. List of serving configuration ids that that are associated with
2580
- # this control. Note the association is managed via the ServingConfig, this is
2581
- # an output only denormalizeed view. Assumed to be in the same catalog.
2581
+ # Output only. List of serving configuration ids that are associated with this
2582
+ # control in the same Catalog. Note the association is managed via the
2583
+ # ServingConfig, this is an output only denormalized view.
2582
2584
  # Corresponds to the JSON property `associatedServingConfigIds`
2583
2585
  # @return [Array<String>]
2584
2586
  attr_accessor :associated_serving_config_ids
@@ -2602,13 +2604,21 @@ module Google
2602
2604
  attr_accessor :name
2603
2605
 
2604
2606
  # A rule is a condition-action pair * A condition defines when a rule is to be
2605
- # triggered. * An action specifies what occurs on that trigger. Currently only
2606
- # boost rules are supported. Currently only supported by the search endpoint.
2607
+ # triggered. * An action specifies what occurs on that trigger. Currently rules
2608
+ # only work for controls with SOLUTION_TYPE_SEARCH.
2607
2609
  # Corresponds to the JSON property `rule`
2608
2610
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule]
2609
2611
  attr_accessor :rule
2610
2612
 
2611
- # Required. Immutable. The solution types that the serving config is used for.
2613
+ # Specifies the use case for the control. Affects what condition fields can be
2614
+ # set. Only settable by search controls. Will default to
2615
+ # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
2616
+ # search_solution_use_case per control.
2617
+ # Corresponds to the JSON property `searchSolutionUseCase`
2618
+ # @return [Array<String>]
2619
+ attr_accessor :search_solution_use_case
2620
+
2621
+ # Required. Immutable. The solution types that the control is used for.
2612
2622
  # Currently we support setting only one type of solution at creation time. Only `
2613
2623
  # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
2614
2624
  # provided at creation time, will default to SOLUTION_TYPE_SEARCH.
@@ -2627,6 +2637,7 @@ module Google
2627
2637
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
2628
2638
  @name = args[:name] if args.key?(:name)
2629
2639
  @rule = args[:rule] if args.key?(:rule)
2640
+ @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
2630
2641
  @solution_types = args[:solution_types] if args.key?(:solution_types)
2631
2642
  end
2632
2643
  end
@@ -2709,8 +2720,8 @@ module Google
2709
2720
  end
2710
2721
  end
2711
2722
 
2712
- # Metadata related to the progress of the Export operation. This will be
2713
- # returned by the google.longrunning.Operation.metadata field.
2723
+ # Metadata related to the progress of the Export operation. This is returned by
2724
+ # the google.longrunning.Operation.metadata field.
2714
2725
  class GoogleCloudRetailV2betaExportMetadata
2715
2726
  include Google::Apis::Core::Hashable
2716
2727
 
@@ -3305,6 +3316,31 @@ module Google
3305
3316
  end
3306
3317
  end
3307
3318
 
3319
+ # Response to a ListModelRequest.
3320
+ class GoogleCloudRetailV2betaListModelsResponse
3321
+ include Google::Apis::Core::Hashable
3322
+
3323
+ # List of Models.
3324
+ # Corresponds to the JSON property `models`
3325
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel>]
3326
+ attr_accessor :models
3327
+
3328
+ # Pagination token, if not returned indicates the last page.
3329
+ # Corresponds to the JSON property `nextPageToken`
3330
+ # @return [String]
3331
+ attr_accessor :next_page_token
3332
+
3333
+ def initialize(**args)
3334
+ update!(**args)
3335
+ end
3336
+
3337
+ # Update properties of this object
3338
+ def update!(**args)
3339
+ @models = args[:models] if args.key?(:models)
3340
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3341
+ end
3342
+ end
3343
+
3308
3344
  # Response message for ProductService.ListProducts method.
3309
3345
  class GoogleCloudRetailV2betaListProductsResponse
3310
3346
  include Google::Apis::Core::Hashable
@@ -3491,6 +3527,154 @@ module Google
3491
3527
  end
3492
3528
  end
3493
3529
 
3530
+ # Metadata that describes the training and serving parameters of a Model. A
3531
+ # Model can be associated with a ServingConfig and then queried through the
3532
+ # Predict API.
3533
+ class GoogleCloudRetailV2betaModel
3534
+ include Google::Apis::Core::Hashable
3535
+
3536
+ # Output only. Timestamp the Recommendation Model was created at.
3537
+ # Corresponds to the JSON property `createTime`
3538
+ # @return [String]
3539
+ attr_accessor :create_time
3540
+
3541
+ # Output only. The state of data requirements for this model: `DATA_OK` and `
3542
+ # DATA_ERROR`. Recommendation model cannot be trained if the data is in `
3543
+ # DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
3544
+ # serving state is `ACTIVE`: models were trained successfully before, but cannot
3545
+ # be refreshed because model no longer has sufficient data for training.
3546
+ # Corresponds to the JSON property `dataState`
3547
+ # @return [String]
3548
+ attr_accessor :data_state
3549
+
3550
+ # Required. The display name of the model. Should be human readable, used to
3551
+ # display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
3552
+ # encoded string with limit of 1024 characters.
3553
+ # Corresponds to the JSON property `displayName`
3554
+ # @return [String]
3555
+ attr_accessor :display_name
3556
+
3557
+ # Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
3558
+ # attributes is enabled for the model.
3559
+ # Corresponds to the JSON property `filteringOption`
3560
+ # @return [String]
3561
+ attr_accessor :filtering_option
3562
+
3563
+ # Output only. The timestamp when the latest successful tune finished.
3564
+ # Corresponds to the JSON property `lastTuneTime`
3565
+ # @return [String]
3566
+ attr_accessor :last_tune_time
3567
+
3568
+ # Required. The fully qualified resource name of the model. Format: `projects/`
3569
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
3570
+ # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
3571
+ # 40.
3572
+ # Corresponds to the JSON property `name`
3573
+ # @return [String]
3574
+ attr_accessor :name
3575
+
3576
+ # Optional. The optimization objective e.g. `cvr`. Currently supported values: `
3577
+ # ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
3578
+ # model type. Default depends on type of recommendation: `recommended-for-you` =>
3579
+ # `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
3580
+ # revenue_per_order`
3581
+ # Corresponds to the JSON property `optimizationObjective`
3582
+ # @return [String]
3583
+ attr_accessor :optimization_objective
3584
+
3585
+ # Optional. The state of periodic tuning. The period we use is 3 months - to do
3586
+ # a one-off tune earlier use the `TuneModel` method. Default value is `
3587
+ # PERIODIC_TUNING_ENABLED`.
3588
+ # Corresponds to the JSON property `periodicTuningState`
3589
+ # @return [String]
3590
+ attr_accessor :periodic_tuning_state
3591
+
3592
+ # Output only. The list of valid serving configs associated with the
3593
+ # PageOptimizationConfig.
3594
+ # Corresponds to the JSON property `servingConfigLists`
3595
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelServingConfigList>]
3596
+ attr_accessor :serving_config_lists
3597
+
3598
+ # Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
3599
+ # Corresponds to the JSON property `servingState`
3600
+ # @return [String]
3601
+ attr_accessor :serving_state
3602
+
3603
+ # Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
3604
+ # . Since part of the cost of running the service is frequency of training -
3605
+ # this can be used to determine when to train model in order to control cost. If
3606
+ # not specified: the default value for `CreateModel` method is `TRAINING`. The
3607
+ # default value for `UpdateModel` method is to keep the state the same as before.
3608
+ # Corresponds to the JSON property `trainingState`
3609
+ # @return [String]
3610
+ attr_accessor :training_state
3611
+
3612
+ # Output only. The tune operation associated with the model. Can be used to
3613
+ # determine if there is an ongoing tune for this recommendation. Empty field
3614
+ # implies no tune is goig on.
3615
+ # Corresponds to the JSON property `tuningOperation`
3616
+ # @return [String]
3617
+ attr_accessor :tuning_operation
3618
+
3619
+ # Required. The type of model e.g. `home-page`. Currently supported values: `
3620
+ # recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
3621
+ # page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(
3622
+ # readonly value).
3623
+ # Corresponds to the JSON property `type`
3624
+ # @return [String]
3625
+ attr_accessor :type
3626
+
3627
+ # Output only. Timestamp the Recommendation Model was last updated. E.g. if a
3628
+ # Recommendation Model was paused - this would be the time the pause was
3629
+ # initiated.
3630
+ # Corresponds to the JSON property `updateTime`
3631
+ # @return [String]
3632
+ attr_accessor :update_time
3633
+
3634
+ def initialize(**args)
3635
+ update!(**args)
3636
+ end
3637
+
3638
+ # Update properties of this object
3639
+ def update!(**args)
3640
+ @create_time = args[:create_time] if args.key?(:create_time)
3641
+ @data_state = args[:data_state] if args.key?(:data_state)
3642
+ @display_name = args[:display_name] if args.key?(:display_name)
3643
+ @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
3644
+ @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
3645
+ @name = args[:name] if args.key?(:name)
3646
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
3647
+ @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
3648
+ @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
3649
+ @serving_state = args[:serving_state] if args.key?(:serving_state)
3650
+ @training_state = args[:training_state] if args.key?(:training_state)
3651
+ @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
3652
+ @type = args[:type] if args.key?(:type)
3653
+ @update_time = args[:update_time] if args.key?(:update_time)
3654
+ end
3655
+ end
3656
+
3657
+ # Represents an ordered combination of valid serving configs, which can be used
3658
+ # for `PAGE_OPTIMIZATION` recommendations.
3659
+ class GoogleCloudRetailV2betaModelServingConfigList
3660
+ include Google::Apis::Core::Hashable
3661
+
3662
+ # Optional. A set of valid serving configs that may be used for `
3663
+ # PAGE_OPTIMIZATION`.
3664
+ # Corresponds to the JSON property `servingConfigIds`
3665
+ # @return [Array<String>]
3666
+ attr_accessor :serving_config_ids
3667
+
3668
+ def initialize(**args)
3669
+ update!(**args)
3670
+ end
3671
+
3672
+ # Update properties of this object
3673
+ def update!(**args)
3674
+ @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
3675
+ end
3676
+ end
3677
+
3494
3678
  # Output result.
3495
3679
  class GoogleCloudRetailV2betaOutputResult
3496
3680
  include Google::Apis::Core::Hashable
@@ -3510,6 +3694,19 @@ module Google
3510
3694
  end
3511
3695
  end
3512
3696
 
3697
+ # Request for pausing training of a model.
3698
+ class GoogleCloudRetailV2betaPauseModelRequest
3699
+ include Google::Apis::Core::Hashable
3700
+
3701
+ def initialize(**args)
3702
+ update!(**args)
3703
+ end
3704
+
3705
+ # Update properties of this object
3706
+ def update!(**args)
3707
+ end
3708
+ end
3709
+
3513
3710
  # Request message for Predict method.
3514
3711
  class GoogleCloudRetailV2betaPredictRequest
3515
3712
  include Google::Apis::Core::Hashable
@@ -3851,11 +4048,11 @@ module Google
3851
4048
  # belonging to several parallel categories. Strongly recommended using the full
3852
4049
  # path for better search / recommendation quality. To represent full path of
3853
4050
  # category, use '>' sign to separate different hierarchies. If '>' is part of
3854
- # the category name, please replace it with other character(s). For example, if
3855
- # a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["
3856
- # Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented
3857
- # as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness >
3858
- # Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
4051
+ # the category name, replace it with other character(s). For example, if a shoes
4052
+ # product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports &
4053
+ # Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "
4054
+ # categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic
4055
+ # Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
3859
4056
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
3860
4057
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
3861
4058
  # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
@@ -3963,6 +4160,13 @@ module Google
3963
4160
  # @return [String]
3964
4161
  attr_accessor :language_code
3965
4162
 
4163
+ # Output only. A list of local inventories specific to different places. This is
4164
+ # only available for users who have Retail Search enabled, and it can be managed
4165
+ # by AddLocalInventories and RemoveLocalInventories APIs.
4166
+ # Corresponds to the JSON property `localInventories`
4167
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaLocalInventory>]
4168
+ attr_accessor :local_inventories
4169
+
3966
4170
  # The material of the product. For example, "leather", "wooden". A maximum of 20
3967
4171
  # values are allowed. Each value must be a UTF-8 encoded string with a length
3968
4172
  # limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -4141,6 +4345,7 @@ module Google
4141
4345
  @id = args[:id] if args.key?(:id)
4142
4346
  @images = args[:images] if args.key?(:images)
4143
4347
  @language_code = args[:language_code] if args.key?(:language_code)
4348
+ @local_inventories = args[:local_inventories] if args.key?(:local_inventories)
4144
4349
  @materials = args[:materials] if args.key?(:materials)
4145
4350
  @name = args[:name] if args.key?(:name)
4146
4351
  @patterns = args[:patterns] if args.key?(:patterns)
@@ -4467,7 +4672,7 @@ module Google
4467
4672
  end
4468
4673
  end
4469
4674
 
4470
- # Metadata for RejoinUserEvents method.
4675
+ # Metadata for `RejoinUserEvents` method.
4471
4676
  class GoogleCloudRetailV2betaRejoinUserEventsMetadata
4472
4677
  include Google::Apis::Core::Hashable
4473
4678
 
@@ -4485,8 +4690,8 @@ module Google
4485
4690
  include Google::Apis::Core::Hashable
4486
4691
 
4487
4692
  # The type of the user event rejoin to define the scope and range of the user
4488
- # events to be rejoined with the latest product catalog. Defaults to
4489
- # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
4693
+ # events to be rejoined with the latest product catalog. Defaults to `
4694
+ # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to an
4490
4695
  # invalid integer value.
4491
4696
  # Corresponds to the JSON property `userEventRejoinScope`
4492
4697
  # @return [String]
@@ -4502,7 +4707,7 @@ module Google
4502
4707
  end
4503
4708
  end
4504
4709
 
4505
- # Response message for RejoinUserEvents method.
4710
+ # Response message for `RejoinUserEvents` method.
4506
4711
  class GoogleCloudRetailV2betaRejoinUserEventsResponse
4507
4712
  include Google::Apis::Core::Hashable
4508
4713
 
@@ -4740,9 +4945,22 @@ module Google
4740
4945
  end
4741
4946
  end
4742
4947
 
4948
+ # Request for resuming training of a model.
4949
+ class GoogleCloudRetailV2betaResumeModelRequest
4950
+ include Google::Apis::Core::Hashable
4951
+
4952
+ def initialize(**args)
4953
+ update!(**args)
4954
+ end
4955
+
4956
+ # Update properties of this object
4957
+ def update!(**args)
4958
+ end
4959
+ end
4960
+
4743
4961
  # A rule is a condition-action pair * A condition defines when a rule is to be
4744
- # triggered. * An action specifies what occurs on that trigger. Currently only
4745
- # boost rules are supported. Currently only supported by the search endpoint.
4962
+ # triggered. * An action specifies what occurs on that trigger. Currently rules
4963
+ # only work for controls with SOLUTION_TYPE_SEARCH.
4746
4964
  class GoogleCloudRetailV2betaRule
4747
4965
  include Google::Apis::Core::Hashable
4748
4966
 
@@ -5151,9 +5369,9 @@ module Google
5151
5369
  # navigation queries to achieve good search quality. The format should be the
5152
5370
  # same as UserEvent.page_categories; To represent full path of category, use '>'
5153
5371
  # sign to separate different hierarchies. If '>' is part of the category name,
5154
- # please replace it with other character(s). Category pages include special
5155
- # pages such as sales or promotions. For instance, a special sale page may have
5156
- # the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
5372
+ # replace it with other character(s). Category pages include special pages such
5373
+ # as sales or promotions. For instance, a special sale page may have the
5374
+ # category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
5157
5375
  # Corresponds to the JSON property `pageCategories`
5158
5376
  # @return [Array<String>]
5159
5377
  attr_accessor :page_categories
@@ -5879,9 +6097,7 @@ module Google
5879
6097
  end
5880
6098
 
5881
6099
  # Configures metadata that is used to generate serving time results (e.g. search
5882
- # results or recommendation predictions). The ServingConfig is passed in the
5883
- # search and predict request and together with the Catalog.default_branch,
5884
- # generates results.
6100
+ # results or recommendation predictions).
5885
6101
  class GoogleCloudRetailV2betaServingConfig
5886
6102
  include Google::Apis::Core::Hashable
5887
6103
 
@@ -5904,16 +6120,21 @@ module Google
5904
6120
  # @return [String]
5905
6121
  attr_accessor :display_name
5906
6122
 
5907
- # How much diversity to use in recommendation model results e.g. 'medium-
5908
- # diversity' or 'high-diversity'. Currently supported values: * 'no-diversity' *
5909
- # 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' If
6123
+ # How much diversity to use in recommendation model results e.g. `medium-
6124
+ # diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
6125
+ # `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
5910
6126
  # not specified, we choose default based on recommendation model type. Default
5911
- # value: 'no-diversity'. Can only be set if solution_types is
6127
+ # value: `no-diversity`. Can only be set if solution_types is
5912
6128
  # SOLUTION_TYPE_RECOMMENDATION.
5913
6129
  # Corresponds to the JSON property `diversityLevel`
5914
6130
  # @return [String]
5915
6131
  attr_accessor :diversity_level
5916
6132
 
6133
+ # What kind of diversity to use - data driven or rule based.
6134
+ # Corresponds to the JSON property `diversityType`
6135
+ # @return [String]
6136
+ attr_accessor :diversity_type
6137
+
5917
6138
  # Condition do not associate specifications. If multiple do not associate
5918
6139
  # conditions match, all matching do not associate controls in the list will
5919
6140
  # execute. - Order does not matter. - Maximum number of specifications is 100.
@@ -5927,10 +6148,10 @@ module Google
5927
6148
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec]
5928
6149
  attr_accessor :dynamic_facet_spec
5929
6150
 
5930
- # Whether to add additional category filters on the 'similar-items' model. If
5931
- # not specified, we enable it by default. Allowed values are: * 'no-category-
5932
- # match': No additional filtering of original results from the model and the
5933
- # customer's filters. * 'relaxed-category-match': Only keep results with
6151
+ # Whether to add additional category filters on the `similar-items` model. If
6152
+ # not specified, we enable it by default. Allowed values are: * `no-category-
6153
+ # match`: No additional filtering of original results from the model and the
6154
+ # customer's filters. * `relaxed-category-match`: Only keep results with
5934
6155
  # categories that match at least one item categories in the PredictRequests's
5935
6156
  # context item. * If customer also sends filters in the PredictRequest, then the
5936
6157
  # results will satisfy both conditions (user given and category match). Can only
@@ -5964,7 +6185,7 @@ module Google
5964
6185
  # @return [Array<String>]
5965
6186
  attr_accessor :ignore_control_ids
5966
6187
 
5967
- # The id of the model to use at serving time. Currently only
6188
+ # The id of the model in the same Catalog to use at serving time. Currently only
5968
6189
  # RecommendationModels are supported: https://cloud.google.com/retail/
5969
6190
  # recommendations-ai/docs/create-models Can be changed but only to a compatible
5970
6191
  # model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
@@ -5988,13 +6209,18 @@ module Google
5988
6209
  # @return [Array<String>]
5989
6210
  attr_accessor :oneway_synonyms_control_ids
5990
6211
 
6212
+ # The specification for personalization.
6213
+ # Corresponds to the JSON property `personalizationSpec`
6214
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec]
6215
+ attr_accessor :personalization_spec
6216
+
5991
6217
  # How much price ranking we want in serving results. Price reranking causes
5992
6218
  # product items with a similar recommendation probability to be ordered by price,
5993
6219
  # with the highest-priced items first. This setting could result in a decrease
5994
- # in click-through and conversion rates. Allowed values are: * 'no-price-
5995
- # reranking' * 'low-price-raranking' * 'medium-price-reranking' * 'high-price-
5996
- # reranking' If not specified, we choose default based on model type. Default
5997
- # value: 'no-price-reranking'. Can only be set if solution_types is
6220
+ # in click-through and conversion rates. Allowed values are: * `no-price-
6221
+ # reranking` * `low-price-raranking` * `medium-price-reranking` * `high-price-
6222
+ # reranking` If not specified, we choose default based on model type. Default
6223
+ # value: `no-price-reranking`. Can only be set if solution_types is
5998
6224
  # SOLUTION_TYPE_RECOMMENDATION.
5999
6225
  # Corresponds to the JSON property `priceRerankingLevel`
6000
6226
  # @return [String]
@@ -6038,6 +6264,7 @@ module Google
6038
6264
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
6039
6265
  @display_name = args[:display_name] if args.key?(:display_name)
6040
6266
  @diversity_level = args[:diversity_level] if args.key?(:diversity_level)
6267
+ @diversity_type = args[:diversity_type] if args.key?(:diversity_type)
6041
6268
  @do_not_associate_control_ids = args[:do_not_associate_control_ids] if args.key?(:do_not_associate_control_ids)
6042
6269
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
6043
6270
  @enable_category_filter_level = args[:enable_category_filter_level] if args.key?(:enable_category_filter_level)
@@ -6047,6 +6274,7 @@ module Google
6047
6274
  @model_id = args[:model_id] if args.key?(:model_id)
6048
6275
  @name = args[:name] if args.key?(:name)
6049
6276
  @oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
6277
+ @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
6050
6278
  @price_reranking_level = args[:price_reranking_level] if args.key?(:price_reranking_level)
6051
6279
  @redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
6052
6280
  @replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
@@ -6169,6 +6397,20 @@ module Google
6169
6397
  end
6170
6398
  end
6171
6399
 
6400
+ # Request to manually start a tuning process now (instead of waiting for the
6401
+ # periodically scheduled tuning to happen).
6402
+ class GoogleCloudRetailV2betaTuneModelRequest
6403
+ include Google::Apis::Core::Hashable
6404
+
6405
+ def initialize(**args)
6406
+ update!(**args)
6407
+ end
6408
+
6409
+ # Update properties of this object
6410
+ def update!(**args)
6411
+ end
6412
+ end
6413
+
6172
6414
  # UserEvent captures all metadata information Retail API needs to know about how
6173
6415
  # end users interact with customers' website.
6174
6416
  class GoogleCloudRetailV2betaUserEvent
@@ -6277,12 +6519,12 @@ module Google
6277
6519
 
6278
6520
  # The categories associated with a category page. To represent full path of
6279
6521
  # category, use '>' sign to separate different hierarchies. If '>' is part of
6280
- # the category name, please replace it with other character(s). Category pages
6281
- # include special pages such as sales or promotions. For instance, a special
6282
- # sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017
6283
- # Black Friday Deals"]. Required for `category-page-view` events. At least one
6284
- # of search_query or page_categories is required for `search` events. Other
6285
- # event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
6522
+ # the category name, replace it with other character(s). Category pages include
6523
+ # special pages such as sales or promotions. For instance, a special sale page
6524
+ # may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black
6525
+ # Friday Deals"]. Required for `category-page-view` events. At least one of
6526
+ # search_query or page_categories is required for `search` events. Other event
6527
+ # types should not set this field. Otherwise, an INVALID_ARGUMENT error is
6286
6528
  # returned.
6287
6529
  # Corresponds to the JSON property `pageCategories`
6288
6530
  # @return [Array<String>]
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2beta
18
18
  # Version of the google-apis-retail_v2beta gem
19
- GEM_VERSION = "0.52.0"
19
+ GEM_VERSION = "0.53.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 = "20220811"
25
+ REVISION = "20220822"
26
26
  end
27
27
  end
28
28
  end