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 SIMILARITY_TOP_K_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)
Required. Vertex RAG Store corpus resource name:
projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
Currently only one corpus is allowed.
In the future we may open up multiple corpora support. However, they should
be from the same project and location.
repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.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)
Required. Vertex RAG Store corpus resource name:
projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
Currently only one corpus is allowed.
In the future we may open up multiple corpora support. However, they should
be from the same project and location.
repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.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()
Required. Vertex RAG Store corpus resource name:
projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
Currently only one corpus is allowed.
In the future we may open up multiple corpora support. However, they should
be from the same project and location.
repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of ragCorpora.
|
public ProtocolStringList getRagCorporaList()
Required. Vertex RAG Store corpus resource name:
projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
Currently only one corpus is allowed.
In the future we may open up multiple corpora support. However, they should
be from the same project and location.
repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public int getSimilarityTopK()
Optional. Number of top k results to return from the selected corpora.
optional int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The similarityTopK.
|
public boolean hasSimilarityTopK()
Optional. Number of top k results to return from the selected corpora.
optional int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the similarityTopK 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
