com.google.cloud.discoveryengine.v1beta

Class SearchRequest.BoostSpec.ConditionBoostSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec

All Implemented Interfaces:

SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest.BoostSpec

public static final class SearchRequest.BoostSpec.ConditionBoostSpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

 Boost applies to documents which match a condition.
 

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec Specification for custom ranking based on customer specified attribute value.
static interface	SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder
static class	SearchRequest.BoostSpec.ConditionBoostSpec.Builder Boost applies to documents which match a condition.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOST_CONTROL_SPEC_FIELD_NUMBER
static int	BOOST_FIELD_NUMBER
static int	CONDITION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
float	getBoost() Strength of the condition boost, which should be in [-1, 1].
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec	getBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder	getBoostControlSpecOrBuilder() Complex specification for custom ranking based on customer defined attribute value.
String	getCondition() An expression which specifies a boost condition.
com.google.protobuf.ByteString	getConditionBytes() An expression which specifies a boost condition.
static SearchRequest.BoostSpec.ConditionBoostSpec	getDefaultInstance()
SearchRequest.BoostSpec.ConditionBoostSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec>	getParserForType()
int	getSerializedSize()
boolean	hasBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilder()
static SearchRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec prototype)
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilderForType()
protected SearchRequest.BoostSpec.ConditionBoostSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(byte[] data)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(ByteBuffer data)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(InputStream input)
static SearchRequest.BoostSpec.ConditionBoostSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec>	parser()
SearchRequest.BoostSpec.ConditionBoostSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

See Also:

Constant Field Values

BOOST_FIELD_NUMBER

public static final int BOOST_FIELD_NUMBER

See Also:

Constant Field Values

BOOST_CONTROL_SPEC_FIELD_NUMBER

public static final int BOOST_CONTROL_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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][google.cloud.discoveryengine.v1beta.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;

Specified by:

getCondition in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The condition.

getConditionBytes

public com.google.protobuf.ByteString getConditionBytes()

 An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.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;

Specified by:

getConditionBytes in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The bytes for condition.

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;

Specified by:

getBoost in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boost.

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;

Specified by:

hasBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

Whether the boostControlSpec field is set.

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;

Specified by:

getBoostControlSpec in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Returns:

The boostControlSpec.

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;

Specified by:

getBoostControlSpecOrBuilder in interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(com.google.protobuf.ByteString data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(com.google.protobuf.ByteString data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input)
                                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                            throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec.ConditionBoostSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder()

newBuilder

public static SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder(SearchRequest.BoostSpec.ConditionBoostSpec prototype)

toBuilder

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.BoostSpec.ConditionBoostSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder