Class BoostSpec.ConditionBoostSpec.Builder (0.60.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

build()

public BoostSpec.ConditionBoostSpec build()
Returns
Type Description
BoostSpec.ConditionBoostSpec

buildPartial()

public BoostSpec.ConditionBoostSpec buildPartial()
Returns
Type Description
BoostSpec.ConditionBoostSpec

clear()

public BoostSpec.ConditionBoostSpec.Builder clear()
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
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];

Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

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];

Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

clone()

public BoostSpec.ConditionBoostSpec.Builder clone()
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

getBoost()

public float 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()
Returns
Type Description
BoostSpec.ConditionBoostSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BoostSpec.ConditionBoostSpec other)

public BoostSpec.ConditionBoostSpec.Builder mergeFrom(BoostSpec.ConditionBoostSpec other)
Parameter
Name Description
other BoostSpec.ConditionBoostSpec
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
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.

Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

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.

Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

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.

Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides