Reference documentation and code samples for the Google Cloud Retail V2 Client class BoostAction.
A boost action to apply to results matching condition specified above.
Generated from protobuf message google.cloud.retail.v2.Rule.BoostAction
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ boost |
float
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. |
↳ products_filter |
string
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": |
getBoost
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.
Generated from protobuf field float boost = 1;
| Returns | |
|---|---|
| Type | Description |
float | |
setBoost
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.
Generated from protobuf field float boost = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProductsFilter
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":
(id: ANY("product_1", "product_2"))
AND
(colorFamilies: ANY("Red", "Blue"))
Generated from protobuf field string products_filter = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setProductsFilter
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":
(id: ANY("product_1", "product_2"))
AND
(colorFamilies: ANY("Red", "Blue"))
Generated from protobuf field string products_filter = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |