Package com.google.genai.types

Class Retrieval

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.Retrieval

public abstract class Retrieval
extends JsonSerializable

Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
Retrieval()

Method Summary

Modifier and Type	Method	Description
static Retrieval.Builder	builder()	Instantiates a builder for Retrieval.
abstract Optional<Boolean>	disableAttribution()	Optional.
abstract Optional<ExternalApi>	externalApi()	Use data source powered by external API for grounding.
static Retrieval	fromJson(String jsonString)	Deserializes a JSON string to a Retrieval object.
abstract Retrieval.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<VertexAISearch>	vertexAiSearch()	Set to use data source powered by Vertex AI Search.
abstract Optional<VertexRagStore>	vertexRagStore()	Set to use data source powered by Vertex RAG store.

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

Retrieval

public Retrieval()

Method Details

disableAttribution

public abstract Optional<Boolean> disableAttribution()

Optional. Deprecated. This option is no longer supported.

externalApi

public abstract Optional<ExternalApi> externalApi()

Use data source powered by external API for grounding.

vertexAiSearch

public abstract Optional<VertexAISearch> vertexAiSearch()

Set to use data source powered by Vertex AI Search.

vertexRagStore

public abstract Optional<VertexRagStore> vertexRagStore()

Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

builder

public static Retrieval.Builder builder()

Instantiates a builder for Retrieval.

toBuilder

public abstract Retrieval.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static Retrieval fromJson(String jsonString)

Deserializes a JSON string to a Retrieval object.