Class RagQuery.Ranking (3.55.0)

public static final class RagQuery.Ranking extends GeneratedMessageV3 implements RagQuery.RankingOrBuilder

Configurations for hybrid search results ranking.

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery.Ranking

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ALPHA_FIELD_NUMBER

public static final int ALPHA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagQuery.Ranking getDefaultInstance()
Returns
Type Description
RagQuery.Ranking

getDescriptor()

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

newBuilder()

public static RagQuery.Ranking.Builder newBuilder()
Returns
Type Description
RagQuery.Ranking.Builder

newBuilder(RagQuery.Ranking prototype)

public static RagQuery.Ranking.Builder newBuilder(RagQuery.Ranking prototype)
Parameter
Name Description
prototype RagQuery.Ranking
Returns
Type Description
RagQuery.Ranking.Builder

parseDelimitedFrom(InputStream input)

public static RagQuery.Ranking parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagQuery.Ranking parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagQuery.Ranking parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RagQuery.Ranking parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagQuery.Ranking parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagQuery.Ranking parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagQuery.Ranking parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagQuery.Ranking parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagQuery.Ranking parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagQuery.Ranking parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagQuery.Ranking parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagQuery.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagQuery.Ranking> parser()
Returns
Type Description
Parser<Ranking>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlpha()

public float getAlpha()

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

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

Returns
Type Description
float

The alpha.

getDefaultInstanceForType()

public RagQuery.Ranking getDefaultInstanceForType()
Returns
Type Description
RagQuery.Ranking

getParserForType()

public Parser<RagQuery.Ranking> getParserForType()
Returns
Type Description
Parser<Ranking>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAlpha()

public boolean hasAlpha()

Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

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

Returns
Type Description
boolean

Whether the alpha field is set.

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 RagQuery.Ranking.Builder newBuilderForType()
Returns
Type Description
RagQuery.Ranking.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagQuery.Ranking.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagQuery.Ranking.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public RagQuery.Ranking.Builder toBuilder()
Returns
Type Description
RagQuery.Ranking.Builder

writeTo(CodedOutputStream output)

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