google-cloud-retail-v2 0.11.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/cloud/retail/v2/catalog_pb.rb +14 -0
- data/lib/google/cloud/retail/v2/catalog_service/client.rb +1 -1
- data/lib/google/cloud/retail/v2/catalog_service.rb +1 -1
- data/lib/google/cloud/retail/v2/completion_service/client.rb +7 -5
- data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
- data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +3 -3
- data/lib/google/cloud/retail/v2/control_service.rb +1 -1
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +7 -8
- data/lib/google/cloud/retail/v2/prediction_service.rb +1 -1
- data/lib/google/cloud/retail/v2/prediction_service_pb.rb +1 -0
- data/lib/google/cloud/retail/v2/product_service/client.rb +48 -38
- data/lib/google/cloud/retail/v2/product_service.rb +1 -1
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +48 -38
- data/lib/google/cloud/retail/v2/search_service/client.rb +4 -4
- data/lib/google/cloud/retail/v2/search_service.rb +2 -2
- data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/serving_config_pb.rb +7 -0
- data/lib/google/cloud/retail/v2/serving_config_service/client.rb +5 -5
- data/lib/google/cloud/retail/v2/serving_config_service.rb +1 -1
- data/lib/google/cloud/retail/v2/user_event_service/client.rb +25 -12
- data/lib/google/cloud/retail/v2/user_event_service.rb +1 -1
- data/lib/google/cloud/retail/v2/user_event_service_pb.rb +6 -0
- data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +8 -8
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/lib/google/cloud/retail/v2.rb +2 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/retail/v2/catalog.rb +51 -13
- data/proto_docs/google/cloud/retail/v2/catalog_service.rb +1 -1
- data/proto_docs/google/cloud/retail/v2/common.rb +5 -3
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +4 -2
- data/proto_docs/google/cloud/retail/v2/control.rb +2 -3
- data/proto_docs/google/cloud/retail/v2/prediction_service.rb +7 -8
- data/proto_docs/google/cloud/retail/v2/product.rb +27 -5
- data/proto_docs/google/cloud/retail/v2/search_service.rb +15 -8
- data/proto_docs/google/cloud/retail/v2/serving_config.rb +32 -15
- data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +5 -5
- data/proto_docs/google/cloud/retail/v2/user_event.rb +1 -1
- data/proto_docs/google/cloud/retail/v2/user_event_service.rb +24 -8
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +6 -4
@@ -105,13 +105,13 @@ module Google
|
|
105
105
|
# APIs. This field is `False` for pre-loaded
|
106
106
|
# {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s.
|
107
107
|
#
|
108
|
-
# Only pre-loaded
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
# either in use by products or are predefined cannot be deleted;
|
113
|
-
# their configuration properties will reset to default values upon
|
114
|
-
# request.
|
108
|
+
# Only pre-loaded [catalog
|
109
|
+
# attributes][google.cloud.retail.v2.CatalogAttribute] that are neither in
|
110
|
+
# use by products nor predefined can be deleted. [Catalog
|
111
|
+
# attributes][google.cloud.retail.v2.CatalogAttribute] that are
|
112
|
+
# either in use by products or are predefined attributes cannot be deleted;
|
113
|
+
# however, their configuration properties will reset to default values upon
|
114
|
+
# removal request.
|
115
115
|
#
|
116
116
|
# After catalog changes, it takes about 10 minutes for this field to update.
|
117
117
|
# @!attribute [r] type
|
@@ -125,12 +125,16 @@ module Google
|
|
125
125
|
# is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
|
126
126
|
# are indexed so that it can be filtered, faceted, or boosted in
|
127
127
|
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
|
128
|
+
#
|
129
|
+
# Must be specified, otherwise throws INVALID_FORMAT error.
|
128
130
|
# @!attribute [rw] dynamic_facetable_option
|
129
131
|
# @return [::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption]
|
130
132
|
# If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
|
131
133
|
# facet. Could only be DYNAMIC_FACETABLE_DISABLED if
|
132
134
|
# {::Google::Cloud::Retail::V2::CatalogAttribute#indexable_option CatalogAttribute.indexable_option}
|
133
135
|
# is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
|
136
|
+
#
|
137
|
+
# Must be specified, otherwise throws INVALID_FORMAT error.
|
134
138
|
# @!attribute [rw] searchable_option
|
135
139
|
# @return [::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption]
|
136
140
|
# When
|
@@ -143,6 +147,17 @@ module Google
|
|
143
147
|
# will not be searchable by text queries in
|
144
148
|
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}, as
|
145
149
|
# there are no text values associated to numerical attributes.
|
150
|
+
#
|
151
|
+
# Must be specified, otherwise throws INVALID_FORMAT error.
|
152
|
+
# @!attribute [rw] exact_searchable_option
|
153
|
+
# @return [::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption]
|
154
|
+
# If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
|
155
|
+
# This property only applies to textual custom attributes and requires
|
156
|
+
# indexable set to enabled to enable exact-searchable.
|
157
|
+
# @!attribute [rw] retrievable_option
|
158
|
+
# @return [::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption]
|
159
|
+
# If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
|
160
|
+
# results.
|
146
161
|
class CatalogAttribute
|
147
162
|
include ::Google::Protobuf::MessageExts
|
148
163
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -164,8 +179,7 @@ module Google
|
|
164
179
|
|
165
180
|
# The status of the indexable option of a catalog attribute.
|
166
181
|
module IndexableOption
|
167
|
-
# Value used when unset.
|
168
|
-
# {::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption::INDEXABLE_ENABLED INDEXABLE_ENABLED}.
|
182
|
+
# Value used when unset.
|
169
183
|
INDEXABLE_OPTION_UNSPECIFIED = 0
|
170
184
|
|
171
185
|
# Indexable option enabled for an attribute.
|
@@ -177,8 +191,7 @@ module Google
|
|
177
191
|
|
178
192
|
# The status of the dynamic facetable option of a catalog attribute.
|
179
193
|
module DynamicFacetableOption
|
180
|
-
# Value used when unset.
|
181
|
-
# {::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption::DYNAMIC_FACETABLE_ENABLED DYNAMIC_FACETABLE_ENABLED}.
|
194
|
+
# Value used when unset.
|
182
195
|
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0
|
183
196
|
|
184
197
|
# Dynamic facetable option enabled for an attribute.
|
@@ -190,8 +203,7 @@ module Google
|
|
190
203
|
|
191
204
|
# The status of the searchable option of a catalog attribute.
|
192
205
|
module SearchableOption
|
193
|
-
# Value used when unset.
|
194
|
-
# {::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption::SEARCHABLE_DISABLED SEARCHABLE_DISABLED}.
|
206
|
+
# Value used when unset.
|
195
207
|
SEARCHABLE_OPTION_UNSPECIFIED = 0
|
196
208
|
|
197
209
|
# Searchable option enabled for an attribute.
|
@@ -200,6 +212,32 @@ module Google
|
|
200
212
|
# Searchable option disabled for an attribute.
|
201
213
|
SEARCHABLE_DISABLED = 2
|
202
214
|
end
|
215
|
+
|
216
|
+
# The status of the exact-searchable option of a catalog attribute.
|
217
|
+
module ExactSearchableOption
|
218
|
+
# Value used when unset. Defaults to
|
219
|
+
# {::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption::EXACT_SEARCHABLE_DISABLED EXACT_SEARCHABLE_DISABLED}.
|
220
|
+
EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0
|
221
|
+
|
222
|
+
# Exact searchable option enabled for an attribute.
|
223
|
+
EXACT_SEARCHABLE_ENABLED = 1
|
224
|
+
|
225
|
+
# Exact searchable option disabled for an attribute.
|
226
|
+
EXACT_SEARCHABLE_DISABLED = 2
|
227
|
+
end
|
228
|
+
|
229
|
+
# The status of the retrievable option of a catalog attribute.
|
230
|
+
module RetrievableOption
|
231
|
+
# Value used when unset. Defaults to
|
232
|
+
# {::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption::RETRIEVABLE_DISABLED RETRIEVABLE_DISABLED}.
|
233
|
+
RETRIEVABLE_OPTION_UNSPECIFIED = 0
|
234
|
+
|
235
|
+
# Retrievable option enabled for an attribute.
|
236
|
+
RETRIEVABLE_ENABLED = 1
|
237
|
+
|
238
|
+
# Retrievable option disabled for an attribute.
|
239
|
+
RETRIEVABLE_DISABLED = 2
|
240
|
+
end
|
203
241
|
end
|
204
242
|
|
205
243
|
# Catalog level attribute config.
|
@@ -165,7 +165,7 @@ module Google
|
|
165
165
|
# @!attribute [rw] name
|
166
166
|
# @return [::String]
|
167
167
|
# Required. Full CompletionConfig resource name. Format:
|
168
|
-
# projects
|
168
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
|
169
169
|
class GetCompletionConfigRequest
|
170
170
|
include ::Google::Protobuf::MessageExts
|
171
171
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -48,8 +48,8 @@ module Google
|
|
48
48
|
# Value cannot be empty.
|
49
49
|
# Value can have at most 3 terms if specified as a partial match. Each
|
50
50
|
# space separated string is considered as one term.
|
51
|
-
#
|
52
|
-
# allowed for partial match.
|
51
|
+
# For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms
|
52
|
+
# and not allowed for a partial match.
|
53
53
|
# @!attribute [rw] full_match
|
54
54
|
# @return [::Boolean]
|
55
55
|
# Whether this is supposed to be a full or partial match.
|
@@ -73,6 +73,7 @@ module Google
|
|
73
73
|
end
|
74
74
|
|
75
75
|
# A rule is a condition-action pair
|
76
|
+
#
|
76
77
|
# * A condition defines when a rule is to be triggered.
|
77
78
|
# * An action specifies what occurs on that trigger.
|
78
79
|
# Currently rules only work for {::Google::Cloud::Retail::V2::Control controls} with
|
@@ -202,7 +203,8 @@ module Google
|
|
202
203
|
end
|
203
204
|
|
204
205
|
# Creates a set of terms that will be treated as synonyms of each other.
|
205
|
-
# Example: synonyms of "sneakers" and "shoes"
|
206
|
+
# Example: synonyms of "sneakers" and "shoes":
|
207
|
+
#
|
206
208
|
# * "sneakers" will use a synonym of "shoes".
|
207
209
|
# * "shoes" will use a synonym of "sneakers".
|
208
210
|
# @!attribute [rw] synonyms
|
@@ -55,8 +55,10 @@ module Google
|
|
55
55
|
# number of language codes is 3.
|
56
56
|
# @!attribute [rw] device_type
|
57
57
|
# @return [::String]
|
58
|
-
# The device type context for completion suggestions.
|
59
|
-
#
|
58
|
+
# The device type context for completion suggestions. We recommend that you
|
59
|
+
# leave this field empty.
|
60
|
+
#
|
61
|
+
# It can apply different suggestions on different device types, e.g.
|
60
62
|
# `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
|
61
63
|
# types.
|
62
64
|
#
|
@@ -41,9 +41,8 @@ module Google
|
|
41
41
|
# characters. Otherwise, an INVALID_ARGUMENT error is thrown.
|
42
42
|
# @!attribute [r] associated_serving_config_ids
|
43
43
|
# @return [::Array<::String>]
|
44
|
-
# Output only. List of
|
45
|
-
#
|
46
|
-
# associated with this control in the same
|
44
|
+
# Output only. List of {::Google::Cloud::Retail::V2::ServingConfig serving config}
|
45
|
+
# ids that are associated with this control in the same
|
47
46
|
# {::Google::Cloud::Retail::V2::Catalog Catalog}.
|
48
47
|
#
|
49
48
|
# Note the association is managed via the
|
@@ -33,7 +33,7 @@ module Google
|
|
33
33
|
# The ID of the Recommendations AI serving config or placement.
|
34
34
|
# Before you can request predictions from your model, you must create at
|
35
35
|
# least one serving config or placement for it. For more information, see
|
36
|
-
# [
|
36
|
+
# [Manage serving configs]
|
37
37
|
# (https://cloud.google.com/retail/docs/manage-configs).
|
38
38
|
#
|
39
39
|
# The full list of available serving configs can be seen at
|
@@ -88,12 +88,11 @@ module Google
|
|
88
88
|
# * filterOutOfStockItems tag=(-"promotional")
|
89
89
|
# * filterOutOfStockItems
|
90
90
|
#
|
91
|
-
# If your filter blocks all prediction results, the API will return
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
# or "DELETED" regardless of filter choices.
|
91
|
+
# If your filter blocks all prediction results, the API will return *no*
|
92
|
+
# results. If instead you want empty result sets to return generic
|
93
|
+
# (unfiltered) popular products, set `strictFiltering` to False in
|
94
|
+
# `PredictRequest.params`. Note that the API will never return items with
|
95
|
+
# storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
|
97
96
|
#
|
98
97
|
# If `filterSyntaxV2` is set to true under the `params` field, then
|
99
98
|
# attribute-based expressions are expected instead of the above described
|
@@ -120,7 +119,7 @@ module Google
|
|
120
119
|
# * `returnScore`: Boolean. If set to true, the prediction 'score'
|
121
120
|
# corresponding to each returned product will be set in the
|
122
121
|
# `results.metadata` field in the prediction response. The given
|
123
|
-
# 'score' indicates the probability of
|
122
|
+
# 'score' indicates the probability of a product being clicked/purchased
|
124
123
|
# given the user's context and history.
|
125
124
|
# * `strictFiltering`: Boolean. True by default. If set to false, the service
|
126
125
|
# will return generic (unfiltered) popular products instead of empty if
|
@@ -26,7 +26,13 @@ module Google
|
|
26
26
|
# @!attribute [rw] expire_time
|
27
27
|
# @return [::Google::Protobuf::Timestamp]
|
28
28
|
# The timestamp when this product becomes unavailable for
|
29
|
-
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
|
29
|
+
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}. Note
|
30
|
+
# that this is only applicable to
|
31
|
+
# {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
|
32
|
+
# {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, and
|
33
|
+
# ignored for {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
|
34
|
+
# In general, we suggest the users to delete the stale products explicitly,
|
35
|
+
# instead of using this field to determine staleness.
|
30
36
|
#
|
31
37
|
# If it is set, the {::Google::Cloud::Retail::V2::Product Product} is not
|
32
38
|
# available for
|
@@ -46,7 +52,13 @@ module Google
|
|
46
52
|
# [expiration_date](https://support.google.com/merchants/answer/6324499).
|
47
53
|
# @!attribute [rw] ttl
|
48
54
|
# @return [::Google::Protobuf::Duration]
|
49
|
-
# Input only. The TTL (time to live) of the product.
|
55
|
+
# Input only. The TTL (time to live) of the product. Note that this is only
|
56
|
+
# applicable to {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
|
57
|
+
# and {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION},
|
58
|
+
# and ignored for
|
59
|
+
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}. In general,
|
60
|
+
# we suggest the users to delete the stale products explicitly, instead of
|
61
|
+
# using this field to determine staleness.
|
50
62
|
#
|
51
63
|
# If it is set, it must be a non-negative value, and
|
52
64
|
# {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
|
@@ -146,7 +158,7 @@ module Google
|
|
146
158
|
#
|
147
159
|
#
|
148
160
|
# To represent full path of category, use '>' sign to separate different
|
149
|
-
# hierarchies. If '>' is part of the category name,
|
161
|
+
# hierarchies. If '>' is part of the category name, replace it with
|
150
162
|
# other character(s).
|
151
163
|
#
|
152
164
|
# For example, if a shoes product belongs to both
|
@@ -276,7 +288,11 @@ module Google
|
|
276
288
|
# @return [::Google::Protobuf::Timestamp]
|
277
289
|
# The timestamp when this {::Google::Cloud::Retail::V2::Product Product} becomes
|
278
290
|
# available for
|
279
|
-
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
|
291
|
+
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}. Note
|
292
|
+
# that this is only applicable to
|
293
|
+
# {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
|
294
|
+
# {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, and
|
295
|
+
# ignored for {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
|
280
296
|
# @!attribute [rw] availability
|
281
297
|
# @return [::Google::Cloud::Retail::V2::Product::Availability]
|
282
298
|
# The online availability of the {::Google::Cloud::Retail::V2::Product Product}.
|
@@ -462,6 +478,8 @@ module Google
|
|
462
478
|
# Note: Returning more fields in
|
463
479
|
# {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
|
464
480
|
# response payload size and serving latency.
|
481
|
+
#
|
482
|
+
# This field is deprecated. Use the retrievable site-wide control instead.
|
465
483
|
# @!attribute [r] variants
|
466
484
|
# @return [::Array<::Google::Cloud::Retail::V2::Product>]
|
467
485
|
# Output only. Product variants grouped together on primary product which
|
@@ -479,7 +497,11 @@ module Google
|
|
479
497
|
# Output only. A list of local inventories specific to different places.
|
480
498
|
#
|
481
499
|
# This is only available for users who have Retail Search enabled, and it can
|
482
|
-
# be managed by
|
500
|
+
# be managed by
|
501
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
|
502
|
+
# and
|
503
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
|
504
|
+
# APIs.
|
483
505
|
class Product
|
484
506
|
include ::Google::Protobuf::MessageExts
|
485
507
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -29,7 +29,7 @@ module Google
|
|
29
29
|
# `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
|
30
30
|
# or the name of the legacy placement resource, such as
|
31
31
|
# `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
|
32
|
-
# This field is used to identify the serving
|
32
|
+
# This field is used to identify the serving config name and the set
|
33
33
|
# of models that will be used to make the search.
|
34
34
|
# @!attribute [rw] branch
|
35
35
|
# @return [::String]
|
@@ -230,7 +230,7 @@ module Google
|
|
230
230
|
# {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
|
231
231
|
#
|
232
232
|
# To represent full path of category, use '>' sign to separate different
|
233
|
-
# hierarchies. If '>' is part of the category name,
|
233
|
+
# hierarchies. If '>' is part of the category name, replace it with
|
234
234
|
# other character(s).
|
235
235
|
#
|
236
236
|
# Category pages include special pages such as sales or promotions. For
|
@@ -286,7 +286,7 @@ module Google
|
|
286
286
|
# @!attribute [rw] limit
|
287
287
|
# @return [::Integer]
|
288
288
|
# Maximum of facet values that should be returned for this facet. If
|
289
|
-
# unspecified, defaults to
|
289
|
+
# unspecified, defaults to 50. The maximum allowed value is 300. Values
|
290
290
|
# above 300 will be coerced to 300.
|
291
291
|
#
|
292
292
|
# If this field is negative, an INVALID_ARGUMENT is returned.
|
@@ -686,15 +686,20 @@ module Google
|
|
686
686
|
# The search mode of each search request.
|
687
687
|
module SearchMode
|
688
688
|
# Default value. In this case both product search and faceted search will
|
689
|
-
# be performed. Both
|
690
|
-
#
|
689
|
+
# be performed. Both
|
690
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
|
691
|
+
# and {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet}
|
692
|
+
# will be returned.
|
691
693
|
SEARCH_MODE_UNSPECIFIED = 0
|
692
694
|
|
693
695
|
# Only product search will be performed. The faceted search will be
|
694
696
|
# disabled.
|
695
697
|
#
|
696
|
-
# Only
|
697
|
-
#
|
698
|
+
# Only
|
699
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
|
700
|
+
# will be returned.
|
701
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
|
702
|
+
# not be returned, even if
|
698
703
|
# {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
|
699
704
|
# or
|
700
705
|
# {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
|
@@ -709,7 +714,9 @@ module Google
|
|
709
714
|
# and
|
710
715
|
# {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
|
711
716
|
# should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
|
712
|
-
#
|
717
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
|
718
|
+
# be returned.
|
719
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
|
713
720
|
# will not be returned.
|
714
721
|
FACETED_SEARCH_ONLY = 2
|
715
722
|
end
|
@@ -54,13 +54,13 @@ module Google
|
|
54
54
|
# click-through and conversion rates.
|
55
55
|
# Allowed values are:
|
56
56
|
#
|
57
|
-
# *
|
58
|
-
# *
|
59
|
-
# *
|
60
|
-
# *
|
57
|
+
# * `no-price-reranking`
|
58
|
+
# * `low-price-raranking`
|
59
|
+
# * `medium-price-reranking`
|
60
|
+
# * `high-price-reranking`
|
61
61
|
#
|
62
62
|
# If not specified, we choose default based on model type. Default value:
|
63
|
-
#
|
63
|
+
# `no-price-reranking`.
|
64
64
|
#
|
65
65
|
# Can only be set if
|
66
66
|
# {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
|
@@ -178,29 +178,34 @@ module Google
|
|
178
178
|
# @!attribute [rw] diversity_level
|
179
179
|
# @return [::String]
|
180
180
|
# How much diversity to use in recommendation model results e.g.
|
181
|
-
#
|
181
|
+
# `medium-diversity` or `high-diversity`. Currently supported values:
|
182
182
|
#
|
183
|
-
# *
|
184
|
-
# *
|
185
|
-
# *
|
186
|
-
# *
|
187
|
-
# *
|
183
|
+
# * `no-diversity`
|
184
|
+
# * `low-diversity`
|
185
|
+
# * `medium-diversity`
|
186
|
+
# * `high-diversity`
|
187
|
+
# * `auto-diversity`
|
188
188
|
#
|
189
189
|
# If not specified, we choose default based on recommendation model
|
190
|
-
# type. Default value:
|
190
|
+
# type. Default value: `no-diversity`.
|
191
191
|
#
|
192
192
|
# Can only be set if
|
193
193
|
# {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
|
194
194
|
# [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
|
195
|
+
# @!attribute [rw] diversity_type
|
196
|
+
# @return [::Google::Cloud::Retail::V2::ServingConfig::DiversityType]
|
197
|
+
# What kind of diversity to use - data driven or rule based. If unset,
|
198
|
+
# the server behavior defaults to
|
199
|
+
# {::Google::Cloud::Retail::V2::ServingConfig::DiversityType::RULE_BASED_DIVERSITY RULE_BASED_DIVERSITY}.
|
195
200
|
# @!attribute [rw] enable_category_filter_level
|
196
201
|
# @return [::String]
|
197
|
-
# Whether to add additional category filters on the
|
202
|
+
# Whether to add additional category filters on the `similar-items` model.
|
198
203
|
# If not specified, we enable it by default.
|
199
204
|
# Allowed values are:
|
200
205
|
#
|
201
|
-
# *
|
206
|
+
# * `no-category-match`: No additional filtering of original results from
|
202
207
|
# the model and the customer's filters.
|
203
|
-
# *
|
208
|
+
# * `relaxed-category-match`: Only keep results with categories that match
|
204
209
|
# at least one item categories in the PredictRequests's context item.
|
205
210
|
# * If customer also sends filters in the PredictRequest, then the results
|
206
211
|
# will satisfy both conditions (user given and category match).
|
@@ -231,6 +236,18 @@ module Google
|
|
231
236
|
class ServingConfig
|
232
237
|
include ::Google::Protobuf::MessageExts
|
233
238
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
239
|
+
|
240
|
+
# What type of diversity - data or rule based.
|
241
|
+
module DiversityType
|
242
|
+
# Default value.
|
243
|
+
DIVERSITY_TYPE_UNSPECIFIED = 0
|
244
|
+
|
245
|
+
# Rule based diversity.
|
246
|
+
RULE_BASED_DIVERSITY = 2
|
247
|
+
|
248
|
+
# Data driven diversity.
|
249
|
+
DATA_DRIVEN_DIVERSITY = 3
|
250
|
+
end
|
234
251
|
end
|
235
252
|
end
|
236
253
|
end
|
@@ -63,7 +63,7 @@ module Google
|
|
63
63
|
# @!attribute [rw] name
|
64
64
|
# @return [::String]
|
65
65
|
# Required. The resource name of the ServingConfig to delete. Format:
|
66
|
-
# projects
|
66
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
|
67
67
|
class DeleteServingConfigRequest
|
68
68
|
include ::Google::Protobuf::MessageExts
|
69
69
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -73,7 +73,7 @@ module Google
|
|
73
73
|
# @!attribute [rw] name
|
74
74
|
# @return [::String]
|
75
75
|
# Required. The resource name of the ServingConfig to get. Format:
|
76
|
-
# projects
|
76
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
|
77
77
|
class GetServingConfigRequest
|
78
78
|
include ::Google::Protobuf::MessageExts
|
79
79
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -83,7 +83,7 @@ module Google
|
|
83
83
|
# @!attribute [rw] parent
|
84
84
|
# @return [::String]
|
85
85
|
# Required. The catalog resource name. Format:
|
86
|
-
# projects
|
86
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
|
87
87
|
# @!attribute [rw] page_size
|
88
88
|
# @return [::Integer]
|
89
89
|
# Optional. Maximum number of results to return. If unspecified, defaults
|
@@ -114,7 +114,7 @@ module Google
|
|
114
114
|
# @!attribute [rw] serving_config
|
115
115
|
# @return [::String]
|
116
116
|
# Required. The source ServingConfig resource name . Format:
|
117
|
-
# projects
|
117
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
|
118
118
|
# @!attribute [rw] control_id
|
119
119
|
# @return [::String]
|
120
120
|
# Required. The id of the control to apply. Assumed to be in the same catalog
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# @!attribute [rw] serving_config
|
129
129
|
# @return [::String]
|
130
130
|
# Required. The source ServingConfig resource name . Format:
|
131
|
-
# projects
|
131
|
+
# `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
|
132
132
|
# @!attribute [rw] control_id
|
133
133
|
# @return [::String]
|
134
134
|
# Required. The id of the control to apply. Assumed to be in the same catalog
|
@@ -217,7 +217,7 @@ module Google
|
|
217
217
|
# The categories associated with a category page.
|
218
218
|
#
|
219
219
|
# To represent full path of category, use '>' sign to separate different
|
220
|
-
# hierarchies. If '>' is part of the category name,
|
220
|
+
# hierarchies. If '>' is part of the category name, replace it with
|
221
221
|
# other character(s).
|
222
222
|
#
|
223
223
|
# Category pages include special pages such as sales or promotions. For
|
@@ -29,12 +29,22 @@ module Google
|
|
29
29
|
# @!attribute [rw] user_event
|
30
30
|
# @return [::Google::Cloud::Retail::V2::UserEvent]
|
31
31
|
# Required. User event to write.
|
32
|
+
# @!attribute [rw] write_async
|
33
|
+
# @return [::Boolean]
|
34
|
+
# If set to true, the user event will be written asynchronously after
|
35
|
+
# validation, and the API will respond without waiting for the write.
|
36
|
+
# Therefore, silent failures can occur even if the API returns success. In
|
37
|
+
# case of silent failures, error messages can be found in Stackdriver logs.
|
32
38
|
class WriteUserEventRequest
|
33
39
|
include ::Google::Protobuf::MessageExts
|
34
40
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
35
41
|
end
|
36
42
|
|
37
43
|
# Request message for CollectUserEvent method.
|
44
|
+
# @!attribute [rw] prebuilt_rule
|
45
|
+
# @return [::String]
|
46
|
+
# The prebuilt rule name that can convert a specific type of raw_json.
|
47
|
+
# For example: "default_schema/v1.0"
|
38
48
|
# @!attribute [rw] parent
|
39
49
|
# @return [::String]
|
40
50
|
# Required. The parent catalog name, such as
|
@@ -54,6 +64,12 @@ module Google
|
|
54
64
|
# The event timestamp in milliseconds. This prevents browser caching of
|
55
65
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
56
66
|
# payload bytes.
|
67
|
+
# @!attribute [rw] raw_json
|
68
|
+
# @return [::String]
|
69
|
+
# An arbitrary serialized JSON string that contains necessary information
|
70
|
+
# that can comprise a user event. When this field is specified, the
|
71
|
+
# user_event field will be ignored. Note: line-delimited JSON is not
|
72
|
+
# supported, a single JSON only.
|
57
73
|
class CollectUserEventRequest
|
58
74
|
include ::Google::Protobuf::MessageExts
|
59
75
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -68,19 +84,19 @@ module Google
|
|
68
84
|
# @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
|
69
85
|
# The type of the user event rejoin to define the scope and range of the user
|
70
86
|
# events to be rejoined with the latest product catalog. Defaults to
|
71
|
-
# USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to
|
72
|
-
# invalid integer value.
|
87
|
+
# `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
|
88
|
+
# an invalid integer value.
|
73
89
|
class RejoinUserEventsRequest
|
74
90
|
include ::Google::Protobuf::MessageExts
|
75
91
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
76
92
|
|
77
93
|
# The scope of user events to be rejoined with the latest product catalog.
|
78
94
|
# If the rejoining aims at reducing number of unjoined events, set
|
79
|
-
# UserEventRejoinScope to UNJOINED_EVENTS
|
95
|
+
# `UserEventRejoinScope` to `UNJOINED_EVENTS`.
|
80
96
|
# If the rejoining aims at correcting product catalog information in joined
|
81
|
-
# events, set UserEventRejoinScope to JOINED_EVENTS
|
82
|
-
# If all events needs to be rejoined, set UserEventRejoinScope to
|
83
|
-
# USER_EVENT_REJOIN_SCOPE_UNSPECIFIED
|
97
|
+
# events, set `UserEventRejoinScope` to `JOINED_EVENTS`.
|
98
|
+
# If all events needs to be rejoined, set `UserEventRejoinScope` to
|
99
|
+
# `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`.
|
84
100
|
module UserEventRejoinScope
|
85
101
|
# Rejoin all events with the latest product catalog, including both joined
|
86
102
|
# events and unjoined events.
|
@@ -94,7 +110,7 @@ module Google
|
|
94
110
|
end
|
95
111
|
end
|
96
112
|
|
97
|
-
# Response message for RejoinUserEvents method.
|
113
|
+
# Response message for `RejoinUserEvents` method.
|
98
114
|
# @!attribute [rw] rejoined_user_events_count
|
99
115
|
# @return [::Integer]
|
100
116
|
# Number of user events that were joined with latest product catalog.
|
@@ -103,7 +119,7 @@ module Google
|
|
103
119
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
120
|
end
|
105
121
|
|
106
|
-
# Metadata for RejoinUserEvents method.
|
122
|
+
# Metadata for `RejoinUserEvents` method.
|
107
123
|
class RejoinUserEventsMetadata
|
108
124
|
include ::Google::Protobuf::MessageExts
|
109
125
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -28,12 +28,14 @@ module Google
|
|
28
28
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
29
29
|
# @!attribute [rw] code
|
30
30
|
# @return [::Integer]
|
31
|
-
# The status code, which should be an enum value of
|
31
|
+
# The status code, which should be an enum value of
|
32
|
+
# [google.rpc.Code][google.rpc.Code].
|
32
33
|
# @!attribute [rw] message
|
33
34
|
# @return [::String]
|
34
35
|
# A developer-facing error message, which should be in English. Any
|
35
36
|
# user-facing error message should be localized and sent in the
|
36
|
-
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
37
|
+
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
38
|
+
# by the client.
|
37
39
|
# @!attribute [rw] details
|
38
40
|
# @return [::Array<::Google::Protobuf::Any>]
|
39
41
|
# A list of messages that carry the error details. There is a common set of
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-retail-v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.12.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:
|
11
|
+
date: 2023-01-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 0.16.0
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version:
|
29
|
+
version: 0.16.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -234,8 +234,10 @@ files:
|
|
234
234
|
- lib/google/cloud/retail/v2/user_event_service_services_pb.rb
|
235
235
|
- lib/google/cloud/retail/v2/version.rb
|
236
236
|
- proto_docs/README.md
|
237
|
+
- proto_docs/google/api/client.rb
|
237
238
|
- proto_docs/google/api/field_behavior.rb
|
238
239
|
- proto_docs/google/api/httpbody.rb
|
240
|
+
- proto_docs/google/api/launch_stage.rb
|
239
241
|
- proto_docs/google/api/resource.rb
|
240
242
|
- proto_docs/google/cloud/retail/v2/catalog.rb
|
241
243
|
- proto_docs/google/cloud/retail/v2/catalog_service.rb
|