- 0.66.0 (latest)
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
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.v3beta1.BoostSpec.ConditionBoostSpec
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BoostSpec.ConditionBoostSpecImplements
BoostSpec.ConditionBoostSpecOrBuilderInherited Members
Static Fields
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 |
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 |
getParserForType()
public Parser<BoostSpec.ConditionBoostSpec> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<ConditionBoostSpec> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |