Interface RagQueryOrBuilder (3.56.0)

public interface RagQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getQueryCase()

public abstract RagQuery.QueryCase getQueryCase()
Returns
Type Description
RagQuery.QueryCase

getRagRetrievalConfig()

public abstract RagRetrievalConfig getRagRetrievalConfig()

Optional. The retrieval config for the query.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfig

The ragRetrievalConfig.

getRagRetrievalConfigOrBuilder()

public abstract RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

Optional. The retrieval config for the query.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagRetrievalConfigOrBuilder

getRanking() (deprecated)

public abstract RagQuery.Ranking getRanking()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95

Optional. Configurations for hybrid search results ranking.

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagQuery.Ranking

The ranking.

getRankingOrBuilder() (deprecated)

public abstract RagQuery.RankingOrBuilder getRankingOrBuilder()

Optional. Configurations for hybrid search results ranking.

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RagQuery.RankingOrBuilder

getSimilarityTopK() (deprecated)

public abstract int getSimilarityTopK()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=91

Optional. The number of contexts to retrieve.

int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The similarityTopK.

getText()

public abstract String getText()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The text.

getTextBytes()

public abstract ByteString getTextBytes()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for text.

hasRagRetrievalConfig()

public abstract boolean hasRagRetrievalConfig()

Optional. The retrieval config for the query.

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ragRetrievalConfig field is set.

hasRanking() (deprecated)

public abstract boolean hasRanking()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95

Optional. Configurations for hybrid search results ranking.

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ranking field is set.

hasText()

public abstract boolean hasText()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the text field is set.