public static final class SearchRequest.BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilderBoost applies to documents which match a condition.
Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.BoostSpec.ConditionBoostSpec.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
build()
public SearchRequest.BoostSpec.ConditionBoostSpec build()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
buildPartial()
public SearchRequest.BoostSpec.ConditionBoostSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
clear()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
clearBoost()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()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 |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
clearBoostControlSpec()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoostControlSpec()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.Builder |
|
clearCondition()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()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 |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
clone()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
getBoost()
public 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 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. |
getBoostControlSpecBuilder()
public SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder getBoostControlSpecBuilder()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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder |
|
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()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequest.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
setBoost(float value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe boost to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec value)Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoostControlSpec(SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder builderForValue)Complex specification for custom ranking based on customer defined attribute value.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
setCondition(String value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
setConditionBytes(ByteString value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for condition to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|