Class RagRetrievalConfig.Ranking (3.56.0)

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

Config for ranking and reranking.

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

Static Fields

LLM_RANKER_FIELD_NUMBER

public static final int LLM_RANKER_FIELD_NUMBER
Field Value
Type Description
int

RANK_SERVICE_FIELD_NUMBER

public static final int RANK_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(RagRetrievalConfig.Ranking prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<RagRetrievalConfig.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

getDefaultInstanceForType()

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

getLlmRanker()

public RagRetrievalConfig.Ranking.LlmRanker getLlmRanker()

Optional. Config for LlmRanker.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.LlmRanker llm_ranker = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Ranking.LlmRanker

The llmRanker.

getLlmRankerOrBuilder()

public RagRetrievalConfig.Ranking.LlmRankerOrBuilder getLlmRankerOrBuilder()

Optional. Config for LlmRanker.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.LlmRanker llm_ranker = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Ranking.LlmRankerOrBuilder

getParserForType()

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

getRankService()

public RagRetrievalConfig.Ranking.RankService getRankService()

Optional. Config for Rank Service.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.RankService rank_service = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Ranking.RankService

The rankService.

getRankServiceOrBuilder()

public RagRetrievalConfig.Ranking.RankServiceOrBuilder getRankServiceOrBuilder()

Optional. Config for Rank Service.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.RankService rank_service = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Ranking.RankServiceOrBuilder

getRankingConfigCase()

public RagRetrievalConfig.Ranking.RankingConfigCase getRankingConfigCase()
Returns
Type Description
RagRetrievalConfig.Ranking.RankingConfigCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasLlmRanker()

public boolean hasLlmRanker()

Optional. Config for LlmRanker.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.LlmRanker llm_ranker = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the llmRanker field is set.

hasRankService()

public boolean hasRankService()

Optional. Config for Rank Service.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Ranking.RankService rank_service = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rankService 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 RagRetrievalConfig.Ranking.Builder newBuilderForType()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagRetrievalConfig.Ranking.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagRetrievalConfig.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 RagRetrievalConfig.Ranking.Builder toBuilder()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

writeTo(CodedOutputStream output)

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