Class RagRetrievalConfig.Ranking.Builder (1.43.0)

public static final class RagRetrievalConfig.Ranking.Builder extends GeneratedMessage.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
Type Description
Descriptor

Methods

build()

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

buildPartial()

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

clear()

public RagRetrievalConfig.Ranking.Builder clear()
Returns
Type Description
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
Type Description
RagRetrievalConfig.Ranking.Builder

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
Type Description
RagRetrievalConfig.Ranking.Builder

clearRankingConfig()

public RagRetrievalConfig.Ranking.Builder clearRankingConfig()
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
RagRetrievalConfig.Ranking.RankServiceOrBuilder

getRankingConfigCase()

public RagRetrievalConfig.Ranking.RankingConfigCase getRankingConfigCase()
Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the rankService field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagRetrievalConfig.Ranking other)

public RagRetrievalConfig.Ranking.Builder mergeFrom(RagRetrievalConfig.Ranking other)
Parameter
Name Description
other RagRetrievalConfig.Ranking
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagRetrievalConfig.Ranking.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagRetrievalConfig.Ranking.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagRetrievalConfig.Ranking.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value RagRetrievalConfig.Ranking.LlmRanker
Returns
Type Description
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
Name Description
value RagRetrievalConfig.Ranking.RankService
Returns
Type Description
RagRetrievalConfig.Ranking.Builder

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
Name Description
value RagRetrievalConfig.Ranking.LlmRanker
Returns
Type Description
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
Name Description
builderForValue RagRetrievalConfig.Ranking.LlmRanker.Builder
Returns
Type Description
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
Name Description
value RagRetrievalConfig.Ranking.RankService
Returns
Type Description
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
Name Description
builderForValue RagRetrievalConfig.Ranking.RankService.Builder
Returns
Type Description
RagRetrievalConfig.Ranking.Builder