Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ConditionBoostSpec.
Boost applies to suggestions which match a condition.
Generated from protobuf message google.cloud.discoveryengine.v1.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ AdvancedCompleteQueryRequest \ BoostSpecMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ condition |
string
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 |
↳ boost |
float
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. |
getCondition
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
enorfr:(lang_code: ANY("en", "fr"))
| Returns | |
|---|---|
| Type | Description |
string |
|
setCondition
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
enorfr:(lang_code: ANY("en", "fr"))
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoost
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
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 |
|