google-cloud-retail-v2 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1dc44cab7183e8c99dcff0174ca915af53d47e792de193605d4333dd65777ced
|
|
4
|
+
data.tar.gz: 31deb9ad3ab11a76193b85fe3bc30c39eaa372dda44dd1b83c12a01a89e9e06c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8925f2040c7b54c45d4dc158735550f20cda1aacbf42b6e46e7abc02dcab586921cd2744b6b44573dd0fbe3164cfab9e5432ecb55a81c9275321337e3a654515
|
|
7
|
+
data.tar.gz: 502150bb18dbb2fdbb9ba9911d1e6e1272c80506feb6a625bb4ac335d5fdfbfa5b62d901385dc115c0921dbcfd092b35219c44709e9cb1904d1ba02dd4ace9a9
|
|
@@ -236,8 +236,7 @@ module Google
|
|
|
236
236
|
# @param filter [::String]
|
|
237
237
|
# The filter syntax consists of an expression language for constructing a
|
|
238
238
|
# predicate from one or more fields of the products being filtered. Filter
|
|
239
|
-
# expression is case-sensitive.
|
|
240
|
-
# guide](/retail/private/docs/filter-and-order#filter).
|
|
239
|
+
# expression is case-sensitive.
|
|
241
240
|
#
|
|
242
241
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
243
242
|
# @param canonical_filter [::String]
|
|
@@ -253,9 +252,7 @@ module Google
|
|
|
253
252
|
# @param order_by [::String]
|
|
254
253
|
# The order in which products are returned. Products can be ordered by
|
|
255
254
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
|
256
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
257
|
-
# more details at this [user
|
|
258
|
-
# guide](/retail/private/docs/filter-and-order#order).
|
|
255
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
259
256
|
#
|
|
260
257
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
261
258
|
# @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
|
|
@@ -271,12 +268,10 @@ module Google
|
|
|
271
268
|
# (retail-search-support@google.com) if you are interested in using dynamic
|
|
272
269
|
# facet feature.
|
|
273
270
|
# @param boost_spec [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash]
|
|
274
|
-
# Boost specification to boost certain products.
|
|
275
|
-
# [user guide](/retail/private/docs/boosting).
|
|
271
|
+
# Boost specification to boost certain products.
|
|
276
272
|
# @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
|
|
277
273
|
# The query expansion specification that specifies the conditions under which
|
|
278
|
-
# query expansion will occur.
|
|
279
|
-
# guide](/retail/private/docs/result-size#query_expansion).
|
|
274
|
+
# query expansion will occur.
|
|
280
275
|
# @param variant_rollup_keys [::Array<::String>]
|
|
281
276
|
# The keys to fetch and rollup the matching
|
|
282
277
|
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
|
|
@@ -87,8 +87,7 @@ module Google
|
|
|
87
87
|
# @return [::String]
|
|
88
88
|
# The filter syntax consists of an expression language for constructing a
|
|
89
89
|
# predicate from one or more fields of the products being filtered. Filter
|
|
90
|
-
# expression is case-sensitive.
|
|
91
|
-
# guide](/retail/private/docs/filter-and-order#filter).
|
|
90
|
+
# expression is case-sensitive.
|
|
92
91
|
#
|
|
93
92
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
94
93
|
# @!attribute [rw] canonical_filter
|
|
@@ -106,9 +105,7 @@ module Google
|
|
|
106
105
|
# @return [::String]
|
|
107
106
|
# The order in which products are returned. Products can be ordered by
|
|
108
107
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
|
109
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
110
|
-
# more details at this [user
|
|
111
|
-
# guide](/retail/private/docs/filter-and-order#order).
|
|
108
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
112
109
|
#
|
|
113
110
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
114
111
|
# @!attribute [rw] facet_specs
|
|
@@ -127,13 +124,11 @@ module Google
|
|
|
127
124
|
# facet feature.
|
|
128
125
|
# @!attribute [rw] boost_spec
|
|
129
126
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
|
|
130
|
-
# Boost specification to boost certain products.
|
|
131
|
-
# [user guide](/retail/private/docs/boosting).
|
|
127
|
+
# Boost specification to boost certain products.
|
|
132
128
|
# @!attribute [rw] query_expansion_spec
|
|
133
129
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
|
|
134
130
|
# The query expansion specification that specifies the conditions under which
|
|
135
|
-
# query expansion will occur.
|
|
136
|
-
# guide](/retail/private/docs/result-size#query_expansion).
|
|
131
|
+
# query expansion will occur.
|
|
137
132
|
# @!attribute [rw] variant_rollup_keys
|
|
138
133
|
# @return [::Array<::String>]
|
|
139
134
|
# The keys to fetch and rollup the matching
|
|
@@ -274,172 +269,35 @@ module Google
|
|
|
274
269
|
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#query FacetKey.query}
|
|
275
270
|
# is not specified:
|
|
276
271
|
#
|
|
277
|
-
#
|
|
278
|
-
#
|
|
279
|
-
#
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
#
|
|
288
|
-
#
|
|
289
|
-
#
|
|
290
|
-
#
|
|
291
|
-
#
|
|
292
|
-
#
|
|
293
|
-
#
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
#
|
|
299
|
-
# </font>
|
|
300
|
-
# | "ageGroups";
|
|
301
|
-
# <br>
|
|
302
|
-
# <font color='grey'>
|
|
303
|
-
# *# The
|
|
304
|
-
# {::Google::Cloud::Retail::V2::Product#availability Product.availability}.
|
|
305
|
-
# Value is one of<br>*
|
|
306
|
-
# *# "IN_STOCK", "OUT_OF_STOCK", PREORDER", "BACKORDER".<br>*
|
|
307
|
-
# </font>
|
|
308
|
-
# | "availability";
|
|
309
|
-
# <br>
|
|
310
|
-
# <font color='grey'>
|
|
311
|
-
# *# The
|
|
312
|
-
# {::Google::Cloud::Retail::V2::ColorInfo#color_families ColorInfo.color_families}.<br>*
|
|
313
|
-
# </font>
|
|
314
|
-
# | "colorFamilies";
|
|
315
|
-
# <br>
|
|
316
|
-
# <font color='grey'>
|
|
317
|
-
# *# The
|
|
318
|
-
# {::Google::Cloud::Retail::V2::ColorInfo#colors ColorInfo.colors}.<br>*
|
|
319
|
-
# </font>
|
|
320
|
-
# | "colors";
|
|
321
|
-
# <br>
|
|
322
|
-
# <font color='grey'>
|
|
323
|
-
# *# The {::Google::Cloud::Retail::V2::Product#sizes Product.sizes}.<br>*
|
|
324
|
-
# </font>
|
|
325
|
-
# | "sizes";
|
|
326
|
-
# <br>
|
|
327
|
-
# <font color='grey'>
|
|
328
|
-
# *# The
|
|
329
|
-
# {::Google::Cloud::Retail::V2::Product#materials Product.materials}.<br>*
|
|
330
|
-
# </font>
|
|
331
|
-
# | "materials";
|
|
332
|
-
# <br>
|
|
333
|
-
# <font color='grey'>
|
|
334
|
-
# *# The
|
|
335
|
-
# {::Google::Cloud::Retail::V2::Product#patterns Product.patterns}.<br>*
|
|
336
|
-
# </font>
|
|
337
|
-
# | "patterns";
|
|
338
|
-
# <br>
|
|
339
|
-
# <font color='grey'>
|
|
340
|
-
# *# The
|
|
341
|
-
# {::Google::Cloud::Retail::V2::Product#conditions Product.conditions}.<br>*
|
|
342
|
-
# </font>
|
|
343
|
-
# | "conditions";
|
|
344
|
-
# <br>
|
|
345
|
-
# <font color='grey'>
|
|
346
|
-
# *# The textual custom attribute in
|
|
347
|
-
# {::Google::Cloud::Retail::V2::Product Product} object. Key can<br>*
|
|
348
|
-
# *# be any key in the
|
|
349
|
-
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes}
|
|
350
|
-
# map<br>*
|
|
351
|
-
# *# if the attribute values are textual.<br>*
|
|
352
|
-
# *# map.<br>*
|
|
353
|
-
# </font>
|
|
354
|
-
# | "attributes.key";
|
|
355
|
-
# <br>
|
|
356
|
-
# <font color='grey'>
|
|
357
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
358
|
-
# *# [FulfillmentInfo.Type.PICKUP_IN_STORE][].<br>*
|
|
359
|
-
# </font>
|
|
360
|
-
# | "pickupInStore";
|
|
361
|
-
# <br>
|
|
362
|
-
# <font color='grey'>
|
|
363
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
364
|
-
# *# [FulfillmentInfo.Type.SHIP_TO_STORE][].<br>*
|
|
365
|
-
# </font>
|
|
366
|
-
# | "shipToStore";
|
|
367
|
-
# <br>
|
|
368
|
-
# <font color='grey'>
|
|
369
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
370
|
-
# *# [FulfillmentInfo.Type.SAME_DAY_DELIVERY][].<br>*
|
|
371
|
-
# </font>
|
|
372
|
-
# | "sameDayDelivery";
|
|
373
|
-
# <br>
|
|
374
|
-
# <font color='grey'>
|
|
375
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
376
|
-
# *# [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][].<br>*
|
|
377
|
-
# </font>
|
|
378
|
-
# | "nextDayDelivery";
|
|
379
|
-
# <br>
|
|
380
|
-
# <font color='grey'>
|
|
381
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
382
|
-
# *# [FulfillmentInfo.Type.CUSTOM_TYPE_1][].<br>*
|
|
383
|
-
# </font>
|
|
384
|
-
# | "customFulfillment1";
|
|
385
|
-
# <br>
|
|
386
|
-
# <font color='grey'>
|
|
387
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
388
|
-
# *# [FulfillmentInfo.Type.CUSTOM_TYPE_2][].<br>*
|
|
389
|
-
# </font>
|
|
390
|
-
# | "customFulfillment2";
|
|
391
|
-
# <br>
|
|
392
|
-
# <font color='grey'>
|
|
393
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
394
|
-
# *# [FulfillmentInfo.Type.CUSTOM_TYPE_3][].<br>*
|
|
395
|
-
# </font>
|
|
396
|
-
# | "customFulfillment3";
|
|
397
|
-
# <br>
|
|
398
|
-
# <font color='grey'>
|
|
399
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
400
|
-
# *# [FulfillmentInfo.Type.CUSTOM_TYPE_4][].<br>*
|
|
401
|
-
# </font>
|
|
402
|
-
# | "customFulfillment4";
|
|
403
|
-
# <br>
|
|
404
|
-
# <font color='grey'>
|
|
405
|
-
# *# The [FulfillmentInfo.ids][] for type
|
|
406
|
-
# *# [FulfillmentInfo.Type.CUSTOM_TYPE_5][].<br>*
|
|
407
|
-
# </font>
|
|
408
|
-
# | "customFulfillment5";
|
|
272
|
+
# Textual facet keys:
|
|
273
|
+
# * brands
|
|
274
|
+
# * categories
|
|
275
|
+
# * genders
|
|
276
|
+
# * ageGroups
|
|
277
|
+
# * availability
|
|
278
|
+
# * colorFamilies
|
|
279
|
+
# * colors
|
|
280
|
+
# * sizes
|
|
281
|
+
# * materials
|
|
282
|
+
# * patterns
|
|
283
|
+
# * conditions
|
|
284
|
+
# * attributes.key
|
|
285
|
+
# * pickupInStore
|
|
286
|
+
# * shipToStore
|
|
287
|
+
# * sameDayDelivery
|
|
288
|
+
# * nextDayDelivery
|
|
289
|
+
# * customFulfillment1
|
|
290
|
+
# * customFulfillment2
|
|
291
|
+
# * customFulfillment3
|
|
292
|
+
# * customFulfillment4
|
|
293
|
+
# * customFulfillment5
|
|
409
294
|
#
|
|
410
|
-
#
|
|
411
|
-
#
|
|
412
|
-
#
|
|
413
|
-
#
|
|
414
|
-
#
|
|
415
|
-
#
|
|
416
|
-
# <br>
|
|
417
|
-
# <font color='grey'>
|
|
418
|
-
# *# The discount. Computed by (original_price-price)/price <br>*
|
|
419
|
-
# </font>
|
|
420
|
-
# "discount";
|
|
421
|
-
# <br>
|
|
422
|
-
# <font color='grey'>
|
|
423
|
-
# *# The
|
|
424
|
-
# {::Google::Cloud::Retail::V2::Rating#average_rating Rating.average_rating}.<br>*
|
|
425
|
-
# </font>
|
|
426
|
-
# "rating";
|
|
427
|
-
# <br>
|
|
428
|
-
# <font color='grey'>
|
|
429
|
-
# *# The
|
|
430
|
-
# {::Google::Cloud::Retail::V2::Rating#rating_count Rating.rating_count}.<br>*
|
|
431
|
-
# </font>
|
|
432
|
-
# "ratingCount";
|
|
433
|
-
# <br>
|
|
434
|
-
# <font color='grey'>
|
|
435
|
-
# *# The numerical custom attribute in
|
|
436
|
-
# {::Google::Cloud::Retail::V2::Product Product} object. Key can<br>*
|
|
437
|
-
# *# be any key in the
|
|
438
|
-
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes}
|
|
439
|
-
# map<br>*
|
|
440
|
-
# *# if the attribute values are numerical.<br>*
|
|
441
|
-
# </font>
|
|
442
|
-
# | "attributes.key";
|
|
295
|
+
# Numeric facet keys:
|
|
296
|
+
# * price
|
|
297
|
+
# * discount
|
|
298
|
+
# * rating
|
|
299
|
+
# * ratingCount
|
|
300
|
+
# * attributes.key
|
|
443
301
|
# @!attribute [rw] intervals
|
|
444
302
|
# @return [::Array<::Google::Cloud::Retail::V2::Interval>]
|
|
445
303
|
# Set only if values should be bucketized into intervals. Must be set
|
|
@@ -579,11 +437,12 @@ module Google
|
|
|
579
437
|
# Examples:
|
|
580
438
|
#
|
|
581
439
|
# * To boost products with product ID "product_1" or "product_2", and
|
|
582
|
-
# color
|
|
583
|
-
#
|
|
584
|
-
#
|
|
585
|
-
#
|
|
586
|
-
#
|
|
440
|
+
# color "Red" or "Blue":
|
|
441
|
+
# ```
|
|
442
|
+
# (id: ANY("product_1", "product_2"))
|
|
443
|
+
# AND
|
|
444
|
+
# (colorFamilies: ANY("Red", "Blue"))
|
|
445
|
+
# ```
|
|
587
446
|
# @!attribute [rw] boost
|
|
588
447
|
# @return [::Float]
|
|
589
448
|
# Strength of the condition boost, which should be in [-1, 1]. Negative
|
|
@@ -735,21 +594,23 @@ module Google
|
|
|
735
594
|
# string or double values with type
|
|
736
595
|
# {::Google::Protobuf::ListValue google.protobuf.ListValue}. For example, if
|
|
737
596
|
# there are two variants with colors "red" and "blue", the rollup values
|
|
738
|
-
# are
|
|
739
|
-
#
|
|
740
|
-
#
|
|
741
|
-
#
|
|
742
|
-
#
|
|
743
|
-
#
|
|
744
|
-
#
|
|
745
|
-
#
|
|
597
|
+
# are
|
|
598
|
+
#
|
|
599
|
+
# { key: "colorFamilies"
|
|
600
|
+
# value {
|
|
601
|
+
# list_value {
|
|
602
|
+
# values { string_value: "red" }
|
|
603
|
+
# values { string_value: "blue" }
|
|
604
|
+
# }
|
|
605
|
+
# }
|
|
606
|
+
# }
|
|
746
607
|
#
|
|
747
608
|
# For
|
|
748
609
|
# {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info},
|
|
749
610
|
# the rollup values is a double value with type
|
|
750
|
-
# {::Google::Protobuf::Value google.protobuf.Value}. For example
|
|
751
|
-
# "pickupInStore.store1" value { number_value: 10 }} means a there
|
|
752
|
-
# variants in this product are available in the store "store1".
|
|
611
|
+
# {::Google::Protobuf::Value google.protobuf.Value}. For example:
|
|
612
|
+
# `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
|
|
613
|
+
# are 10 variants in this product are available in the store "store1".
|
|
753
614
|
class SearchResult
|
|
754
615
|
include ::Google::Protobuf::MessageExts
|
|
755
616
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
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.
|
|
4
|
+
version: 0.4.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-08-05 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|