Package com.google.genai.types

Class GroundingChunk

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
GroundingChunk()

Method Summary

Modifier and Type	Method	Description
static GroundingChunk.Builder	builder()	Instantiates a builder for GroundingChunk.
static GroundingChunk	fromJson(String jsonString)	Deserializes a JSON string to a GroundingChunk object.
abstract Optional<GroundingChunkImage>	image()	A grounding chunk from an image search result.
abstract Optional<GroundingChunkMaps>	maps()	A `Maps` chunk is a piece of evidence that comes from Google Maps.
abstract Optional<GroundingChunkRetrievedContext>	retrievedContext()	A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search.
abstract GroundingChunk.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<GroundingChunkWeb>	web()	A grounding chunk from a web page, typically from Google Search.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

GroundingChunk

public GroundingChunk()

Method Details

image

public abstract Optional<GroundingChunkImage> image()

A grounding chunk from an image search result. See the `Image` message for details.

maps

public abstract Optional<GroundingChunkMaps> maps()

A `Maps` chunk is a piece of evidence that comes from Google Maps.

It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.

retrievedContext

public abstract Optional<GroundingChunkRetrievedContext> retrievedContext()

A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details. This field is not supported in Gemini API.

web

public abstract Optional<GroundingChunkWeb> web()

A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.

builder

public static GroundingChunk.Builder builder()

Instantiates a builder for GroundingChunk.

toBuilder

public abstract GroundingChunk.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static GroundingChunk fromJson(String jsonString)

Deserializes a JSON string to a GroundingChunk object.