Class ConditionBoostSpec (2.5.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
ConditionBoostSpec ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
Boost applies to products which match a condition.
Attributes
Name
Description
condition
str
An expression which specifies a boost condition. The syntax
and supported fields are the same as a filter expression.
See
SearchRequest.filter
for detail syntax and limitations.
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"))
boost
float
Strength of the condition boost, which should be in [-1, 1].
Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the item a big promotion. However, it
does not necessarily mean that the boosted item will be the
top result at all times, nor that other items will be
excluded. Results could still be shown even when none of
them matches the condition. And results that are
significantly more relevant to the search query can still
trump your heavily favored but irrelevant items.
Setting to -1.0 gives the item a big demotion. However,
results that are deeply relevant might still be shown. The
item will have an upstream battle to get a fairly high
ranking, but it is not blocked out completely.
Setting to 0.0 means no boost applied. The boosting
condition is ignored.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class ConditionBoostSpec (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/python/docs/reference/retail/latest/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [2.4.0](/python/docs/reference/retail/2.4.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [2.3.0](/python/docs/reference/retail/2.3.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [2.2.0](/python/docs/reference/retail/2.2.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [2.1.0](/python/docs/reference/retail/2.1.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [2.0.0](/python/docs/reference/retail/2.0.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.25.0](/python/docs/reference/retail/1.25.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.24.0](/python/docs/reference/retail/1.24.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.23.1](/python/docs/reference/retail/1.23.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.22.0](/python/docs/reference/retail/1.22.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.21.2](/python/docs/reference/retail/1.21.2/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.20.1](/python/docs/reference/retail/1.20.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.19.1](/python/docs/reference/retail/1.19.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.18.0](/python/docs/reference/retail/1.18.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.17.0](/python/docs/reference/retail/1.17.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.16.3](/python/docs/reference/retail/1.16.3/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.15.1](/python/docs/reference/retail/1.15.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.14.1](/python/docs/reference/retail/1.14.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.13.0](/python/docs/reference/retail/1.13.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.12.0](/python/docs/reference/retail/1.12.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.11.0](/python/docs/reference/retail/1.11.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.10.2](/python/docs/reference/retail/1.10.2/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.9.0](/python/docs/reference/retail/1.9.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.8.1](/python/docs/reference/retail/1.8.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.7.0](/python/docs/reference/retail/1.7.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.6.1](/python/docs/reference/retail/1.6.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.5.0](/python/docs/reference/retail/1.5.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.4.1](/python/docs/reference/retail/1.4.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.3.0](/python/docs/reference/retail/1.3.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.2.1](/python/docs/reference/retail/1.2.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.1.0](/python/docs/reference/retail/1.1.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [1.0.2](/python/docs/reference/retail/1.0.2/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [0.4.2](/python/docs/reference/retail/0.4.2/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [0.3.1](/python/docs/reference/retail/0.3.1/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [0.2.0](/python/docs/reference/retail/0.2.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec)\n- [0.1.0](/python/docs/reference/retail/0.1.0/google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec) \n\n ConditionBoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nBoost applies to products which match a condition."]]