public static interface DataStoreTool.BoostSpec.ConditionBoostSpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBoost()
public abstract float 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.
float boost = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The boost. |
getBoostControlSpec()
public abstract DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec |
The boostControlSpec. |
getBoostControlSpecOrBuilder()
public abstract DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder |
|
getCondition()
public abstract String 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"))
string condition = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The condition. |
getConditionBytes()
public abstract ByteString getConditionBytes()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"))
string condition = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for condition. |
hasBoostControlSpec()
public abstract boolean hasBoostControlSpec()Optional. Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the boostControlSpec field is set. |