google-genai/com.google.genai.types/GroundingChunkRetrievedContext

GroundingChunkRetrievedContext

public abstract class GroundingChunkRetrievedContext extends JsonSerializable

Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.

Constructors

Link copied to clipboard

Types

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

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 GroundingChunkRetrievedContext.Builder builder()
Instantiates a builder for GroundingChunkRetrievedContext.
Link copied to clipboard
Link copied to clipboard
public abstract Optional<String> documentName()
Output only.
Link copied to clipboard
public abstract Optional<String> fileSearchStore()
Optional.
Link copied to clipboard
public static GroundingChunkRetrievedContext fromJson(String jsonString)
Deserializes a JSON string to a GroundingChunkRetrievedContext 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 abstract Optional<String> mediaId()
Optional.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<Integer> pageNumber()
Optional.
Link copied to clipboard
public abstract Optional<RagChunk> ragChunk()
Additional context for a Retrieval-Augmented Generation (RAG) retrieval result.
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 Optional<String> text()
The content of the retrieved data source.
Link copied to clipboard
public abstract Optional<String> title()
The title of the retrieved data source.
Link copied to clipboard
public abstract GroundingChunkRetrievedContext.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<String> uri()
The URI of the retrieved data source.