Class SearchResult.SearchResultMetadata.RrfRankerResult.Builder (0.21.0)

0.21.0 (latest) 0.17.0 0.16.0 0.15.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public static final class SearchResult.SearchResultMetadata.RrfRankerResult.Builder extends GeneratedMessage.Builder<SearchResult.SearchResultMetadata.RrfRankerResult.Builder> implements SearchResult.SearchResultMetadata.RrfRankerResultOrBuilder

The rank and score assigned by the Reciprocal Rank Fusion ranker when combining the results of the batch searches.

Protobuf type google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.RrfRankerResult

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchResult.SearchResultMetadata.RrfRankerResult.Builder

Implements

SearchResult.SearchResultMetadata.RrfRankerResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public SearchResult.SearchResultMetadata.RrfRankerResult build()

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult

buildPartial()

public SearchResult.SearchResultMetadata.RrfRankerResult buildPartial()

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult

clear()

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder clear()

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearRank()

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder clearRank()

Output only. The rank of this data object after RRF combination.

int32 rank = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder	This builder for chaining.

clearScore()

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder clearScore()

Output only. The score of this data object after RRF combination.

double score = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchResult.SearchResultMetadata.RrfRankerResult getDefaultInstanceForType()

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getRank()

public int getRank()

Output only. The rank of this data object after RRF combination.

int32 rank = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The rank.

getScore()

public double getScore()

Output only. The score of this data object after RRF combination.

double score = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The score.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchResult.SearchResultMetadata.RrfRankerResult other)

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder mergeFrom(SearchResult.SearchResultMetadata.RrfRankerResult other)

Parameter
Name	Description
other	SearchResult.SearchResultMetadata.RrfRankerResult

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setRank(int value)

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder setRank(int value)

Output only. The rank of this data object after RRF combination.

int32 rank = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The rank to set.

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder	This builder for chaining.

setScore(double value)

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder setScore(double value)

Output only. The score of this data object after RRF combination.

double score = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	double The score to set.

Returns
Type	Description
SearchResult.SearchResultMetadata.RrfRankerResult.Builder	This builder for chaining.