com.google.cloud.discoveryengine.v1beta

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].
String	getCondition() An expression which specifies a boost condition.
com.google.protobuf.ByteString	getConditionBytes() An expression which specifies a boost condition.

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.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
   "Red" or "Blue":
     * (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.v1beta.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost documents with document ID "doc_1" or "doc_2", and
 color
   "Red" or "Blue":
     * (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.
 

float boost = 2;

Returns:

The boost.