google-apis-retail_v2 0.70.0 → 0.71.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: df11aab75082f77bca06d97bb654a36d867ec9b8b548487d958ede800e9931d2
4
- data.tar.gz: 71746b24b8604e58342ce6529bc85d88628159da75221f8321dc48b2fe32c931
3
+ metadata.gz: b5abaae51c40aafdd4cb7896eebb193bc493871981e10862f09bb67ea6984560
4
+ data.tar.gz: f84164f162ed326430a1fec6b79ac7532a0e47b55037320ef9f167240a50d1f9
5
5
  SHA512:
6
- metadata.gz: 3593693dccb0fca8c6cd85151ab97d0b51894c76e7d5eb5ed7eae1786b7ffed13355a00757f2cee4f0e8143a038b709f057d23ce8d70a1d810136a1e377b6ea0
7
- data.tar.gz: 1a91555e35ad4f4ac489c49b52a42edcb1598c1b5c113bf296f11bb452e06afd6326a3b431cccad3c217fd5e3cf0a84548bd199418ced7adf4bc273b8078540e
6
+ metadata.gz: 97423beeea375718bad3d97cd745f0b0ce9cfe148b55866d9e59d242668a4cd8d5ee478770a32f172d233d15fdcb3e04ecf112c91fa4844bc9f7460fa349f4db
7
+ data.tar.gz: 7324b2b589f75875e0dca568087ebe83d3244f075fcf3bfd17244cfe4d345207c4f1d7c7b477525d86e4585abdd43defc8279f04d118c492f0665f63075455ab
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.71.0 (2023-04-30)
4
+
5
+ * Regenerated from discovery document revision 20230420
6
+
3
7
  ### v0.70.0 (2023-04-23)
4
8
 
5
9
  * Regenerated from discovery document revision 20230413
@@ -820,8 +820,8 @@ module Google
820
820
  attr_accessor :completion_results
821
821
 
822
822
  # Matched recent searches of this user. The maximum number of recent searches is
823
- # 10. This field is a restricted feature. Contact Retail Search support team if
824
- # you are interested in enabling it. This feature is only available when
823
+ # 10. This field is a restricted feature. If you want to enable it, contact
824
+ # Retail Search support. This feature is only available when
825
825
  # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
826
826
  # recent searches satisfy the follow rules: * They are ordered from latest to
827
827
  # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
@@ -930,8 +930,8 @@ module Google
930
930
  attr_accessor :last_denylist_import_operation
931
931
 
932
932
  # Output only. Name of the LRO corresponding to the latest suggestion terms list
933
- # import. Can use GetOperation API to retrieve the latest state of the Long
934
- # Running Operation.
933
+ # import. Can use GetOperation API method to retrieve the latest state of the
934
+ # Long Running Operation.
935
935
  # Corresponds to the JSON property `lastSuggestionsImportOperation`
936
936
  # @return [String]
937
937
  attr_accessor :last_suggestions_import_operation
@@ -1271,7 +1271,7 @@ module Google
1271
1271
  end
1272
1272
  end
1273
1273
 
1274
- # Metadata for active A/B testing Experiments.
1274
+ # Metadata for active A/B testing Experiment.
1275
1275
  class GoogleCloudRetailV2ExperimentInfo
1276
1276
  include Google::Apis::Core::Hashable
1277
1277
 
@@ -1617,9 +1617,11 @@ module Google
1617
1617
  # the import is finished, a notification is sent to specified Pub/Sub topic. The
1618
1618
  # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
1619
1619
  # projects/`project`/topics/`topic``. It has to be within the same project as
1620
- # ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
1621
- # gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
1622
- # topic.
1620
+ # ImportProductsRequest.parent. Make sure that both `cloud-retail-customer-data-
1621
+ # access@system.gserviceaccount.com` and `service-@gcp-sa-retail.iam.
1622
+ # gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the
1623
+ # topic. Only supported when ImportProductsRequest.reconciliation_mode is set to
1624
+ # `FULL`.
1623
1625
  # Corresponds to the JSON property `notificationPubsubTopic`
1624
1626
  # @return [String]
1625
1627
  attr_accessor :notification_pubsub_topic
@@ -1997,6 +1999,11 @@ module Google
1997
1999
  # @return [String]
1998
2000
  attr_accessor :last_tune_time
1999
2001
 
2002
+ # Additional model features config.
2003
+ # Corresponds to the JSON property `modelFeaturesConfig`
2004
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig]
2005
+ attr_accessor :model_features_config
2006
+
2000
2007
  # Required. The fully qualified resource name of the model. Format: `projects/`
2001
2008
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
2002
2009
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -2086,6 +2093,7 @@ module Google
2086
2093
  @display_name = args[:display_name] if args.key?(:display_name)
2087
2094
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
2088
2095
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
2096
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
2089
2097
  @name = args[:name] if args.key?(:name)
2090
2098
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
2091
2099
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -2098,6 +2106,46 @@ module Google
2098
2106
  end
2099
2107
  end
2100
2108
 
2109
+ # More configs of the frequently-bought-together model type.
2110
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
2111
+ include Google::Apis::Core::Hashable
2112
+
2113
+ # Optional. Specifies the context of the model when used in predict requests.
2114
+ # Only settable for the `frequently-bought-together` type. Will default to
2115
+ # MULTI_CONTEXT if not specified.
2116
+ # Corresponds to the JSON property `contextProductsType`
2117
+ # @return [String]
2118
+ attr_accessor :context_products_type
2119
+
2120
+ def initialize(**args)
2121
+ update!(**args)
2122
+ end
2123
+
2124
+ # Update properties of this object
2125
+ def update!(**args)
2126
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
2127
+ end
2128
+ end
2129
+
2130
+ # Additional model features config.
2131
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
2132
+ include Google::Apis::Core::Hashable
2133
+
2134
+ # More configs of the frequently-bought-together model type.
2135
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
2136
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig]
2137
+ attr_accessor :frequently_bought_together_config
2138
+
2139
+ def initialize(**args)
2140
+ update!(**args)
2141
+ end
2142
+
2143
+ # Update properties of this object
2144
+ def update!(**args)
2145
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
2146
+ end
2147
+ end
2148
+
2101
2149
  # Represents an ordered combination of valid serving configs, which can be used
2102
2150
  # for `PAGE_OPTIMIZATION` recommendations.
2103
2151
  class GoogleCloudRetailV2ModelServingConfigList
@@ -3568,11 +3616,11 @@ module Google
3568
3616
  include Google::Apis::Core::Hashable
3569
3617
 
3570
3618
  # A filter to apply on the matching condition results. Supported features: *
3571
- # filter must be set. * Filter syntax is identical to SearchRequest.filter. See
3572
- # more details at the Retail Search [user guide](/retail/search/docs/filter-and-
3573
- # order#filter). * To filter products with product ID "product_1" or "product_2",
3574
- # and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(
3575
- # colorFamilies: ANY("Red", "Blue")) *
3619
+ # filter must be set. * Filter syntax is identical to SearchRequest.filter. For
3620
+ # more information, see [Filter](/retail/docs/filter-and-order#filter). * To
3621
+ # filter products with product ID "product_1" or "product_2", and color "Red" or
3622
+ # "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("
3623
+ # Red", "Blue")) *
3576
3624
  # Corresponds to the JSON property `filter`
3577
3625
  # @return [String]
3578
3626
  attr_accessor :filter
@@ -3740,9 +3788,9 @@ module Google
3740
3788
  # checking any filters on the search page. The filter applied to every search
3741
3789
  # request when quality improvement such as query expansion is needed. For
3742
3790
  # example, if a query does not have enough results, an expanded query with
3743
- # SearchRequest.canonical_filter will be returned as a supplement of the
3744
- # original query. This field is strongly recommended to achieve high search
3745
- # quality. See SearchRequest.filter for more details about filter syntax.
3791
+ # SearchRequest.canonical_filter is returned as a supplement of the original
3792
+ # query. This field is strongly recommended to achieve high search quality. For
3793
+ # more information about filter syntax, see SearchRequest.filter.
3746
3794
  # Corresponds to the JSON property `canonicalFilter`
3747
3795
  # @return [String]
3748
3796
  attr_accessor :canonical_filter
@@ -3769,8 +3817,8 @@ module Google
3769
3817
 
3770
3818
  # The filter syntax consists of an expression language for constructing a
3771
3819
  # predicate from one or more fields of the products being filtered. Filter
3772
- # expression is case-sensitive. See more details at this [user guide](https://
3773
- # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
3820
+ # expression is case-sensitive. For more information, see [Filter](https://cloud.
3821
+ # google.com/retail/docs/filter-and-order#filter). If this field is
3774
3822
  # unrecognizable, an INVALID_ARGUMENT is returned.
3775
3823
  # Corresponds to the JSON property `filter`
3776
3824
  # @return [String]
@@ -3785,8 +3833,9 @@ module Google
3785
3833
  # UTF-8 encoding, and international characters are allowed. * The key portion of
3786
3834
  # a label must be unique. However, you can use the same key with multiple
3787
3835
  # resources. * Keys must start with a lowercase letter or international
3788
- # character. See [Google Cloud Document](https://cloud.google.com/resource-
3789
- # manager/docs/creating-managing-labels#requirements) for more details.
3836
+ # character. For more information, see [Requirements for labels](https://cloud.
3837
+ # google.com/resource-manager/docs/creating-managing-labels#requirements) in the
3838
+ # Resource Manager documentation.
3790
3839
  # Corresponds to the JSON property `labels`
3791
3840
  # @return [Hash<String,String>]
3792
3841
  attr_accessor :labels
@@ -3801,8 +3850,8 @@ module Google
3801
3850
 
3802
3851
  # The order in which products are returned. Products can be ordered by a field
3803
3852
  # in an Product object. Leave it unset if ordered by relevance. OrderBy
3804
- # expression is case-sensitive. See more details at this [user guide](https://
3805
- # cloud.google.com/retail/docs/filter-and-order#order). If this field is
3853
+ # expression is case-sensitive. For more information, see [Order](https://cloud.
3854
+ # google.com/retail/docs/filter-and-order#order). If this field is
3806
3855
  # unrecognizable, an INVALID_ARGUMENT is returned.
3807
3856
  # Corresponds to the JSON property `orderBy`
3808
3857
  # @return [String]
@@ -4031,23 +4080,22 @@ module Google
4031
4080
 
4032
4081
  # Enables dynamic position for this facet. If set to true, the position of this
4033
4082
  # facet among all facets in the response is determined by Google Retail Search.
4034
- # It will be ordered together with dynamic facets if dynamic facets is enabled.
4035
- # If set to false, the position of this facet in the response will be the same
4036
- # as in the request, and it will be ranked before the facets with dynamic
4037
- # position enable and all dynamic facets. For example, you may always want to
4038
- # have rating facet returned in the response, but it's not necessarily to always
4039
- # display the rating facet at the top. In that case, you can set
4040
- # enable_dynamic_position to true so that the position of rating facet in
4041
- # response will be determined by Google Retail Search. Another example, assuming
4042
- # you have the following facets in the request: * "rating",
4043
- # enable_dynamic_position = true * "price", enable_dynamic_position = false * "
4044
- # brands", enable_dynamic_position = false And also you have a dynamic facets
4045
- # enable, which will generate a facet 'gender'. Then the final order of the
4046
- # facets in the response can be ("price", "brands", "rating", "gender") or ("
4047
- # price", "brands", "gender", "rating") depends on how Google Retail Search
4048
- # orders "gender" and "rating" facets. However, notice that "price" and "brands"
4049
- # will always be ranked at 1st and 2nd position since their
4050
- # enable_dynamic_position are false.
4083
+ # It is ordered together with dynamic facets if dynamic facets is enabled. If
4084
+ # set to false, the position of this facet in the response is the same as in the
4085
+ # request, and it is ranked before the facets with dynamic position enable and
4086
+ # all dynamic facets. For example, you may always want to have rating facet
4087
+ # returned in the response, but it's not necessarily to always display the
4088
+ # rating facet at the top. In that case, you can set enable_dynamic_position to
4089
+ # true so that the position of rating facet in response is determined by Google
4090
+ # Retail Search. Another example, assuming you have the following facets in the
4091
+ # request: * "rating", enable_dynamic_position = true * "price",
4092
+ # enable_dynamic_position = false * "brands", enable_dynamic_position = false
4093
+ # And also you have a dynamic facets enable, which generates a facet "gender".
4094
+ # Then, the final order of the facets in the response can be ("price", "brands",
4095
+ # "rating", "gender") or ("price", "brands", "gender", "rating") depends on how
4096
+ # Google Retail Search orders "gender" and "rating" facets. However, notice that
4097
+ # "price" and "brands" are always ranked at first and second position because
4098
+ # their enable_dynamic_position values are false.
4051
4099
  # Corresponds to the JSON property `enableDynamicPosition`
4052
4100
  # @return [Boolean]
4053
4101
  attr_accessor :enable_dynamic_position
@@ -4111,8 +4159,8 @@ module Google
4111
4159
 
4112
4160
  # Only get facet values that contains the given strings. For example, suppose "
4113
4161
  # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
4114
- # If set "contains" to "Shoe", the "categories" facet will give only "Women >
4115
- # Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
4162
+ # If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe"
4163
+ # and "Men > Shoe". Only supported on textual fields. Maximum is 10.
4116
4164
  # Corresponds to the JSON property `contains`
4117
4165
  # @return [Array<String>]
4118
4166
  attr_accessor :contains
@@ -4120,12 +4168,12 @@ module Google
4120
4168
  # Set only if values should be bucketized into intervals. Must be set for facets
4121
4169
  # with numerical values. Must not be set for facet with text values. Maximum
4122
4170
  # number of intervals is 40. For all numerical facet keys that appear in the
4123
- # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and
4171
+ # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and
4124
4172
  # 100 are computed from their distribution weekly. If the model assigns a high
4125
4173
  # score to a numerical facet key and its intervals are not specified in the
4126
- # search request, these percentiles will become the bounds for its intervals and
4127
- # will be returned in the response. If the facet key intervals are specified in
4128
- # the request, then the specified intervals will be returned instead.
4174
+ # search request, these percentiles become the bounds for its intervals and are
4175
+ # returned in the response. If the facet key intervals are specified in the
4176
+ # request, then the specified intervals are returned instead.
4129
4177
  # Corresponds to the JSON property `intervals`
4130
4178
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Interval>]
4131
4179
  attr_accessor :intervals
@@ -4159,7 +4207,7 @@ module Google
4159
4207
 
4160
4208
  # Only get facet values that start with the given string prefix. For example,
4161
4209
  # suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men
4162
- # > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "
4210
+ # > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "
4163
4211
  # Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum
4164
4212
  # is 10.
4165
4213
  # Corresponds to the JSON property `prefixes`
@@ -4167,16 +4215,15 @@ module Google
4167
4215
  attr_accessor :prefixes
4168
4216
 
4169
4217
  # The query that is used to compute facet for the given facet key. When provided,
4170
- # it will override the default behavior of facet computation. The query syntax
4171
- # is the same as a filter expression. See SearchRequest.filter for detail syntax
4218
+ # it overrides the default behavior of facet computation. The query syntax is
4219
+ # the same as a filter expression. See SearchRequest.filter for detail syntax
4172
4220
  # and limitations. Notice that there is no limitation on FacetKey.key when query
4173
- # is specified. In the response, SearchResponse.Facet.values.value will be
4174
- # always "1" and SearchResponse.Facet.values.count will be the number of results
4175
- # that match the query. For example, you can set a customized facet for "
4176
- # shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.
4177
- # query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then
4178
- # the facet will count the products that are both in stock and ship to store "
4179
- # 123".
4221
+ # is specified. In the response, SearchResponse.Facet.values.value is always "1"
4222
+ # and SearchResponse.Facet.values.count is the number of results that match the
4223
+ # query. For example, you can set a customized facet for "shipToStore", where
4224
+ # FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability:
4225
+ # ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet counts the
4226
+ # products that are both in stock and ship to store "123".
4180
4227
  # Corresponds to the JSON property `query`
4181
4228
  # @return [String]
4182
4229
  attr_accessor :query
@@ -4958,8 +5005,8 @@ module Google
4958
5005
 
4959
5006
  # The entity for customers that may run multiple different entities, domains,
4960
5007
  # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
4961
- # , `youtube.com`, etc. It is recommended to set this field to get better per-
4962
- # entity search, completion and prediction results.
5008
+ # , `youtube.com`, etc. We recommend that you set this field to get better per-
5009
+ # entity search, completion, and prediction results.
4963
5010
  # Corresponds to the JSON property `entity`
4964
5011
  # @return [String]
4965
5012
  attr_accessor :entity
@@ -5856,6 +5903,11 @@ module Google
5856
5903
  # @return [String]
5857
5904
  attr_accessor :last_tune_time
5858
5905
 
5906
+ # Additional model features config.
5907
+ # Corresponds to the JSON property `modelFeaturesConfig`
5908
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig]
5909
+ attr_accessor :model_features_config
5910
+
5859
5911
  # Required. The fully qualified resource name of the model. Format: `projects/`
5860
5912
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
5861
5913
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -5953,6 +6005,7 @@ module Google
5953
6005
  @display_name = args[:display_name] if args.key?(:display_name)
5954
6006
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
5955
6007
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
6008
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
5956
6009
  @name = args[:name] if args.key?(:name)
5957
6010
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
5958
6011
  @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
@@ -5966,6 +6019,46 @@ module Google
5966
6019
  end
5967
6020
  end
5968
6021
 
6022
+ # More configs of the frequently-bought-together model type.
6023
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
6024
+ include Google::Apis::Core::Hashable
6025
+
6026
+ # Optional. Specifies the context of the model when used in predict requests.
6027
+ # Only settable for the `frequently-bought-together` type. Will default to
6028
+ # MULTI_CONTEXT if not specified.
6029
+ # Corresponds to the JSON property `contextProductsType`
6030
+ # @return [String]
6031
+ attr_accessor :context_products_type
6032
+
6033
+ def initialize(**args)
6034
+ update!(**args)
6035
+ end
6036
+
6037
+ # Update properties of this object
6038
+ def update!(**args)
6039
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
6040
+ end
6041
+ end
6042
+
6043
+ # Additional model features config.
6044
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
6045
+ include Google::Apis::Core::Hashable
6046
+
6047
+ # More configs of the frequently-bought-together model type.
6048
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
6049
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig]
6050
+ attr_accessor :frequently_bought_together_config
6051
+
6052
+ def initialize(**args)
6053
+ update!(**args)
6054
+ end
6055
+
6056
+ # Update properties of this object
6057
+ def update!(**args)
6058
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
6059
+ end
6060
+ end
6061
+
5969
6062
  # The PageOptimizationConfig for model training. This determines how many panels
5970
6063
  # to optimize for, and which serving configs to consider for each panel. The
5971
6064
  # purpose of this model is to optimize which ServingConfig to show on which
@@ -6998,6 +7091,11 @@ module Google
6998
7091
  # @return [String]
6999
7092
  attr_accessor :last_tune_time
7000
7093
 
7094
+ # Additional model features config.
7095
+ # Corresponds to the JSON property `modelFeaturesConfig`
7096
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig]
7097
+ attr_accessor :model_features_config
7098
+
7001
7099
  # Required. The fully qualified resource name of the model. Format: `projects/`
7002
7100
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
7003
7101
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -7087,6 +7185,7 @@ module Google
7087
7185
  @display_name = args[:display_name] if args.key?(:display_name)
7088
7186
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
7089
7187
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
7188
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
7090
7189
  @name = args[:name] if args.key?(:name)
7091
7190
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
7092
7191
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -7099,6 +7198,46 @@ module Google
7099
7198
  end
7100
7199
  end
7101
7200
 
7201
+ # More configs of the frequently-bought-together model type.
7202
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
7203
+ include Google::Apis::Core::Hashable
7204
+
7205
+ # Optional. Specifies the context of the model when used in predict requests.
7206
+ # Only settable for the `frequently-bought-together` type. Will default to
7207
+ # MULTI_CONTEXT if not specified.
7208
+ # Corresponds to the JSON property `contextProductsType`
7209
+ # @return [String]
7210
+ attr_accessor :context_products_type
7211
+
7212
+ def initialize(**args)
7213
+ update!(**args)
7214
+ end
7215
+
7216
+ # Update properties of this object
7217
+ def update!(**args)
7218
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
7219
+ end
7220
+ end
7221
+
7222
+ # Additional model features config.
7223
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
7224
+ include Google::Apis::Core::Hashable
7225
+
7226
+ # More configs of the frequently-bought-together model type.
7227
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
7228
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig]
7229
+ attr_accessor :frequently_bought_together_config
7230
+
7231
+ def initialize(**args)
7232
+ update!(**args)
7233
+ end
7234
+
7235
+ # Update properties of this object
7236
+ def update!(**args)
7237
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
7238
+ end
7239
+ end
7240
+
7102
7241
  # Represents an ordered combination of valid serving configs, which can be used
