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

docs: Remove HTML tags from Cloud Retail API library docs #73

Merged
merged 3 commits into from
Aug 1, 2021
Merged

docs: Remove HTML tags from Cloud Retail API library docs #73

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0bab4e
docs: Remove HTML tags from Cloud Retail API library docs
gcf-owl-bot[bot] Jul 30, 2021
234dae9
🦉 Updates from OwlBot
gcf-owl-bot[bot] Jul 30, 2021
a83fc95
Merge branch 'master' into owl-bot-bdd1a43e-9247-422f-be74-1dfe14790115
parthea Aug 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 44 additions & 75 deletions google/cloud/retail_v2/types/search_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ class SearchRequest(proto.Message):
The filter syntax consists of an expression language for
constructing a predicate from one or more fields of the
products being filtered. Filter expression is
case-sensitive. See more details at this `user
guide </retail/private/docs/filter-and-order#filter>`__.
case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
Expand All @@ -117,8 +116,7 @@ class SearchRequest(proto.Message):
ordered by a field in an
[Product][google.cloud.retail.v2.Product] object. Leave it
unset if ordered by relevance. OrderBy expression is
case-sensitive. See more details at this `user
guide </retail/private/docs/filter-and-order#order>`__.
case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
Expand All @@ -137,14 +135,12 @@ class SearchRequest(proto.Message):
support@google.com) if you are interested in
using dynamic facet feature.
boost_spec (google.cloud.retail_v2.types.SearchRequest.BoostSpec):
Boost specification to boost certain products. See more
details at this `user
guide </retail/private/docs/boosting>`__.
Boost specification to boost certain
products.
query_expansion_spec (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec):
The query expansion specification that specifies the
conditions under which query expansion will occur. See more
details at this `user
guide </retail/private/docs/result-size#query_expansion>`__.
The query expansion specification that
specifies the conditions under which query
expansion will occur.
variant_rollup_keys (Sequence[str]):
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
Expand Down Expand Up @@ -298,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 @@ -511,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