com.google.cloud.vertexai.api

Interface RagRetrievalConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RagRetrievalConfig, RagRetrievalConfig.Builder

public interface RagRetrievalConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RagRetrievalConfig.Filter	getFilter() Optional.
RagRetrievalConfig.FilterOrBuilder	getFilterOrBuilder() Optional.
RagRetrievalConfig.Ranking	getRanking() Optional.
RagRetrievalConfig.RankingOrBuilder	getRankingOrBuilder() Optional.
int	getTopK() Optional.
boolean	hasFilter() Optional.
boolean	hasRanking() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTopK

int getTopK()

 Optional. The number of contexts to retrieve.
 

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

Returns:

The topK.

hasFilter

boolean hasFilter()

 Optional. Config for filters.
 

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

Returns:

Whether the filter field is set.

getFilter

RagRetrievalConfig.Filter getFilter()

 Optional. Config for filters.
 

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

Returns:

The filter.

getFilterOrBuilder

RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()

 Optional. Config for filters.
 

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

hasRanking

boolean hasRanking()

 Optional. Config for ranking and reranking.
 

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

Returns:

Whether the ranking field is set.

getRanking

RagRetrievalConfig.Ranking getRanking()

 Optional. Config for ranking and reranking.
 

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

Returns:

The ranking.

getRankingOrBuilder

RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()

 Optional. Config for ranking and reranking.
 

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