Interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder (0.44.0)

Version 0.44.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoost()

public abstract float getBoost()

Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents 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 documents.

Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document 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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

float boost = 2;

Returns
Type	Description
float	The boost.

getBoostControlSpec()

public abstract SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	The boostControlSpec.

getBoostControlSpecOrBuilder()

public abstract SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

Returns
Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

getCondition()

public abstract String getCondition()

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

• To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

string condition = 1;

Returns
Type	Description
String	The condition.

getConditionBytes()

public abstract ByteString getConditionBytes()

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

• To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

string condition = 1;

Returns
Type	Description
ByteString	The bytes for condition.

hasBoostControlSpec()

public abstract boolean hasBoostControlSpec()

Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;

Returns
Type	Description
boolean	Whether the boostControlSpec field is set.