Class VertexRagStore
-
- All Implemented Interfaces:
public abstract class VertexRagStore extends JsonSerializable
Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classVertexRagStore.BuilderBuilder for VertexRagStore.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description VertexRagStore()
-
Method Summary
Modifier and Type Method Description abstract Optional<List<String>>ragCorpora()Optional. abstract Optional<List<VertexRagStoreRagResource>>ragResources()Optional. abstract Optional<RagRetrievalConfig>ragRetrievalConfig()Optional. abstract Optional<Integer>similarityTopK()Optional. abstract Optional<Boolean>storeContext()Optional. abstract Optional<Double>vectorDistanceThreshold()Optional. static VertexRagStore.Builderbuilder()Instantiates a builder for VertexRagStore. abstract VertexRagStore.BuildertoBuilder()Creates a builder with the same values as this instance. static VertexRagStorefromJson(String jsonString)Deserializes a JSON string to a VertexRagStore object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
ragCorpora
abstract Optional<List<String>> ragCorpora()
Optional. Deprecated. Please use rag_resources instead.
-
ragResources
abstract Optional<List<VertexRagStoreRagResource>> ragResources()
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.
-
ragRetrievalConfig
abstract Optional<RagRetrievalConfig> ragRetrievalConfig()
Optional. The retrieval config for the Rag query.
-
similarityTopK
abstract Optional<Integer> similarityTopK()
Optional. Number of top k results to return from the selected corpora.
-
storeContext
abstract Optional<Boolean> storeContext()
Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, 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.
-
vectorDistanceThreshold
abstract Optional<Double> vectorDistanceThreshold()
Optional. Only return results with vector distance smaller than the threshold.
-
builder
static VertexRagStore.Builder builder()
Instantiates a builder for VertexRagStore.
-
toBuilder
abstract VertexRagStore.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static VertexRagStore fromJson(String jsonString)
Deserializes a JSON string to a VertexRagStore object.
-
-
-
-