Class RagQuery (3.77.0)
Version 3.77.0keyboard_arrow_down
public final class RagQuery extends GeneratedMessageV3 implements RagQueryOrBuilder
A query to retrieve relevant contexts.
Protobuf type google.cloud.aiplatform.v1beta1.RagQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int RAG_RETRIEVAL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
public static final int RANKING_FIELD_NUMBER
Field Value
Type Description
int
public static final int SIMILARITY_TOP_K_FIELD_NUMBER
Field Value
Type Description
int
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static RagQuery getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static RagQuery . Builder newBuilder ()
public static RagQuery . Builder newBuilder ( RagQuery prototype )
Parameter
Name Description
prototypeRagQuery
public static RagQuery parseDelimitedFrom ( InputStream input )
public static RagQuery parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RagQuery parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static RagQuery parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static RagQuery parseFrom ( ByteString data )
public static RagQuery parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RagQuery parseFrom ( CodedInputStream input )
public static RagQuery parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RagQuery parseFrom ( InputStream input )
public static RagQuery parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static RagQuery parseFrom ( ByteBuffer data )
public static RagQuery parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<RagQuery> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public RagQuery getDefaultInstanceForType ()
public Parser<RagQuery> getParserForType ()
Overrides
public RagQuery . QueryCase getQueryCase ()
public RagRetrievalConfig getRagRetrievalConfig ()
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder ()
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagQuery . Ranking getRanking ()
Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See
google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=96
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
public 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];
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public int getSimilarityTopK ()
Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See
google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=92
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()
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 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.
public 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.
public boolean hasRanking ()
Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See
google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=96
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()
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public RagQuery . Builder newBuilderForType ()
protected RagQuery . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public RagQuery . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
