public static final class BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessageV3.Builder<BoostSpec.ConditionBoostSpec.Builder> implements BoostSpec.ConditionBoostSpecOrBuilder
Boost applies to documents which match a condition.
Protobuf type google.cloud.dialogflow.cx.v3beta1.BoostSpec.ConditionBoostSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public BoostSpec.ConditionBoostSpec build()
buildPartial()
public BoostSpec.ConditionBoostSpec buildPartial()
clear()
public BoostSpec.ConditionBoostSpec.Builder clear()
Overrides
clearBoost()
public BoostSpec.ConditionBoostSpec.Builder clearBoost()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
clearCondition()
public BoostSpec.ConditionBoostSpec.Builder clearCondition()
Optional. An expression which specifies a boost condition. The syntax and
supported fields are the same as a filter expression.
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 [(.google.api.field_behavior) = OPTIONAL];
clearField(Descriptors.FieldDescriptor field)
public BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public BoostSpec.ConditionBoostSpec.Builder clone()
Overrides
getBoost()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
float | The boost.
|
getCondition()
public String getCondition()
Optional. An expression which specifies a boost condition. The syntax and
supported fields are the same as a filter expression.
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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The condition.
|
getConditionBytes()
public ByteString getConditionBytes()
Optional. An expression which specifies a boost condition. The syntax and
supported fields are the same as a filter expression.
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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for condition.
|
getDefaultInstanceForType()
public BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(BoostSpec.ConditionBoostSpec other)
public BoostSpec.ConditionBoostSpec.Builder mergeFrom(BoostSpec.ConditionBoostSpec other)
public BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setBoost(float value)
public BoostSpec.ConditionBoostSpec.Builder setBoost(float value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
value | float
The boost to set.
|
setCondition(String value)
public BoostSpec.ConditionBoostSpec.Builder setCondition(String value)
Optional. An expression which specifies a boost condition. The syntax and
supported fields are the same as a filter expression.
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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
value | String
The condition to set.
|
setConditionBytes(ByteString value)
public BoostSpec.ConditionBoostSpec.Builder setConditionBytes(ByteString value)
Optional. An expression which specifies a boost condition. The syntax and
supported fields are the same as a filter expression.
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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for condition to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
