com.google.cloud.discoveryengine.v1

Interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.BoostSpec.ConditionBoostSpec, SearchRequest.BoostSpec.ConditionBoostSpec.Builder

Enclosing class:

SearchRequest.BoostSpec

public static interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
float	getBoost() Strength of the condition boost, which should be in [-1, 1].
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	getBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder	getBoostControlSpecOrBuilder() Complex specification for custom ranking based on customer defined attribute value.
String	getCondition() An expression which specifies a boost condition.
com.google.protobuf.ByteString	getConditionBytes() An expression which specifies a boost condition.
boolean	hasBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCondition

String getCondition()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1.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:

The condition.

getConditionBytes

com.google.protobuf.ByteString getConditionBytes()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1.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:

The bytes for condition.

getBoost

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:

The boost.

hasBoostControlSpec

boolean hasBoostControlSpec()

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

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

Returns:

Whether the boostControlSpec field is set.

getBoostControlSpec

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

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

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

Returns:

The boostControlSpec.

getBoostControlSpecOrBuilder

SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

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

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