Class FindNeighborsRequest.Query.RRF.Builder (3.46.0)

public static final class FindNeighborsRequest.Query.RRF.Builder extends GeneratedMessageV3.Builder<FindNeighborsRequest.Query.RRF.Builder> implements FindNeighborsRequest.Query.RRFOrBuilder

Parameters for RRF algorithm that combines search results.

Protobuf type google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query.RRF

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Query.RRF.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

build()

public FindNeighborsRequest.Query.RRF build()
Returns
Type Description
FindNeighborsRequest.Query.RRF

buildPartial()

public FindNeighborsRequest.Query.RRF buildPartial()
Returns
Type Description
FindNeighborsRequest.Query.RRF

clear()

public FindNeighborsRequest.Query.RRF.Builder clear()
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

clearAlpha()

public FindNeighborsRequest.Query.RRF.Builder clearAlpha()

Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.

float alpha = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FindNeighborsRequest.Query.RRF.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public FindNeighborsRequest.Query.RRF.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

clone()

public FindNeighborsRequest.Query.RRF.Builder clone()
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

getAlpha()

public float getAlpha()

Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.

float alpha = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
float

The alpha.

getDefaultInstanceForType()

public FindNeighborsRequest.Query.RRF getDefaultInstanceForType()
Returns
Type Description
FindNeighborsRequest.Query.RRF

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FindNeighborsRequest.Query.RRF other)

public FindNeighborsRequest.Query.RRF.Builder mergeFrom(FindNeighborsRequest.Query.RRF other)
Parameter
Name Description
other FindNeighborsRequest.Query.RRF
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public FindNeighborsRequest.Query.RRF.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Query.RRF.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

setAlpha(float value)

public FindNeighborsRequest.Query.RRF.Builder setAlpha(float value)

Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.

float alpha = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value float

The alpha to set.

Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Query.RRF.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FindNeighborsRequest.Query.RRF.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Query.RRF.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides