Interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder (0.50.0)

public static interface AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoost()

public abstract float 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.

float boost = 2;

Returns
Type Description
float

The boost.

getCondition()

public abstract String 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 en or fr: (lang_code: ANY("en", "fr"))

string condition = 1;

Returns
Type Description
String

The condition.

getConditionBytes()

public abstract ByteString getConditionBytes()

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;

Returns
Type Description
ByteString

The bytes for condition.