google-apis-retail_v2beta 0.72.0 → 0.73.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: d889ae3f00f25e33e44cc7e59169457513c984932350977d1036ea239dc0ac5b
4
- data.tar.gz: eb26e00ca9c842b641749f7201721ef9515ed28003ea953aa7836dea01504e14
3
+ metadata.gz: 9daaf416b8009bfddf1f3613489639810b6719aa0f63c628b313cdeea8b7c4f6
4
+ data.tar.gz: 3fe0d744420c0fd07f2d50fb39b1b9e79d4184791246138b443965d897f12dc3
5
5
  SHA512:
6
- metadata.gz: 6c7f2bd9028cac013424fd8ed8d28895819a810a16db1860dd09ec1a905286e01905d91d4a5ac96e73213493c6bbdf243c9c179f482959b8adeeb8cffd0909a9
7
- data.tar.gz: 5f617bf166e3e40c664f6c4deabb4a15d85c2247a92efa20d65ae394c881148e9d2e9d3abd13ed8b5beed86d972108f959ead1ee96dd686689c918a29f3f3994
6
+ metadata.gz: 8c63bb8f2969fec8b37a4c81cb45d135bdfdc9cb1fb81726fe3e13192a613fddf105e0a8cd00f5978f2baa796427a2c35c08f820d75e311c6a39cf4b296c2a5d
7
+ data.tar.gz: 5ab08a04c5515d3fa8f4c021e082669ff3f1c7bbeadaa63427d70fb7c364b81da73abf6fbe9b2ac361d6eb1f844b1139acb1685f26a88f51f1c5aef82e15b04c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.73.0 (2023-04-30)
4
+
5
+ * Regenerated from discovery document revision 20230420
6
+
3
7
  ### v0.72.0 (2023-04-23)
4
8
 
5
9
  * Regenerated from discovery document revision 20230413
@@ -555,6 +555,11 @@ module Google
555
555
  # @return [String]
556
556
  attr_accessor :last_tune_time
557
557
 
558
+ # Additional model features config.
559
+ # Corresponds to the JSON property `modelFeaturesConfig`
560
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelModelFeaturesConfig]
561
+ attr_accessor :model_features_config
562
+
558
563
  # Required. The fully qualified resource name of the model. Format: `projects/`
559
564
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
560
565
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -644,6 +649,7 @@ module Google
644
649
  @display_name = args[:display_name] if args.key?(:display_name)
645
650
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
646
651
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
652
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
647
653
  @name = args[:name] if args.key?(:name)
648
654
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
649
655
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -656,6 +662,46 @@ module Google
656
662
  end
657
663
  end
658
664
 
665
+ # More configs of the frequently-bought-together model type.
666
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
667
+ include Google::Apis::Core::Hashable
668
+
669
+ # Optional. Specifies the context of the model when used in predict requests.
670
+ # Only settable for the `frequently-bought-together` type. Will default to
671
+ # MULTI_CONTEXT if not specified.
672
+ # Corresponds to the JSON property `contextProductsType`
673
+ # @return [String]
674
+ attr_accessor :context_products_type
675
+
676
+ def initialize(**args)
677
+ update!(**args)
678
+ end
679
+
680
+ # Update properties of this object
681
+ def update!(**args)
682
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
683
+ end
684
+ end
685
+
686
+ # Additional model features config.
687
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
688
+ include Google::Apis::Core::Hashable
689
+
690
+ # More configs of the frequently-bought-together model type.
691
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
692
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig]
693
+ attr_accessor :frequently_bought_together_config
694
+
695
+ def initialize(**args)
696
+ update!(**args)
697
+ end
698
+
699
+ # Update properties of this object
700
+ def update!(**args)
701
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
702
+ end
703
+ end
704
+
659
705
  # Represents an ordered combination of valid serving configs, which can be used
660
706
  # for `PAGE_OPTIMIZATION` recommendations.
661
707
  class GoogleCloudRetailV2ModelServingConfigList
@@ -1476,6 +1522,11 @@ module Google
1476
1522
  # @return [String]
1477
1523
  attr_accessor :last_tune_time
1478
1524
 
1525
+ # Additional model features config.
1526
+ # Corresponds to the JSON property `modelFeaturesConfig`
1527
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelModelFeaturesConfig]
1528
+ attr_accessor :model_features_config
1529
+
1479
1530
  # Required. The fully qualified resource name of the model. Format: `projects/`
