Class Ranker.Builder (0.15.0)

public static final class Ranker.Builder extends GeneratedMessage.Builder<Ranker.Builder> implements RankerOrBuilder

Defines a ranker to combine results from multiple searches.

Protobuf type google.cloud.vectorsearch.v1beta.Ranker

Implements

RankerOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public Ranker build()
Returns
Type Description
Ranker

buildPartial()

public Ranker buildPartial()
Returns
Type Description
Ranker

clear()

public Ranker.Builder clear()
Returns
Type Description
Ranker.Builder
Overrides

clearRanker()

public Ranker.Builder clearRanker()
Returns
Type Description
Ranker.Builder

clearReranker()

public Ranker.Builder clearReranker()
Returns
Type Description
Ranker.Builder

clearRrf()

public Ranker.Builder clearRrf()

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Returns
Type Description
Ranker.Builder

clearVertexRanker()

public Ranker.Builder clearVertexRanker()

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Ranker.Builder

getDefaultInstanceForType()

public Ranker getDefaultInstanceForType()
Returns
Type Description
Ranker

getDescriptorForType()

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

getRankerCase()

public Ranker.RankerCase getRankerCase()
Returns
Type Description
Ranker.RankerCase

getRerankerCase()

public Ranker.RerankerCase getRerankerCase()
Returns
Type Description
Ranker.RerankerCase

getRrf()

public ReciprocalRankFusion getRrf()

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Returns
Type Description
ReciprocalRankFusion

The rrf.

getRrfBuilder()

public ReciprocalRankFusion.Builder getRrfBuilder()

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Returns
Type Description
ReciprocalRankFusion.Builder

getRrfOrBuilder()

public ReciprocalRankFusionOrBuilder getRrfOrBuilder()

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Returns
Type Description
ReciprocalRankFusionOrBuilder

getVertexRanker()

public VertexRanker getVertexRanker()

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRanker

The vertexRanker.

getVertexRankerBuilder()

public VertexRanker.Builder getVertexRankerBuilder()

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRanker.Builder

getVertexRankerOrBuilder()

public VertexRankerOrBuilder getVertexRankerOrBuilder()

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRankerOrBuilder

hasRrf()

public boolean hasRrf()

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Returns
Type Description
boolean

Whether the rrf field is set.

hasVertexRanker()

public boolean hasVertexRanker()

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the vertexRanker field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Ranker other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRrf(ReciprocalRankFusion value)

public Ranker.Builder mergeRrf(ReciprocalRankFusion value)

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Parameter
Name Description
value ReciprocalRankFusion
Returns
Type Description
Ranker.Builder

mergeVertexRanker(VertexRanker value)

public Ranker.Builder mergeVertexRanker(VertexRanker value)

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VertexRanker
Returns
Type Description
Ranker.Builder

setRrf(ReciprocalRankFusion value)

public Ranker.Builder setRrf(ReciprocalRankFusion value)

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Parameter
Name Description
value ReciprocalRankFusion
Returns
Type Description
Ranker.Builder

setRrf(ReciprocalRankFusion.Builder builderForValue)

public Ranker.Builder setRrf(ReciprocalRankFusion.Builder builderForValue)

Reciprocal Rank Fusion ranking.

.google.cloud.vectorsearch.v1beta.ReciprocalRankFusion rrf = 1;

Parameter
Name Description
builderForValue ReciprocalRankFusion.Builder
Returns
Type Description
Ranker.Builder

setVertexRanker(VertexRanker value)

public Ranker.Builder setVertexRanker(VertexRanker value)

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VertexRanker
Returns
Type Description
Ranker.Builder

setVertexRanker(VertexRanker.Builder builderForValue)

public Ranker.Builder setVertexRanker(VertexRanker.Builder builderForValue)

Optional. Vertex AI ranking.

.google.cloud.vectorsearch.v1beta.VertexRanker vertex_ranker = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue VertexRanker.Builder
Returns
Type Description
Ranker.Builder