google-genai/com.google.genai.types/GroundingChunk

GroundingChunk

public abstract class GroundingChunk extends JsonSerializable

A piece of evidence that supports a claim made by the model.

This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.

Constructors

Link copied to clipboard
public void GroundingChunk()

Types

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

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 GroundingChunk.Builder builder()
Instantiates a builder for GroundingChunk.
Link copied to clipboard
public static GroundingChunk fromJson(String jsonString)
Deserializes a JSON string to a GroundingChunk 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<GroundingChunkImage> image()
A grounding chunk from an image search result.
Link copied to clipboard
public abstract Optional<GroundingChunkMaps> maps()
A `Maps` chunk is a piece of evidence that comes from Google Maps.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<GroundingChunkRetrievedContext> retrievedContext()
A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search.
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 GroundingChunk.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<GroundingChunkWeb> web()
A grounding chunk from a web page, typically from Google Search.