1480
1531
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1481
1532
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -1573,6 +1624,7 @@ module Google
1573
1624
  @display_name = args[:display_name] if args.key?(:display_name)
1574
1625
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
1575
1626
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
1627
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
1576
1628
  @name = args[:name] if args.key?(:name)
1577
1629
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
1578
1630
  @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
@@ -1586,6 +1638,46 @@ module Google
1586
1638
  end
1587
1639
  end
1588
1640
 
1641
+ # More configs of the frequently-bought-together model type.
1642
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
1643
+ include Google::Apis::Core::Hashable
1644
+
1645
+ # Optional. Specifies the context of the model when used in predict requests.
1646
+ # Only settable for the `frequently-bought-together` type. Will default to
1647
+ # MULTI_CONTEXT if not specified.
1648
+ # Corresponds to the JSON property `contextProductsType`
1649
+ # @return [String]
1650
+ attr_accessor :context_products_type
1651
+
1652
+ def initialize(**args)
1653
+ update!(**args)
1654
+ end
1655
+
1656
+ # Update properties of this object
1657
+ def update!(**args)
1658
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
1659
+ end
1660
+ end
1661
+
1662
+ # Additional model features config.
1663
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
1664
+ include Google::Apis::Core::Hashable
1665
+
1666
+ # More configs of the frequently-bought-together model type.
1667
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
1668
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig]
1669
+ attr_accessor :frequently_bought_together_config
1670
+
1671
+ def initialize(**args)
1672
+ update!(**args)
1673
+ end
1674
+
1675
+ # Update properties of this object
1676
+ def update!(**args)
1677
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
1678
+ end
1679
+ end
1680
+
1589
1681
  # The PageOptimizationConfig for model training. This determines how many panels
1590
1682
  # to optimize for, and which serving configs to consider for each panel. The
1591
1683
  # purpose of this model is to optimize which ServingConfig to show on which
@@ -2672,8 +2764,8 @@ module Google
2672
2764
  attr_accessor :completion_results
2673
2765
 
2674
2766
  # Matched recent searches of this user. The maximum number of recent searches is
2675
- # 10. This field is a restricted feature. Contact Retail Search support team if
2676
- # you are interested in enabling it. This feature is only available when
2767
+ # 10. This field is a restricted feature. If you want to enable it, contact
2768
+ # Retail Search support. This feature is only available when
2677
2769
  # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
2678
2770
  # recent searches satisfy the follow rules: * They are ordered from latest to
2679
2771
  # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
@@ -2782,8 +2874,8 @@ module Google
2782
2874
  attr_accessor :last_denylist_import_operation
2783
2875
 
2784
2876
  # Output only. Name of the LRO corresponding to the latest suggestion terms list
2785
- # import. Can use GetOperation API to retrieve the latest state of the Long
2786
- # Running Operation.
2877
+ # import. Can use GetOperation API method to retrieve the latest state of the
2878
+ # Long Running Operation.
2787
2879
  # Corresponds to the JSON property `lastSuggestionsImportOperation`
2788
2880
  # @return [String]
2789
2881
  attr_accessor :last_suggestions_import_operation
@@ -3155,7 +3247,7 @@ module Google
3155
3247
  end
3156
3248
  end
3157
3249
 
3158
- # Metadata for active A/B testing Experiments.
3250
+ # Metadata for active A/B testing Experiment.
3159
3251
  class GoogleCloudRetailV2betaExperimentInfo
3160
3252
  include Google::Apis::Core::Hashable
3161
3253
 
@@ -3636,9 +3728,11 @@ module Google
3636
3728
  # the import is finished, a notification is sent to specified Pub/Sub topic. The
3637
3729
  # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
3638
3730
  # projects/`project`/topics/`topic``. It has to be within the same project as
3639
- # ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
3640
- # gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
3641
- # topic.
3731
+ # ImportProductsRequest.parent. Make sure that both `cloud-retail-customer-data-
3732
+ # access@system.gserviceaccount.com` and `service-@gcp-sa-retail.iam.
3733
+ # gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the
3734
+ # topic. Only supported when ImportProductsRequest.reconciliation_mode is set to
3735
+ # `FULL`.
3642
3736
  # Corresponds to the JSON property `notificationPubsubTopic`
3643
3737
  # @return [String]
3644
3738
  attr_accessor :notification_pubsub_topic
@@ -4246,6 +4340,11 @@ module Google
4246
4340
  # @return [String]
4247
4341
  attr_accessor :last_tune_time
4248
4342
 
4343
+ # Additional model features config.
4344
+ # Corresponds to the JSON property `modelFeaturesConfig`
4345
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelModelFeaturesConfig]
4346
+ attr_accessor :model_features_config
4347
+
4249
4348
  # Required. The fully qualified resource name of the model. Format: `projects/`
4250
4349
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
4251
4350
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -4335,6 +4434,7 @@ module Google
4335
4434
  @display_name = args[:display_name] if args.key?(:display_name)
4336
4435
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
4337
4436
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
4437
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
4338
4438
  @name = args[:name] if args.key?(:name)
4339
4439
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
4340
4440
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -4347,6 +4447,46 @@ module Google
4347
4447
  end
4348
4448
  end
4349
4449
 
4450
+ # More configs of the frequently-bought-together model type.
4451
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
4452
+ include Google::Apis::Core::Hashable
4453
+
4454
+ # Optional. Specifies the context of the model when used in predict requests.
4455
+ # Only settable for the `frequently-bought-together` type. Will default to
4456
+ # MULTI_CONTEXT if not specified.
4457
+ # Corresponds to the JSON property `contextProductsType`
4458
+ # @return [String]
4459
+ attr_accessor :context_products_type
4460
+
4461
+ def initialize(**args)
4462
+ update!(**args)
4463
+ end
4464
+
4465
+ # Update properties of this object
4466
+ def update!(**args)
4467
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
4468
+ end
4469
+ end
4470
+
4471
+ # Additional model features config.
4472
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
4473
+ include Google::Apis::Core::Hashable
4474
+
4475
+ # More configs of the frequently-bought-together model type.
4476
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
4477
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig]
4478
+ attr_accessor :frequently_bought_together_config
4479
+
4480
+ def initialize(**args)
4481
+ update!(**args)
4482
+ end
4483
+
4484
+ # Update properties of this object
4485
+ def update!(**args)
4486
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
4487
+ end
4488
+ end
4489
+
4350
4490
  # Represents an ordered combination of valid serving configs, which can be used
4351
4491
  # for `PAGE_OPTIMIZATION` recommendations.
4352
4492
  class GoogleCloudRetailV2betaModelServingConfigList
@@ -5843,11 +5983,11 @@ module Google
5843
5983
  include Google::Apis::Core::Hashable
5844
5984
 
5845
5985
  # A filter to apply on the matching condition results. Supported features: *
5846
- # filter must be set. * Filter syntax is identical to SearchRequest.filter. See
5847
- # more details at the Retail Search [user guide](/retail/search/docs/filter-and-
5848
- # order#filter). * To filter products with product ID "product_1" or "product_2",
5849
- # and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(
5850
- # colorFamilies: ANY("Red", "Blue")) *
5986
+ # filter must be set. * Filter syntax is identical to SearchRequest.filter. For
5987
+ # more information, see [Filter](/retail/docs/filter-and-order#filter). * To
5988
+ # filter products with product ID "product_1" or "product_2", and color "Red" or
5989
+ # "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("
5990
+ # Red", "Blue")) *
5851
5991
  # Corresponds to the JSON property `filter`
5852
5992
  # @return [String]
5853
5993
  attr_accessor :filter
@@ -6015,9 +6155,9 @@ module Google
6015
6155
  # checking any filters on the search page. The filter applied to every search
6016
6156
  # request when quality improvement such as query expansion is needed. For
6017
6157
  # example, if a query does not have enough results, an expanded query with
6018
- # SearchRequest.canonical_filter will be returned as a supplement of the
6019
- # original query. This field is strongly recommended to achieve high search
6020
- # quality. See SearchRequest.filter for more details about filter syntax.
6158
+ # SearchRequest.canonical_filter is returned as a supplement of the original
6159
+ # query. This field is strongly recommended to achieve high search quality. For
6160
+ # more information about filter syntax, see SearchRequest.filter.
6021
6161
  # Corresponds to the JSON property `canonicalFilter`
6022
6162
  # @return [String]
6023
6163
  attr_accessor :canonical_filter
@@ -6044,8 +6184,8 @@ module Google
6044
6184
 
6045
6185
  # The filter syntax consists of an expression language for constructing a
6046
6186
  # predicate from one or more fields of the products being filtered. Filter
6047
- # expression is case-sensitive. See more details at this [user guide](https://
6048
- # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
6187
+ # expression is case-sensitive. For more information, see [Filter](https://cloud.
6188
+ # google.com/retail/docs/filter-and-order#filter). If this field is
6049
6189
  # unrecognizable, an INVALID_ARGUMENT is returned.
6050
6190
  # Corresponds to the JSON property `filter`
6051
6191
  # @return [String]
@@ -6060,8 +6200,9 @@ module Google
6060
6200
  # UTF-8 encoding, and international characters are allowed. * The key portion of
6061
6201
  # a label must be unique. However, you can use the same key with multiple
6062
6202
  # resources. * Keys must start with a lowercase letter or international
6063
- # character. See [Google Cloud Document](https://cloud.google.com/resource-
6064
- # manager/docs/creating-managing-labels#requirements) for more details.
6203
+ # character. For more information, see [Requirements for labels](https://cloud.
6204
+ # google.com/resource-manager/docs/creating-managing-labels#requirements) in the
6205
+ # Resource Manager documentation.
6065
6206
  # Corresponds to the JSON property `labels`
6066
6207
  # @return [Hash<String,String>]
6067
6208
  attr_accessor :labels
@@ -6076,8 +6217,8 @@ module Google
6076
6217
 
6077
6218
  # The order in which products are returned. Products can be ordered by a field
6078
6219
  # in an Product object. Leave it unset if ordered by relevance. OrderBy
6079
- # expression is case-sensitive. See more details at this [user guide](https://
6080
- # cloud.google.com/retail/docs/filter-and-order#order). If this field is
6220
+ # expression is case-sensitive. For more information, see [Order](https://cloud.
6221
+ # google.com/retail/docs/filter-and-order#order). If this field is
6081
6222
  # unrecognizable, an INVALID_ARGUMENT is returned.
6082
6223
  # Corresponds to the JSON property `orderBy`
6083
6224
  # @return [String]
@@ -6306,23 +6447,22 @@ module Google
6306
6447
 
6307
6448
  # Enables dynamic position for this facet. If set to true, the position of this
6308
6449
  # facet among all facets in the response is determined by Google Retail Search.
6309
- # It will be ordered together with dynamic facets if dynamic facets is enabled.
6310
- # If set to false, the position of this facet in the response will be the same
6311
- # as in the request, and it will be ranked before the facets with dynamic
6312
- # position enable and all dynamic facets. For example, you may always want to
6313
- # have rating facet returned in the response, but it's not necessarily to always
6314
- # display the rating facet at the top. In that case, you can set
6315
- # enable_dynamic_position to true so that the position of rating facet in
6316
- # response will be determined by Google Retail Search. Another example, assuming
6317
- # you have the following facets in the request: * "rating",
6318
- # enable_dynamic_position = true * "price", enable_dynamic_position = false * "
6319
- # brands", enable_dynamic_position = false And also you have a dynamic facets
6320
- # enable, which will generate a facet 'gender'. Then the final order of the
6321
- # facets in the response can be ("price", "brands", "rating", "gender") or ("
6322
- # price", "brands", "gender", "rating") depends on how Google Retail Search
6323
- # orders "gender" and "rating" facets. However, notice that "price" and "brands"
6324
- # will always be ranked at 1st and 2nd position since their
6325
- # enable_dynamic_position are false.
6450
+ # It is ordered together with dynamic facets if dynamic facets is enabled. If
6451
+ # set to false, the position of this facet in the response is the same as in the
6452
+ # request, and it is ranked before the facets with dynamic position enable and
6453
+ # all dynamic facets. For example, you may always want to have rating facet
6454
+ # returned in the response, but it's not necessarily to always display the
6455
+ # rating facet at the top. In that case, you can set enable_dynamic_position to
6456
+ # true so that the position of rating facet in response is determined by Google
6457
+ # Retail Search. Another example, assuming you have the following facets in the
6458
+ # request: * "rating", enable_dynamic_position = true * "price",
6459
+ # enable_dynamic_position = false * "brands", enable_dynamic_position = false
6460
+ # And also you have a dynamic facets enable, which generates a facet "gender".
6461
+ # Then, the final order of the facets in the response can be ("price", "brands",
6462
+ # "rating", "gender") or ("price", "brands", "gender", "rating") depends on how
6463
+ # Google Retail Search orders "gender" and "rating" facets. However, notice that
6464
+ # "price" and "brands" are always ranked at first and second position because
6465
+ # their enable_dynamic_position values are false.
6326
6466
  # Corresponds to the JSON property `enableDynamicPosition`
6327
6467
  # @return [Boolean]
6328
6468
  attr_accessor :enable_dynamic_position
@@ -6386,8 +6526,8 @@ module Google
6386
6526
 
6387
6527
  # Only get facet values that contains the given strings. For example, suppose "
6388
6528
  # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
6389
- # If set "contains" to "Shoe", the "categories" facet will give only "Women >
6390
- # Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
6529
+ # If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe"
6530
+ # and "Men > Shoe". Only supported on textual fields. Maximum is 10.
6391
6531
  # Corresponds to the JSON property `contains`
6392
6532
  # @return [Array<String>]
6393
6533
  attr_accessor :contains
@@ -6395,12 +6535,12 @@ module Google
6395
6535
  # Set only if values should be bucketized into intervals. Must be set for facets
6396
6536
  # with numerical values. Must not be set for facet with text values. Maximum
6397
6537
  # number of intervals is 40. For all numerical facet keys that appear in the
6398
- # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and
6538
+ # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and
6399
6539
  # 100 are computed from their distribution weekly. If the model assigns a high
6400
6540
  # score to a numerical facet key and its intervals are not specified in the
6401
- # search request, these percentiles will become the bounds for its intervals and
6402
- # will be returned in the response. If the facet key intervals are specified in
6403
- # the request, then the specified intervals will be returned instead.
6541
+ # search request, these percentiles become the bounds for its intervals and are
6542
+ # returned in the response. If the facet key intervals are specified in the
6543
+ # request, then the specified intervals are returned instead.
6404
6544
  # Corresponds to the JSON property `intervals`
6405
6545
  # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval>]
6406
6546
  attr_accessor :intervals
@@ -6434,7 +6574,7 @@ module Google
6434
6574
 
6435
6575
  # Only get facet values that start with the given string prefix. For example,
6436
6576
  # suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men
6437
- # > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "
6577
+ # > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "
6438
6578
  # Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum
6439
6579
  # is 10.
6440
6580
  # Corresponds to the JSON property `prefixes`
@@ -6442,16 +6582,15 @@ module Google
6442
6582
  attr_accessor :prefixes
6443
6583
 
6444
6584
  # The query that is used to compute facet for the given facet key. When provided,
6445
- # it will override the default behavior of facet computation. The query syntax
6446
- # is the same as a filter expression. See SearchRequest.filter for detail syntax
6585
+ # it overrides the default behavior of facet computation. The query syntax is
6586
+ # the same as a filter expression. See SearchRequest.filter for detail syntax
6447
6587
  # and limitations. Notice that there is no limitation on FacetKey.key when query
6448
- # is specified. In the response, SearchResponse.Facet.values.value will be
6449
- # always "1" and SearchResponse.Facet.values.count will be the number of results
6450
- # that match the query. For example, you can set a customized facet for "
6451
- # shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.
6452
- # query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then
6453
- # the facet will count the products that are both in stock and ship to store "
6454
- # 123".
6588
+ # is specified. In the response, SearchResponse.Facet.values.value is always "1"
6589
+ # and SearchResponse.Facet.values.count is the number of results that match the
6590
+ # query. For example, you can set a customized facet for "shipToStore", where
6591
+ # FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability:
6592
+ # ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet counts the
6593
+ # products that are both in stock and ship to store "123".
6455
6594
  # Corresponds to the JSON property `query`
6456
6595
  # @return [String]
6457
6596
  attr_accessor :query
@@ -7233,8 +7372,8 @@ module Google
7233
7372
 
7234
7373
  # The entity for customers that may run multiple different entities, domains,
7235
7374
  # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
7236
- # , `youtube.com`, etc. It is recommended to set this field to get better per-
7237
- # entity search, completion and prediction results.
7375
+ # , `youtube.com`, etc. We recommend that you set this field to get better per-
7376
+ # entity search, completion, and prediction results.
7238
7377
  # Corresponds to the JSON property `entity`
