Strength of the condition boost, which must 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.
The filter can have a max size of 5000 characters.
An expression which specifies which products to apply an action to.
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":<br>
(id: ANY("product_1", "product_2"))<br>AND<br>(colorFamilies: ANY("Red", "Blue"))<br>
The filter can have a max size of 5000 characters.
An expression which specifies which products to apply an action to.
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":<br>
(id: ANY("product_1", "product_2"))<br>AND<br>(colorFamilies: ANY("Red", "Blue"))<br>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Interface Rule.BoostActionOrBuilder (2.74.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.74.0 (latest)](/java/docs/reference/google-cloud-retail/latest/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.72.0](/java/docs/reference/google-cloud-retail/2.72.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.70.0](/java/docs/reference/google-cloud-retail/2.70.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.69.0](/java/docs/reference/google-cloud-retail/2.69.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.66.0](/java/docs/reference/google-cloud-retail/2.66.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.65.0](/java/docs/reference/google-cloud-retail/2.65.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.64.0](/java/docs/reference/google-cloud-retail/2.64.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.62.0](/java/docs/reference/google-cloud-retail/2.62.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.61.0](/java/docs/reference/google-cloud-retail/2.61.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.60.0](/java/docs/reference/google-cloud-retail/2.60.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.59.0](/java/docs/reference/google-cloud-retail/2.59.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.58.0](/java/docs/reference/google-cloud-retail/2.58.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.57.0](/java/docs/reference/google-cloud-retail/2.57.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.56.0](/java/docs/reference/google-cloud-retail/2.56.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.55.0](/java/docs/reference/google-cloud-retail/2.55.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.54.0](/java/docs/reference/google-cloud-retail/2.54.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.53.0](/java/docs/reference/google-cloud-retail/2.53.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.51.0](/java/docs/reference/google-cloud-retail/2.51.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.50.0](/java/docs/reference/google-cloud-retail/2.50.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.49.0](/java/docs/reference/google-cloud-retail/2.49.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.48.0](/java/docs/reference/google-cloud-retail/2.48.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.47.0](/java/docs/reference/google-cloud-retail/2.47.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.46.0](/java/docs/reference/google-cloud-retail/2.46.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.45.0](/java/docs/reference/google-cloud-retail/2.45.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.44.0](/java/docs/reference/google-cloud-retail/2.44.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.43.0](/java/docs/reference/google-cloud-retail/2.43.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.42.0](/java/docs/reference/google-cloud-retail/2.42.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.41.0](/java/docs/reference/google-cloud-retail/2.41.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.39.0](/java/docs/reference/google-cloud-retail/2.39.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.38.0](/java/docs/reference/google-cloud-retail/2.38.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.37.0](/java/docs/reference/google-cloud-retail/2.37.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.36.0](/java/docs/reference/google-cloud-retail/2.36.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.35.0](/java/docs/reference/google-cloud-retail/2.35.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.34.0](/java/docs/reference/google-cloud-retail/2.34.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.33.0](/java/docs/reference/google-cloud-retail/2.33.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.32.0](/java/docs/reference/google-cloud-retail/2.32.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.31.0](/java/docs/reference/google-cloud-retail/2.31.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.30.0](/java/docs/reference/google-cloud-retail/2.30.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.29.0](/java/docs/reference/google-cloud-retail/2.29.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.26.0](/java/docs/reference/google-cloud-retail/2.26.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.25.0](/java/docs/reference/google-cloud-retail/2.25.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.24.0](/java/docs/reference/google-cloud-retail/2.24.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-retail/2.23.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.22.0](/java/docs/reference/google-cloud-retail/2.22.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.21.0](/java/docs/reference/google-cloud-retail/2.21.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.20.0](/java/docs/reference/google-cloud-retail/2.20.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.19.0](/java/docs/reference/google-cloud-retail/2.19.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.18.0](/java/docs/reference/google-cloud-retail/2.18.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.17.0](/java/docs/reference/google-cloud-retail/2.17.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.16.0](/java/docs/reference/google-cloud-retail/2.16.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.15.0](/java/docs/reference/google-cloud-retail/2.15.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.14.0](/java/docs/reference/google-cloud-retail/2.14.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.13.0](/java/docs/reference/google-cloud-retail/2.13.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.11.0](/java/docs/reference/google-cloud-retail/2.11.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.10.0](/java/docs/reference/google-cloud-retail/2.10.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.9.0](/java/docs/reference/google-cloud-retail/2.9.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.8.0](/java/docs/reference/google-cloud-retail/2.8.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.7.0](/java/docs/reference/google-cloud-retail/2.7.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.6.0](/java/docs/reference/google-cloud-retail/2.6.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.5.1](/java/docs/reference/google-cloud-retail/2.5.1/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.4.0](/java/docs/reference/google-cloud-retail/2.4.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.3.0](/java/docs/reference/google-cloud-retail/2.3.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.2.3](/java/docs/reference/google-cloud-retail/2.2.3/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.1.0](/java/docs/reference/google-cloud-retail/2.1.0/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder)\n- [2.0.19](/java/docs/reference/google-cloud-retail/2.0.19/com.google.cloud.retail.v2beta.Rule.BoostActionOrBuilder) \n\n public static interface Rule.BoostActionOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getBoost()\n\n public abstract float getBoost()\n\nStrength of the condition boost, which must be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0.\n\nSetting to 1.0 gives the item a big promotion. However, it does not\nnecessarily mean that the boosted item will be the top result at all\ntimes, nor that other items will be excluded. Results could still be\nshown even when none of them matches the condition. And results that\nare significantly more relevant to the search query can still trump\nyour heavily favored but irrelevant items.\n\nSetting to -1.0 gives the item a big demotion. However, results that\nare deeply relevant might still be shown. The item will have an\nupstream battle to get a fairly high ranking, but it is not blocked out\ncompletely.\n\nSetting to 0.0 means no boost applied. The boosting condition is\nignored.\n\n`float boost = 1;`\n\n### getProductsFilter()\n\n public abstract String getProductsFilter()\n\nThe filter can have a max size of 5000 characters.\nAn expression which specifies which products to apply an action to.\nThe syntax and supported fields are the same as a filter expression. See\nSearchRequest.filter\nfor detail syntax and limitations.\n\nExamples:\n\n- To boost products with product ID \"product_1\" or \"product_2\", and color \"Red\" or \"Blue\":\\\u003cbr\\\u003e *(id: ANY(\"product_1\", \"product_2\"))\\\u003cbr\\\u003e* *AND\\\u003cbr\\\u003e* *(colorFamilies: ANY(\"Red\", \"Blue\"))\\\u003cbr\\\u003e*\n\n`string products_filter = 2;`\n\n### getProductsFilterBytes()\n\n public abstract ByteString getProductsFilterBytes()\n\nThe filter can have a max size of 5000 characters.\nAn expression which specifies which products to apply an action to.\nThe syntax and supported fields are the same as a filter expression. See\nSearchRequest.filter\nfor detail syntax and limitations.\n\nExamples:\n\n- To boost products with product ID \"product_1\" or \"product_2\", and color \"Red\" or \"Blue\":\\\u003cbr\\\u003e *(id: ANY(\"product_1\", \"product_2\"))\\\u003cbr\\\u003e* *AND\\\u003cbr\\\u003e* *(colorFamilies: ANY(\"Red\", \"Blue\"))\\\u003cbr\\\u003e*\n\n`string products_filter = 2;`"]]