Class RagRetrievalConfig.Ranking.Builder (1.23.0)

public static final class RagRetrievalConfig.Ranking.Builder extends GeneratedMessageV3.Builder<RagRetrievalConfig.Ranking.Builder> implements RagRetrievalConfig.RankingOrBuilder

Config for ranking and reranking.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.Ranking.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

build()

public RagRetrievalConfig.Ranking build()
Returns
TypeDescription
RagRetrievalConfig.Ranking

buildPartial()

public RagRetrievalConfig.Ranking buildPartial()
Returns
TypeDescription
RagRetrievalConfig.Ranking

clear()

public RagRetrievalConfig.Ranking.Builder clear()
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RagRetrievalConfig.Ranking.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

clearLlmRanker()

public RagRetrievalConfig.Ranking.Builder clearLlmRanker()

Optional. Config for LlmRanker.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RagRetrievalConfig.Ranking.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

clearRankService()

public RagRetrievalConfig.Ranking.Builder clearRankService()

Optional. Config for Rank Service.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

clearRankingConfig()

public RagRetrievalConfig.Ranking.Builder clearRankingConfig()
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

clone()

public RagRetrievalConfig.Ranking.Builder clone()
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

getDefaultInstanceForType()

public RagRetrievalConfig.Ranking getDefaultInstanceForType()
Returns
TypeDescription
RagRetrievalConfig.Ranking

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLlmRanker()

public RagRetrievalConfig.Ranking.LlmRanker getLlmRanker()

Optional. Config for LlmRanker.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.LlmRanker

The llmRanker.

getLlmRankerBuilder()

public RagRetrievalConfig.Ranking.LlmRanker.Builder getLlmRankerBuilder()

Optional. Config for LlmRanker.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.LlmRanker.Builder

getLlmRankerOrBuilder()

public RagRetrievalConfig.Ranking.LlmRankerOrBuilder getLlmRankerOrBuilder()

Optional. Config for LlmRanker.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.LlmRankerOrBuilder

getRankService()

public RagRetrievalConfig.Ranking.RankService getRankService()

Optional. Config for Rank Service.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.RankService

The rankService.

getRankServiceBuilder()

public RagRetrievalConfig.Ranking.RankService.Builder getRankServiceBuilder()

Optional. Config for Rank Service.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.RankService.Builder

getRankServiceOrBuilder()

public RagRetrievalConfig.Ranking.RankServiceOrBuilder getRankServiceOrBuilder()

Optional. Config for Rank Service.

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

Returns
TypeDescription
RagRetrievalConfig.Ranking.RankServiceOrBuilder

getRankingConfigCase()

public RagRetrievalConfig.Ranking.RankingConfigCase getRankingConfigCase()
Returns
TypeDescription
RagRetrievalConfig.Ranking.RankingConfigCase

hasLlmRanker()

public boolean hasLlmRanker()

Optional. Config for LlmRanker.

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

Returns
TypeDescription
boolean

Whether the llmRanker field is set.

hasRankService()

public boolean hasRankService()

Optional. Config for Rank Service.

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

Returns
TypeDescription
boolean

Whether the rankService field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RagRetrievalConfig.Ranking other)

public RagRetrievalConfig.Ranking.Builder mergeFrom(RagRetrievalConfig.Ranking other)
Parameter
NameDescription
otherRagRetrievalConfig.Ranking
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagRetrievalConfig.Ranking.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RagRetrievalConfig.Ranking.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

mergeLlmRanker(RagRetrievalConfig.Ranking.LlmRanker value)

public RagRetrievalConfig.Ranking.Builder mergeLlmRanker(RagRetrievalConfig.Ranking.LlmRanker value)

Optional. Config for LlmRanker.

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

Parameter
NameDescription
valueRagRetrievalConfig.Ranking.LlmRanker
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

mergeRankService(RagRetrievalConfig.Ranking.RankService value)

public RagRetrievalConfig.Ranking.Builder mergeRankService(RagRetrievalConfig.Ranking.RankService value)

Optional. Config for Rank Service.

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

Parameter
NameDescription
valueRagRetrievalConfig.Ranking.RankService
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.Ranking.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RagRetrievalConfig.Ranking.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

setLlmRanker(RagRetrievalConfig.Ranking.LlmRanker value)

public RagRetrievalConfig.Ranking.Builder setLlmRanker(RagRetrievalConfig.Ranking.LlmRanker value)

Optional. Config for LlmRanker.

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

Parameter
NameDescription
valueRagRetrievalConfig.Ranking.LlmRanker
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

setLlmRanker(RagRetrievalConfig.Ranking.LlmRanker.Builder builderForValue)

public RagRetrievalConfig.Ranking.Builder setLlmRanker(RagRetrievalConfig.Ranking.LlmRanker.Builder builderForValue)

Optional. Config for LlmRanker.

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

Parameter
NameDescription
builderForValueRagRetrievalConfig.Ranking.LlmRanker.Builder
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

setRankService(RagRetrievalConfig.Ranking.RankService value)

public RagRetrievalConfig.Ranking.Builder setRankService(RagRetrievalConfig.Ranking.RankService value)

Optional. Config for Rank Service.

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

Parameter
NameDescription
valueRagRetrievalConfig.Ranking.RankService
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

setRankService(RagRetrievalConfig.Ranking.RankService.Builder builderForValue)

public RagRetrievalConfig.Ranking.Builder setRankService(RagRetrievalConfig.Ranking.RankService.Builder builderForValue)

Optional. Config for Rank Service.

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

Parameter
NameDescription
builderForValueRagRetrievalConfig.Ranking.RankService.Builder
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder

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

public RagRetrievalConfig.Ranking.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RagRetrievalConfig.Ranking.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RagRetrievalConfig.Ranking.Builder
Overrides