public interface VertexRagStoreOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getRagCorpora(int index)
public abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The ragCorpora at the given index. |
getRagCorporaBytes(int index)
public abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the ragCorpora at the given index. |
getRagCorporaCount()
public abstract 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. |
getRagCorporaList()
public abstract List<String> 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the ragCorpora. |
getSimilarityTopK()
public abstract 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. |
hasSimilarityTopK()
public abstract 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. |