Send feedback
Class VertexRagStore (3.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.56.0 keyboard_arrow_down
public final class VertexRagStore extends GeneratedMessageV3 implements VertexRagStoreOrBuilder
Retrieve from Vertex RAG Store for grounding.
Protobuf type google.cloud.aiplatform.v1.VertexRagStore
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_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int
public static final int RAG_RETRIEVAL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
public static final int SIMILARITY_TOP_K_FIELD_NUMBER
Field Value
Type Description
int
public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static VertexRagStore getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static VertexRagStore . Builder newBuilder ()
public static VertexRagStore . Builder newBuilder ( VertexRagStore prototype )
public static VertexRagStore parseDelimitedFrom ( InputStream input )
public static VertexRagStore parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexRagStore parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static VertexRagStore parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static VertexRagStore parseFrom ( ByteString data )
public static VertexRagStore parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static VertexRagStore parseFrom ( CodedInputStream input )
public static VertexRagStore parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexRagStore parseFrom ( InputStream input )
public static VertexRagStore parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexRagStore parseFrom ( ByteBuffer data )
public static VertexRagStore parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<VertexRagStore> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public VertexRagStore getDefaultInstanceForType ()
public Parser<VertexRagStore> getParserForType ()
Overrides
public VertexRagStore . RagResource getRagResources ( int index )
Optional. The representation of the rag source. It can be used to specify
corpus only or ragfiles. Currently only support one corpus or multiple
files from one corpus. In the future we may open up multiple corpora
support.
repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
public int getRagResourcesCount ()
Optional. The representation of the rag source. It can be used to specify
corpus only or ragfiles. Currently only support one corpus or multiple
files from one corpus. In the future we may open up multiple corpora
support.
repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int
public List<VertexRagStore . RagResource > getRagResourcesList ()
Optional. The representation of the rag source. It can be used to specify
corpus only or ragfiles. Currently only support one corpus or multiple
files from one corpus. In the future we may open up multiple corpora
support.
repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
public VertexRagStore . RagResourceOrBuilder getRagResourcesOrBuilder ( int index )
Optional. The representation of the rag source. It can be used to specify
corpus only or ragfiles. Currently only support one corpus or multiple
files from one corpus. In the future we may open up multiple corpora
support.
repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
public List <? extends VertexRagStore . RagResourceOrBuilder > getRagResourcesOrBuilderList ()
Optional. The representation of the rag source. It can be used to specify
corpus only or ragfiles. Currently only support one corpus or multiple
files from one corpus. In the future we may open up multiple corpora
support.
repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1.VertexRagStore.RagResourceOrBuilder >
public RagRetrievalConfig getRagRetrievalConfig ()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder ()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public int getSimilarityTopK ()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/aiplatform/v1/tool.proto;l=173
Optional. Number of top k results to return from the selected corpora.
optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The similarityTopK.
public double getVectorDistanceThreshold ()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/aiplatform/v1/tool.proto;l=178
Optional. Only return results with vector distance smaller than the
threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
double The vectorDistanceThreshold.
public boolean hasRagRetrievalConfig ()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the ragRetrievalConfig field is set.
public boolean hasSimilarityTopK ()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/aiplatform/v1/tool.proto;l=173
Optional. Number of top k results to return from the selected corpora.
optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the similarityTopK field is set.
public boolean hasVectorDistanceThreshold ()
Deprecated. google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated.
See google/cloud/aiplatform/v1/tool.proto;l=178
Optional. Only return results with vector distance smaller than the
threshold.
optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the vectorDistanceThreshold field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public VertexRagStore . Builder newBuilderForType ()
protected VertexRagStore . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public VertexRagStore . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
