@@ -294,67 +294,37 @@ class FacetKey(proto.Message):
294
294
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
295
295
is not specified:
296
296
297
- - textual_field = *# The
298
- [Product.brands][google.cloud.retail.v2.Product.brands].*
299
- "brands"; *# The
300
- [Product.categories][google.cloud.retail.v2.Product.categories].*
301
- "categories"; *# The
302
- [Audience.genders][google.cloud.retail.v2.Audience.genders].*
303
- \| "genders"; *# The
304
- [Audience.age_groups][google.cloud.retail.v2.Audience.age_groups].*
305
- \| "ageGroups"; *# The
306
- [Product.availability][google.cloud.retail.v2.Product.availability].
307
- Value is one of* *# "IN_STOCK", "OUT_OF_STOCK",
308
- PREORDER", "BACKORDER".* \| "availability"; *# The
309
- [ColorInfo.color_families][google.cloud.retail.v2.ColorInfo.color_families].*
310
- \| "colorFamilies"; *# The
311
- [ColorInfo.colors][google.cloud.retail.v2.ColorInfo.colors].*
312
- \| "colors"; *# The
313
- [Product.sizes][google.cloud.retail.v2.Product.sizes].*
314
- \| "sizes"; *# The
315
- [Product.materials][google.cloud.retail.v2.Product.materials].*
316
- \| "materials"; *# The
317
- [Product.patterns][google.cloud.retail.v2.Product.patterns].*
318
- \| "patterns"; *# The
319
- [Product.conditions][google.cloud.retail.v2.Product.conditions].*
320
- \| "conditions"; *# The textual custom attribute in
321
- [Product][google.cloud.retail.v2.Product] object. Key
322
- can* *# be any key in the
323
- [Product.attributes][google.cloud.retail.v2.Product.attributes]
324
- map* *# if the attribute values are textual.* *# map.* \|
325
- "attributes.key"; \*# The [FulfillmentInfo.ids][] for
326
- type *# [FulfillmentInfo.Type.PICKUP_IN_STORE][].* \|
327
- "pickupInStore"; \*# The [FulfillmentInfo.ids][] for type
328
- *# [FulfillmentInfo.Type.SHIP_TO_STORE][].* \|
329
- "shipToStore"; \*# The [FulfillmentInfo.ids][] for type
330
- *# [FulfillmentInfo.Type.SAME_DAY_DELIVERY][].* \|
331
- "sameDayDelivery"; \*# The [FulfillmentInfo.ids][] for
332
- type *# [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][].* \|
333
- "nextDayDelivery"; \*# The [FulfillmentInfo.ids][] for
334
- type *# [FulfillmentInfo.Type.CUSTOM_TYPE_1][].* \|
335
- "customFulfillment1"; \*# The [FulfillmentInfo.ids][] for
336
- type *# [FulfillmentInfo.Type.CUSTOM_TYPE_2][].* \|
337
- "customFulfillment2"; \*# The [FulfillmentInfo.ids][] for
338
- type *# [FulfillmentInfo.Type.CUSTOM_TYPE_3][].* \|
339
- "customFulfillment3"; \*# The [FulfillmentInfo.ids][] for
340
- type *# [FulfillmentInfo.Type.CUSTOM_TYPE_4][].* \|
341
- "customFulfillment4"; \*# The [FulfillmentInfo.ids][] for
342
- type *# [FulfillmentInfo.Type.CUSTOM_TYPE_5][].* \|
343
- "customFulfillment5";
344
-
345
- - numerical_field = *# The
346
- [PriceInfo.price][google.cloud.retail.v2.PriceInfo.price].*
347
- "price"; *# The discount. Computed by
348
- (original_price-price)/price * "discount"; *# The
349
- [Rating.average_rating][google.cloud.retail.v2.Rating.average_rating].*
350
- "rating"; *# The
351
- [Rating.rating_count][google.cloud.retail.v2.Rating.rating_count].*
352
- "ratingCount"; *# The numerical custom attribute in
353
- [Product][google.cloud.retail.v2.Product] object. Key
354
- can* *# be any key in the
355
- [Product.attributes][google.cloud.retail.v2.Product.attributes]
356
- map* *# if the attribute values are numerical.* \|
357
- "attributes.key";
297
+ Textual facet keys:
298
+
299
+ - brands
300
+ - categories
301
+ - genders
302
+ - ageGroups
303
+ - availability
304
+ - colorFamilies
305
+ - colors
306
+ - sizes
307
+ - materials
308
+ - patterns
309
+ - conditions
310
+ - attributes.key
311
+ - pickupInStore
312
+ - shipToStore
313
+ - sameDayDelivery
314
+ - nextDayDelivery
315
+ - customFulfillment1
316
+ - customFulfillment2
317
+ - customFulfillment3
318
+ - customFulfillment4
319
+ - customFulfillment5
320
+
321
+ Numeric facet keys:
322
+
323
+ - price
324
+ - discount
325
+ - rating
326
+ - ratingCount
327
+ - attributes.key
358
328
intervals (Sequence[google.cloud.retail_v2.types.Interval]):
359
329
Set only if values should be bucketized into
360
330
intervals. Must be set for facets with numerical
@@ -507,9 +477,12 @@ class ConditionBoostSpec(proto.Message):
507
477
Examples:
508
478
509
479
- To boost products with product ID "product_1" or
510
- "product_2", and color "Red" or "Blue": *(id:
511
- ANY("product_1", "product_2"))* *AND* *(colorFamilies:
512
- ANY("Red", "Blue"))*
480
+ "product_2", and color "Red" or "Blue":
481
+ ::
482
+
483
+ (id: ANY("product_1", "product_2"))
484
+ AND
485
+ (colorFamilies: ANY("Red", "Blue"))
513
486
boost (float):
514
487
Strength of the condition boost, which should be in [-1, 1].
515
488
Negative boost means demotion. Default is 0.0.
0 commit comments