Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class BoostAction.
Adjusts order of products in returned list.
Generated from protobuf message google.cloud.discoveryengine.v1.Control.BoostAction
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ ControlMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ fixed_boost
float
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
↳ interpolation_boost_spec
BoostAction\InterpolationBoostSpec
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-order Maximum 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).
float
hasFixedBoost
setFixedBoost
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
var
float
$this
getInterpolationBoostSpec
Optional. Complex specification for custom ranking based on customer defined attribute value.
hasInterpolationBoostSpec
setInterpolationBoostSpec
Optional. Complex specification for custom ranking based on customer defined attribute value.
$this
getBoost
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
float
setBoost
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
var
float
$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-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
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-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
var
string
$this
getDataStore
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
string
setDataStore
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
var
string
$this
getBoostSpec
string
