Class BoostSpec.ConditionBoostSpec (0.66.0) 

public static final class BoostSpec.ConditionBoostSpec extends GeneratedMessageV3 implements BoostSpec.ConditionBoostSpecOrBuilder

Boost applies to documents which match a condition.

Protobuf type google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BoostSpec.ConditionBoostSpec

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

getDescriptor()

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

newBuilder()

public static BoostSpec.ConditionBoostSpec.Builder newBuilder()
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

newBuilder(BoostSpec.ConditionBoostSpec prototype)

public static BoostSpec.ConditionBoostSpec.Builder newBuilder(BoostSpec.ConditionBoostSpec prototype)
Parameter
Name Description
prototype BoostSpec.ConditionBoostSpec
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

parseDelimitedFrom(InputStream input)

public static BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BoostSpec.ConditionBoostSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BoostSpec.ConditionBoostSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BoostSpec.ConditionBoostSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BoostSpec.ConditionBoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BoostSpec.ConditionBoostSpec> parser()
Returns
Type Description
Parser<ConditionBoostSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getBoostControlSpec()

public BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoostSpec.ConditionBoostSpec.BoostControlSpec

The boostControlSpec.

getBoostControlSpecOrBuilder()

public BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

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

getParserForType()

public Parser<BoostSpec.ConditionBoostSpec> getParserForType()
Returns
Type Description
Parser<ConditionBoostSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBoostControlSpec()

public boolean hasBoostControlSpec()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the boostControlSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BoostSpec.ConditionBoostSpec.Builder newBuilderForType()
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BoostSpec.ConditionBoostSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BoostSpec.ConditionBoostSpec.Builder toBuilder()
Returns
Type Description
BoostSpec.ConditionBoostSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException