public static final class SearchRequest.BoostSpec.ConditionBoostSpec extends GeneratedMessageV3 implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
Boost applies to documents which match a condition.
Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOOST_CONTROL_SPEC_FIELD_NUMBER
public static final int BOOST_CONTROL_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BOOST_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder()
newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec prototype)
public static SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec prototype)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchRequest.BoostSpec.ConditionBoostSpec> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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 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;
getBoostControlSpecOrBuilder()
public 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;
getCondition()
public 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 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.
|
getDefaultInstanceForType()
public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
getParserForType()
public Parser<SearchRequest.BoostSpec.ConditionBoostSpec> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasBoostControlSpec()
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
