Class RagRetrievalConfig.Ranking (1.40.0)

publicstaticfinalclass RagRetrievalConfig.RankingextendsGeneratedMessageV3implementsRagRetrievalConfig.RankingOrBuilder

Config for ranking and reranking.

Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig.Ranking

Inherited Members

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

LLM_RANKER_FIELD_NUMBER

publicstaticfinalintLLM_RANKER_FIELD_NUMBER
Field Value
Type Description
int

RANK_SERVICE_FIELD_NUMBER

publicstaticfinalintRANK_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticRagRetrievalConfig.RankinggetDefaultInstance()
Returns
Type Description
RagRetrievalConfig.Ranking

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticRagRetrievalConfig.Ranking.BuildernewBuilder()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

newBuilder(RagRetrievalConfig.Ranking prototype)

publicstaticRagRetrievalConfig.Ranking.BuildernewBuilder(RagRetrievalConfig.Rankingprototype)
Parameter
Name Description
prototype RagRetrievalConfig.Ranking
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

parseDelimitedFrom(InputStream input)

publicstaticRagRetrievalConfig.RankingparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticRagRetrievalConfig.RankingparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticRagRetrievalConfig.RankingparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticRagRetrievalConfig.RankingparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticRagRetrievalConfig.RankingparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticRagRetrievalConfig.RankingparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticRagRetrievalConfig.RankingparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<RagRetrievalConfig.Ranking>parser()
Returns
Type Description
Parser<Ranking>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicRagRetrievalConfig.RankinggetDefaultInstanceForType()
Returns
Type Description
RagRetrievalConfig.Ranking

getLlmRanker()

publicRagRetrievalConfig.Ranking.LlmRankergetLlmRanker()

Optional. Config for LlmRanker.

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

Returns
Type Description
RagRetrievalConfig.Ranking.LlmRanker

The llmRanker.

getLlmRankerOrBuilder()

publicRagRetrievalConfig.Ranking.LlmRankerOrBuildergetLlmRankerOrBuilder()

Optional. Config for LlmRanker.

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

Returns
Type Description
RagRetrievalConfig.Ranking.LlmRankerOrBuilder

getParserForType()

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

getRankService()

publicRagRetrievalConfig.Ranking.RankServicegetRankService()

Optional. Config for Rank Service.

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

Returns
Type Description
RagRetrievalConfig.Ranking.RankService

The rankService.

getRankServiceOrBuilder()

publicRagRetrievalConfig.Ranking.RankServiceOrBuildergetRankServiceOrBuilder()

Optional. Config for Rank Service.

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

Returns
Type Description
RagRetrievalConfig.Ranking.RankServiceOrBuilder

getRankingConfigCase()

publicRagRetrievalConfig.Ranking.RankingConfigCasegetRankingConfigCase()
Returns
Type Description
RagRetrievalConfig.Ranking.RankingConfigCase

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hasLlmRanker()

publicbooleanhasLlmRanker()

Optional. Config for LlmRanker.

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

Returns
Type Description
boolean

Whether the llmRanker field is set.

hasRankService()

publicbooleanhasRankService()

Optional. Config for Rank Service.

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

Returns
Type Description
boolean

Whether the rankService field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicRagRetrievalConfig.Ranking.BuildernewBuilderForType()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedRagRetrievalConfig.Ranking.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagRetrievalConfig.Ranking.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicRagRetrievalConfig.Ranking.BuildertoBuilder()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.