7239
7378
  # @return [String]
7240
7379
  attr_accessor :entity
@@ -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.72.0"
19
+ GEM_VERSION = "0.73.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230413"
25
+ REVISION = "20230420"
26
26
  end
27
27
  end
28
28
  end
@@ -130,6 +130,18 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
133
145
  class GoogleCloudRetailV2ModelServingConfigList
134
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
147
 
@@ -334,6 +346,18 @@ module Google
334
346
  include Google::Apis::Core::JsonObjectSupport
335
347
  end
336
348
 
349
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
355
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
356
+ class Representation < Google::Apis::Core::JsonRepresentation; end
357
+
358
+ include Google::Apis::Core::JsonObjectSupport
359
+ end
360
+
337
361
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
338
362
  class Representation < Google::Apis::Core::JsonRepresentation; end
339
363
 
@@ -832,6 +856,18 @@ module Google
832
856
  include Google::Apis::Core::JsonObjectSupport
833
857
  end
834
858
 
859
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
860
+ class Representation < Google::Apis::Core::JsonRepresentation; end
861
+
862
+ include Google::Apis::Core::JsonObjectSupport
863
+ end
864
+
865
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
866
+ class Representation < Google::Apis::Core::JsonRepresentation; end
867
+
868
+ include Google::Apis::Core::JsonObjectSupport
869
+ end
870
+
835
871
  class GoogleCloudRetailV2betaModelServingConfigList
836
872
  class Representation < Google::Apis::Core::JsonRepresentation; end
837
873
 
@@ -1427,6 +1463,8 @@ module Google
1427
1463
  property :display_name, as: 'displayName'
1428
1464
  property :filtering_option, as: 'filteringOption'
1429
1465
  property :last_tune_time, as: 'lastTuneTime'
1466
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelModelFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelModelFeaturesConfig::Representation
1467
+
1430
1468
  property :name, as: 'name'
1431
1469
  property :optimization_objective, as: 'optimizationObjective'
1432
1470
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -1440,6 +1478,21 @@ module Google
1440
1478
  end
1441
1479
  end
1442
1480
 
1481
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
1482
+ # @private
1483
+ class Representation < Google::Apis::Core::JsonRepresentation
1484
+ property :context_products_type, as: 'contextProductsType'
1485
+ end
1486
+ end
1487
+
1488
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
1489
+ # @private
1490
+ class Representation < Google::Apis::Core::JsonRepresentation
1491
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig::Representation
1492
+
1493
+ end
1494
+ end
1495
+
1443
1496
  class GoogleCloudRetailV2ModelServingConfigList
1444
1497
  # @private
1445
1498
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1706,6 +1759,8 @@ module Google
1706
1759
  property :display_name, as: 'displayName'
1707
1760
  property :filtering_option, as: 'filteringOption'
1708
1761
  property :last_tune_time, as: 'lastTuneTime'
1762
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelModelFeaturesConfig::Representation
1763
+
1709
1764
  property :name, as: 'name'
1710
1765
  property :optimization_objective, as: 'optimizationObjective'
1711
1766
  property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
@@ -1721,6 +1776,21 @@ module Google
1721
1776
  end
1722
1777
  end
1723
1778
 
1779
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
1780
+ # @private
1781
+ class Representation < Google::Apis::Core::JsonRepresentation
1782
+ property :context_products_type, as: 'contextProductsType'
1783
+ end
1784
+ end
1785
+
1786
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
1787
+ # @private
1788
+ class Representation < Google::Apis::Core::JsonRepresentation
1789
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
1790
+
1791
+ end
1792
+ end
1793
+
1724
1794
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
1725
1795
  # @private
1726
1796
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2461,6 +2531,8 @@ module Google
2461
2531
  property :display_name, as: 'displayName'
2462
2532
  property :filtering_option, as: 'filteringOption'
2463
2533
  property :last_tune_time, as: 'lastTuneTime'
2534
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelModelFeaturesConfig::Representation
2535
+
2464
2536
  property :name, as: 'name'
2465
2537
  property :optimization_objective, as: 'optimizationObjective'
2466
2538
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -2474,6 +2546,21 @@ module Google
2474
2546
  end
2475
2547
  end
2476
2548
 
2549
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
2550
+ # @private
2551
+ class Representation < Google::Apis::Core::JsonRepresentation
2552
+ property :context_products_type, as: 'contextProductsType'
2553
+ end
2554
+ end
2555
+
2556
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
2557
+ # @private
2558
+ class Representation < Google::Apis::Core::JsonRepresentation
2559
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
2560
+
2561
+ end
2562
+ end
2563
+
2477
2564
  class GoogleCloudRetailV2betaModelServingConfigList
2478
2565
  # @private
2479
2566
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -72,10 +72,10 @@ module Google
72
72
  # all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `
73
73
  # MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
74
74
  # @param [String] entity
75
- # The entity for customers that may run multiple different entities, domains,
76
- # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
77
- # , `youtube.com`, etc. If this is set, it should be exactly matched with
78
- # UserEvent.entity to get per-entity autocomplete results.
75
+ # The entity for customers who run multiple entities, domains, sites, or regions,
76
+ # for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`,
77
+ # etc. If this is set, it must be an exact match with UserEvent.entity to get
78
+ # per-entity autocomplete results.
79
79
  # @param [Array<String>, String] language_codes
80
80
  # Note that this field applies for `user-data` dataset only. For requests with `
81
81
  # cloud-retail` dataset, setting this field has no effect. The language filters
@@ -615,13 +615,13 @@ module Google
615
615
  execute_or_queue_command(command, &block)
616
616
  end
617
617
 
618
- # It is recommended to use the ProductService.AddLocalInventories method instead
619
- # of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories
620
- # achieves the same results but provides more fine-grained control over
621
- # ingesting local inventory data. Incrementally adds place IDs to Product.
622
- # fulfillment_info.place_ids. This process is asynchronous and does not require
623
- # the Product to exist before updating fulfillment information. If the request
624
- # is valid, the update will be enqueued and processed downstream. As a
618
+ # We recommend that you use the ProductService.AddLocalInventories method
619
+ # instead of the ProductService.AddFulfillmentPlaces method. ProductService.
620
+ # AddLocalInventories achieves the same results but provides more fine-grained
621
+ # control over ingesting local inventory data. Incrementally adds place IDs to
622
+ # Product.fulfillment_info.place_ids. This process is asynchronous and does not
623
+ # require the Product to exist before updating fulfillment information. If the
624
+ # request is valid, the update will be enqueued and processed downstream. As a
625
625
  # consequence, when a response is returned, the added place IDs are not
626
626
  # immediately manifested in the Product queried by ProductService.GetProduct or
627
627
  # ProductService.ListProducts. The returned Operations will be obsolete after 1
@@ -976,8 +976,8 @@ module Google
976
976
  execute_or_queue_command(command, &block)
977
977
  end
978
978
 
979
- # It is recommended to use the ProductService.RemoveLocalInventories method
980
- # instead of ProductService.RemoveFulfillmentPlaces. ProductService.
979
+ # We recommend that you use the ProductService.RemoveLocalInventories method
980
+ # instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.
981
981
  # RemoveLocalInventories achieves the same results but provides more fine-
982
982
  # grained control over ingesting local inventory data. Incrementally removes
983
983
  # place IDs from a Product.fulfillment_info.place_ids. This process is
@@ -1762,7 +1762,7 @@ module Google
1762
1762
  # default_serving_config` or the name of the legacy placement resource, such as `
1763
1763
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1764
1764
  # . This field is used to identify the serving config name and the set of models
1765
- # that will be used to make the search.
1765
+ # that are used to make the search.
1766
1766
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
1767
1767
  # @param [String] fields
1768
1768
  # Selector specifying which fields to include in a partial response.
@@ -2105,7 +2105,7 @@ module Google
2105
2105
  # default_serving_config` or the name of the legacy placement resource, such as `
2106
2106
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
2107
2107
  # . This field is used to identify the serving config name and the set of models
2108
- # that will be used to make the search.
2108
+ # that are used to make the search.
2109
2109
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
2110
2110
  # @param [String] fields
2111
2111
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.72.0
4
+ version: 0.73.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-23 00:00:00.000000000 Z
11
+ date: 2023-04-30 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_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.72.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.73.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
63
63
  post_install_message:
64
64
  rdoc_options: []