Google Cloud Discovery Engine V1 Client - Class BoostAction (1.5.0)

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 \ Control

Methods

__construct

Constructor.

Parameters
Name Description
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).

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.

Returns
Type Description
BoostAction\InterpolationBoostSpec|null

hasInterpolationBoostSpec

setInterpolationBoostSpec

Optional. Complex specification for custom ranking based on customer defined attribute value.

Parameter
Name Description
var BoostAction\InterpolationBoostSpec
Returns
Type Description
$this

getBoost

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-order Maximum 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-order Maximum 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.

projects/123/locations/global/collections/default_collection/dataStores/default_data_store

Returns
Type Description
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

Parameter
Name Description
var string
Returns
Type Description
$this

getBoostSpec

Returns
Type Description
string