Interface VertexRagStoreOrBuilder (3.43.0)

Version 3.43.0

• 3.47.0 (latest)
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface VertexRagStoreOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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	int The 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	int The 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.