Optional. Complex specification for custom ranking based on customer defined attribute value.
↳ boost
float
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
↳ filter
string
Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation:https://cloud.google.com/retail/docs/filter-and-orderMaximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
↳ data_store
string
Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
getFixedBoost
Optional. Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
Returns
Type
Description
float
hasFixedBoost
setFixedBoost
Optional. Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getInterpolationBoostSpec
Optional. Complex specification for custom ranking based on customer
defined attribute value.
Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
Returns
Type
Description
float
setBoost
Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getFilter
Required. Specifies which products to apply the boost to.
If no filter is provided all products will be boosted (No-op).
Syntax documentation:https://cloud.google.com/retail/docs/filter-and-orderMaximum length is 5000 characters.
Otherwise an INVALID ARGUMENT error is thrown.
Returns
Type
Description
string
setFilter
Required. Specifies which products to apply the boost to.
If no filter is provided all products will be boosted (No-op).
Syntax documentation:https://cloud.google.com/retail/docs/filter-and-orderMaximum length is 5000 characters.
Otherwise an INVALID ARGUMENT error is thrown.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDataStore
Required. Specifies which data store's documents can be boosted by this
control. Full data store name e.g.
[[["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,["# Google Cloud Discovery Engine V1 Client - Class BoostAction (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.Control.BoostAction)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.Control.BoostAction)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.Control.BoostAction)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.Control.BoostAction)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.Control.BoostAction)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.Control.BoostAction)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.Control.BoostAction)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.Control.BoostAction)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.Control.BoostAction)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.Control.BoostAction)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.Control.BoostAction)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.Control.BoostAction)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.Control.BoostAction)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.Control.BoostAction)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.Control.BoostAction)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.Control.BoostAction)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.Control.BoostAction) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class BoostAction.\n\nAdjusts order of products in returned list.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.Control.BoostAction`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ Control\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFixedBoost\n\nOptional. Strength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### hasFixedBoost\n\n### setFixedBoost\n\nOptional. Strength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### getInterpolationBoostSpec\n\nOptional. Complex specification for custom ranking based on customer\ndefined attribute value.\n\n### hasInterpolationBoostSpec\n\n### setInterpolationBoostSpec\n\nOptional. Complex specification for custom ranking based on customer\ndefined attribute value.\n\n### getBoost\n\nStrength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### setBoost\n\nStrength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### getFilter\n\nRequired. Specifies which products to apply the boost to.\n\nIf no filter is provided all products will be boosted (No-op).\nSyntax documentation:\n\u003chttps://cloud.google.com/retail/docs/filter-and-order\u003e\nMaximum length is 5000 characters.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### setFilter\n\nRequired. Specifies which products to apply the boost to.\n\nIf no filter is provided all products will be boosted (No-op).\nSyntax documentation:\n\u003chttps://cloud.google.com/retail/docs/filter-and-order\u003e\nMaximum length is 5000 characters.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### getDataStore\n\nRequired. Specifies which data store's documents can be boosted by this\ncontrol. Full data store name e.g.\n\nprojects/123/locations/global/collections/default_collection/dataStores/default_data_store\n\n### setDataStore\n\nRequired. Specifies which data store's documents can be boosted by this\ncontrol. Full data store name e.g.\n\nprojects/123/locations/global/collections/default_collection/dataStores/default_data_store\n\n### getBoostSpec"]]
