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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ boost |
float
Required. 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 |
getBoost
Required. 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
Required. 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 |
|