google-genai/com.google.genai.types/Retrieval

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.

Constructors

Link copied to clipboard
public void Retrieval()

Types

Link copied to clipboard
public abstract class Builder
Builder for Retrieval.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static Retrieval.Builder builder()
Instantiates a builder for Retrieval.
Link copied to clipboard
public abstract Optional<Boolean> disableAttribution()
Optional.
Link copied to clipboard
public abstract Optional<ExternalApi> externalApi()
Use data source powered by external API for grounding.
Link copied to clipboard
public static Retrieval fromJson(String jsonString)
Deserializes a JSON string to a Retrieval object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract Retrieval.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<VertexAISearch> vertexAiSearch()
Set to use data source powered by Vertex AI Search.
Link copied to clipboard
public abstract Optional<VertexRagStore> vertexRagStore()
Set to use data source powered by Vertex RAG store.