7103
7242
  # for `PAGE_OPTIMIZATION` recommendations.
7104
7243
  class GoogleCloudRetailV2betaModelServingConfigList
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.70.0"
19
+ GEM_VERSION = "0.71.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
@@ -352,6 +352,18 @@ module Google
352
352
  include Google::Apis::Core::JsonObjectSupport
353
353
  end
354
354
 
355
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
356
+ class Representation < Google::Apis::Core::JsonRepresentation; end
357
+
358
+ include Google::Apis::Core::JsonObjectSupport
359
+ end
360
+
361
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
362
+ class Representation < Google::Apis::Core::JsonRepresentation; end
363
+
364
+ include Google::Apis::Core::JsonObjectSupport
365
+ end
366
+
355
367
  class GoogleCloudRetailV2ModelServingConfigList
356
368
  class Representation < Google::Apis::Core::JsonRepresentation; end
357
369
 
@@ -874,6 +886,18 @@ module Google
874
886
  include Google::Apis::Core::JsonObjectSupport
875
887
  end
876
888
 
889
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
890
+ class Representation < Google::Apis::Core::JsonRepresentation; end
891
+
892
+ include Google::Apis::Core::JsonObjectSupport
893
+ end
894
+
895
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
896
+ class Representation < Google::Apis::Core::JsonRepresentation; end
897
+
898
+ include Google::Apis::Core::JsonObjectSupport
899
+ end
900
+
877
901
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
878
902
  class Representation < Google::Apis::Core::JsonRepresentation; end
879
903
 
@@ -1120,6 +1144,18 @@ module Google
1120
1144
  include Google::Apis::Core::JsonObjectSupport
1121
1145
  end
1122
1146
 
1147
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
1148
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1149
+
1150
+ include Google::Apis::Core::JsonObjectSupport
1151
+ end
1152
+
1153
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
1154
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1155
+
1156
+ include Google::Apis::Core::JsonObjectSupport
1157
+ end
1158
+
1123
1159
  class GoogleCloudRetailV2betaModelServingConfigList
1124
1160
  class Representation < Google::Apis::Core::JsonRepresentation; end
1125
1161
 
@@ -1760,6 +1796,8 @@ module Google
1760
1796
  property :display_name, as: 'displayName'
1761
1797
  property :filtering_option, as: 'filteringOption'
1762
1798
  property :last_tune_time, as: 'lastTuneTime'
1799
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig::Representation
1800
+
1763
1801
  property :name, as: 'name'
1764
1802
  property :optimization_objective, as: 'optimizationObjective'
1765
1803
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -1773,6 +1811,21 @@ module Google
1773
1811
  end
1774
1812
  end
1775
1813
 
1814
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
1815
+ # @private
1816
+ class Representation < Google::Apis::Core::JsonRepresentation
1817
+ property :context_products_type, as: 'contextProductsType'
1818
+ end
1819
+ end
1820
+
1821
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
1822
+ # @private
1823
+ class Representation < Google::Apis::Core::JsonRepresentation
1824
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig::Representation
1825
+
1826
+ end
1827
+ end
1828
+
1776
1829
  class GoogleCloudRetailV2ModelServingConfigList
1777
1830
  # @private
1778
1831
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2653,6 +2706,8 @@ module Google
2653
2706
  property :display_name, as: 'displayName'
2654
2707
  property :filtering_option, as: 'filteringOption'
2655
2708
  property :last_tune_time, as: 'lastTuneTime'
2709
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig::Representation
2710
+
2656
2711
  property :name, as: 'name'
2657
2712
  property :optimization_objective, as: 'optimizationObjective'
2658
2713
  property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
@@ -2668,6 +2723,21 @@ module Google
2668
2723
  end
2669
2724
  end
2670
2725
 
