public final class VertexRagStore extends GeneratedMessageV3 implements VertexRagStoreOrBuilder
Retrieve from Vertex RAG Store for grounding.
Protobuf type google.cloud.aiplatform.v1beta1.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_CORPORA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
STORE_CONTEXT_FIELD_NUMBER
public static final int STORE_CONTEXT_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 |
data |
byte[]
|
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 |
obj |
Object
|
Overrides
public VertexRagStore getDefaultInstanceForType()
public Parser<VertexRagStore> getParserForType()
Overrides
public String getRagCorpora(int index)
Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=385
Optional. Deprecated. Please use rag_resources instead.
repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The ragCorpora at the given index.
|
public ByteString getRagCorporaBytes(int index)
Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=385
Optional. Deprecated. Please use rag_resources instead.
repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the ragCorpora at the given index.
|
public int getRagCorporaCount()
Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=385
Optional. Deprecated. Please use rag_resources instead.
repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of ragCorpora.
|
public ProtocolStringList getRagCorporaList()
Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=385
Optional. Deprecated. Please use rag_resources instead.
repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta1.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.v1beta1.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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.VertexRagStore.RagResourceOrBuilder> |
|
public RagRetrievalConfig getRagRetrievalConfig()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()
Optional. The retrieval config for the Rag query.
.google.cloud.aiplatform.v1beta1.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.v1beta1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=401
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.
|
getStoreContext()
public boolean getStoreContext()
Optional. Currently only supported for Gemini Multimodal Live API.
In Gemini Multimodal Live API, if store_context bool is
true, Gemini will leverage it to automatically memorize the
interactions between the client and Gemini, and retrieve context when
needed to augment the response generation for users' ongoing and future
interactions.
bool store_context = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The storeContext.
|
public double getVectorDistanceThreshold()
Deprecated. google.cloud.aiplatform.v1beta1.VertexRagStore.vector_distance_threshold is
deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=406
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.v1beta1.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.v1beta1.VertexRagStore.similarity_top_k is deprecated. See
google/cloud/aiplatform/v1beta1/tool.proto;l=401
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.v1beta1.VertexRagStore.vector_distance_threshold is
deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=406
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
