Class FindNeighborsRequest.Query.RRF (3.52.0)

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

Parameters for RRF algorithm that combines search results.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FindNeighborsRequest.Query.RRF

Static Fields

ALPHA_FIELD_NUMBER

public static final int ALPHA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FindNeighborsRequest.Query.RRF getDefaultInstance()
Returns
Type Description
FindNeighborsRequest.Query.RRF

getDescriptor()

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

newBuilder()

public static FindNeighborsRequest.Query.RRF.Builder newBuilder()
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

newBuilder(FindNeighborsRequest.Query.RRF prototype)

public static FindNeighborsRequest.Query.RRF.Builder newBuilder(FindNeighborsRequest.Query.RRF prototype)
Parameter
Name Description
prototype FindNeighborsRequest.Query.RRF
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

parseDelimitedFrom(InputStream input)

public static FindNeighborsRequest.Query.RRF parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FindNeighborsRequest.Query.RRF parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FindNeighborsRequest.Query.RRF parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FindNeighborsRequest.Query.RRF parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FindNeighborsRequest.Query.RRF parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FindNeighborsRequest.Query.RRF parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query.RRF parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.RRF
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FindNeighborsRequest.Query.RRF> parser()
Returns
Type Description
Parser<RRF>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

getParserForType()

public Parser<FindNeighborsRequest.Query.RRF> getParserForType()
Returns
Type Description
Parser<RRF>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FindNeighborsRequest.Query.RRF.Builder newBuilderForType()
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FindNeighborsRequest.Query.RRF.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FindNeighborsRequest.Query.RRF.Builder toBuilder()
Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException