Package com.google.genai.types

Class VertexRagStore

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.VertexRagStore

public abstract class VertexRagStore
extends JsonSerializable

Retrieve from Vertex RAG Store for grounding.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexRagStore.Builder	Builder for VertexRagStore.

Constructor Summary

Constructors

Constructor	Description
VertexRagStore()

Method Summary

Modifier and Type	Method	Description
static VertexRagStore.Builder	builder()	Instantiates a builder for VertexRagStore.
static VertexRagStore	fromJson(String jsonString)	Deserializes a JSON string to a VertexRagStore object.
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 VertexRagStore.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Double>	vectorDistanceThreshold()	Optional.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VertexRagStore

public VertexRagStore()

Method Details

ragCorpora

public abstract Optional<List<String>> ragCorpora()

Optional. Deprecated. Please use rag_resources instead.

ragResources

public 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

public abstract Optional<RagRetrievalConfig> ragRetrievalConfig()

Optional. The retrieval config for the Rag query.

similarityTopK

public abstract Optional<Integer> similarityTopK()

Optional. Number of top k results to return from the selected corpora.

storeContext

public 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

public abstract Optional<Double> vectorDistanceThreshold()

Optional. Only return results with vector distance smaller than the threshold.

builder

public static VertexRagStore.Builder builder()

Instantiates a builder for VertexRagStore.

toBuilder

public abstract VertexRagStore.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static VertexRagStore fromJson(String jsonString)

Deserializes a JSON string to a VertexRagStore object.