Interface RagRetrievalConfigOrBuilder (1.20.0)

public interface RagRetrievalConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract RagRetrievalConfig.Filter getFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Filter

The filter.

getFilterOrBuilder()

public abstract RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.FilterOrBuilder

getRanking()

public abstract RagRetrievalConfig.Ranking getRanking()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.Ranking

The ranking.

getRankingOrBuilder()

public abstract RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig.RankingOrBuilder

getTopK()

public abstract int getTopK()

Optional. The number of contexts to retrieve.

int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The topK.

hasFilter()

public abstract boolean hasFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the filter field is set.

hasRanking()

public abstract boolean hasRanking()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ranking field is set.