2726
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
2727
+ # @private
2728
+ class Representation < Google::Apis::Core::JsonRepresentation
2729
+ property :context_products_type, as: 'contextProductsType'
2730
+ end
2731
+ end
2732
+
2733
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
2734
+ # @private
2735
+ class Representation < Google::Apis::Core::JsonRepresentation
2736
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
2737
+
2738
+ end
2739
+ end
2740
+
2671
2741
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
2672
2742
  # @private
2673
2743
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2996,6 +3066,8 @@ module Google
2996
3066
  property :display_name, as: 'displayName'
2997
3067
  property :filtering_option, as: 'filteringOption'
2998
3068
  property :last_tune_time, as: 'lastTuneTime'
3069
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig::Representation
3070
+
2999
3071
  property :name, as: 'name'
3000
3072
  property :optimization_objective, as: 'optimizationObjective'
3001
3073
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -3009,6 +3081,21 @@ module Google
3009
3081
  end
3010
3082
  end
3011
3083
 
3084
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
3085
+ # @private
3086
+ class Representation < Google::Apis::Core::JsonRepresentation
3087
+ property :context_products_type, as: 'contextProductsType'
3088
+ end
3089
+ end
3090
+
3091
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
3092
+ # @private
3093
+ class Representation < Google::Apis::Core::JsonRepresentation
3094
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
3095
+
3096
+ end
3097
+ end
3098
+
3012
3099
  class GoogleCloudRetailV2betaModelServingConfigList
3013
3100
  # @private
3014
3101
  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
@@ -580,13 +580,13 @@ module Google
580
580
  execute_or_queue_command(command, &block)
581
581
  end
582
582
 
583
- # It is recommended to use the ProductService.AddLocalInventories method instead
584
- # of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories
585
- # achieves the same results but provides more fine-grained control over
586
- # ingesting local inventory data. Incrementally adds place IDs to Product.
587
- # fulfillment_info.place_ids. This process is asynchronous and does not require
588
- # the Product to exist before updating fulfillment information. If the request
589
- # is valid, the update will be enqueued and processed downstream. As a
583
+ # We recommend that you use the ProductService.AddLocalInventories method
584
+ # instead of the ProductService.AddFulfillmentPlaces method. ProductService.
585
+ # AddLocalInventories achieves the same results but provides more fine-grained
586
+ # control over ingesting local inventory data. Incrementally adds place IDs to
587
+ # Product.fulfillment_info.place_ids. This process is asynchronous and does not
588
+ # require the Product to exist before updating fulfillment information. If the
589
+ # request is valid, the update will be enqueued and processed downstream. As a
590
590
  # consequence, when a response is returned, the added place IDs are not
591
591
  # immediately manifested in the Product queried by ProductService.GetProduct or
592
592
  # ProductService.ListProducts. The returned Operations will be obsolete after 1
@@ -941,8 +941,8 @@ module Google
941
941
  execute_or_queue_command(command, &block)
942
942
  end
943
943
 
944
- # It is recommended to use the ProductService.RemoveLocalInventories method
945
- # instead of ProductService.RemoveFulfillmentPlaces. ProductService.
944
+ # We recommend that you use the ProductService.RemoveLocalInventories method
945
+ # instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.
946
946
  # RemoveLocalInventories achieves the same results but provides more fine-
947
947
  # grained control over ingesting local inventory data. Incrementally removes
948
948
  # place IDs from a Product.fulfillment_info.place_ids. This process is
@@ -1727,7 +1727,7 @@ module Google
1727
1727
  # default_serving_config` or the name of the legacy placement resource, such as `
1728
1728
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1729
1729
  # . This field is used to identify the serving config name and the set of models
1730
- # that will be used to make the search.
1730
+ # that are used to make the search.
1731
1731
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
1732
1732
  # @param [String] fields
1733
1733
  # Selector specifying which fields to include in a partial response.
@@ -2070,7 +2070,7 @@ module Google
2070
2070
  # default_serving_config` or the name of the legacy placement resource, such as `
2071
2071
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
2072
2072
  # . This field is used to identify the serving config name and the set of models
2073
- # that will be used to make the search.
2073
+ # that are used to make the search.
2074
2074
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
2075
2075
  # @param [String] fields
2076
2076
  # 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_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.70.0
4
+ version: 0.71.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_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.70.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.71.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []