Reference documentation and code samples for the Google Cloud Ces V1 Client class ConditionBoostSpec.
Boost specification for a condition.
Generated from protobuf message google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec
Namespace
Google \ Cloud \ Ces \ V1 \ DataStoreTool \ BoostSpecMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ condition |
string
Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr")) |
↳ boost |
float
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
↳ boost_control_spec |
ConditionBoostSpec\BoostControlSpec
Optional. Complex specification for custom ranking based on customer defined attribute value. |
getCondition
Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
| Returns | |
|---|---|
| Type | Description |
string |
|
setCondition
Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoost
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
| Returns | |
|---|---|
| Type | Description |
float |
|
setBoost
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoostControlSpec
Optional. Complex specification for custom ranking based on customer defined attribute value.
| Returns | |
|---|---|
| Type | Description |
ConditionBoostSpec\BoostControlSpec|null |
|
hasBoostControlSpec
clearBoostControlSpec
setBoostControlSpec
Optional. Complex specification for custom ranking based on customer defined attribute value.
| Parameter | |
|---|---|
| Name | Description |
var |
ConditionBoostSpec\BoostControlSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|