Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

Commit

Permalink
docs: Remove HTML tags from Cloud Retail API library docs (#73)
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 387885619

Source-Link: googleapis/googleapis@2f9af29

Source-Link: googleapis/googleapis-gen@2d0b4b4
  • Loading branch information
gcf-owl-bot[bot] committed Aug 1, 2021
1 parent e2ca897 commit 00e0a53
Showing 1 changed file with 37 additions and 64 deletions.
101 changes: 37 additions & 64 deletions google/cloud/retail_v2/types/search_service.py
Expand Up @@ -294,67 +294,37 @@ class FacetKey(proto.Message):
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is not specified:
- textual_field = *# The
[Product.brands][google.cloud.retail.v2.Product.brands].*
"brands"; *# The
[Product.categories][google.cloud.retail.v2.Product.categories].*
"categories"; *# The
[Audience.genders][google.cloud.retail.v2.Audience.genders].*
\| "genders"; *# The
[Audience.age_groups][google.cloud.retail.v2.Audience.age_groups].*
\| "ageGroups"; *# The
[Product.availability][google.cloud.retail.v2.Product.availability].
Value is one of* *# "IN_STOCK", "OUT_OF_STOCK",
PREORDER", "BACKORDER".* \| "availability"; *# The
[ColorInfo.color_families][google.cloud.retail.v2.ColorInfo.color_families].*
\| "colorFamilies"; *# The
[ColorInfo.colors][google.cloud.retail.v2.ColorInfo.colors].*
\| "colors"; *# The
[Product.sizes][google.cloud.retail.v2.Product.sizes].*
\| "sizes"; *# The
[Product.materials][google.cloud.retail.v2.Product.materials].*
\| "materials"; *# The
[Product.patterns][google.cloud.retail.v2.Product.patterns].*
\| "patterns"; *# The
[Product.conditions][google.cloud.retail.v2.Product.conditions].*
\| "conditions"; *# The textual custom attribute in
[Product][google.cloud.retail.v2.Product] object. Key
can* *# be any key in the
[Product.attributes][google.cloud.retail.v2.Product.attributes]
map* *# if the attribute values are textual.* *# map.* \|
"attributes.key"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.PICKUP_IN_STORE][].* \|
"pickupInStore"; \*# The [FulfillmentInfo.ids][] for type
*# [FulfillmentInfo.Type.SHIP_TO_STORE][].* \|
"shipToStore"; \*# The [FulfillmentInfo.ids][] for type
*# [FulfillmentInfo.Type.SAME_DAY_DELIVERY][].* \|
"sameDayDelivery"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][].* \|
"nextDayDelivery"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.CUSTOM_TYPE_1][].* \|
"customFulfillment1"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.CUSTOM_TYPE_2][].* \|
"customFulfillment2"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.CUSTOM_TYPE_3][].* \|
"customFulfillment3"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.CUSTOM_TYPE_4][].* \|
"customFulfillment4"; \*# The [FulfillmentInfo.ids][] for
type *# [FulfillmentInfo.Type.CUSTOM_TYPE_5][].* \|
"customFulfillment5";
- numerical_field = *# The
[PriceInfo.price][google.cloud.retail.v2.PriceInfo.price].*
"price"; *# The discount. Computed by
(original_price-price)/price * "discount"; *# The
[Rating.average_rating][google.cloud.retail.v2.Rating.average_rating].*
"rating"; *# The
[Rating.rating_count][google.cloud.retail.v2.Rating.rating_count].*
"ratingCount"; *# The numerical custom attribute in
[Product][google.cloud.retail.v2.Product] object. Key
can* *# be any key in the
[Product.attributes][google.cloud.retail.v2.Product.attributes]
map* *# if the attribute values are numerical.* \|
"attributes.key";
Textual facet keys:
- brands
- categories
- genders
- ageGroups
- availability
- colorFamilies
- colors
- sizes
- materials
- patterns
- conditions
- attributes.key
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
Numeric facet keys:
- price
- discount
- rating
- ratingCount
- attributes.key
intervals (Sequence[google.cloud.retail_v2.types.Interval]):
Set only if values should be bucketized into
intervals. Must be set for facets with numerical
Expand Down Expand Up @@ -507,9 +477,12 @@ class ConditionBoostSpec(proto.Message):
Examples:
- To boost products with product ID "product_1" or
"product_2", and color "Red" or "Blue": *(id:
ANY("product_1", "product_2"))* *AND* *(colorFamilies:
ANY("Red", "Blue"))*
"product_2", and color "Red" or "Blue":
::
(id: ANY("product_1", "product_2"))
AND
(colorFamilies: ANY("Red", "Blue"))
boost (float):
Strength of the condition boost, which should be in [-1, 1].
Negative boost means demotion. Default is 0.0.
Expand Down

0 comments on commit 00e0a53

Please sign in to comment.