google-genai/com.google.genai.types/GroundingMetadata

GroundingMetadata

public abstract class GroundingMetadata extends JsonSerializable

Information for various kinds of grounding.

Constructors

Link copied to clipboard
public void GroundingMetadata()

Types

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

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 GroundingMetadata.Builder builder()
Instantiates a builder for GroundingMetadata.
Link copied to clipboard
public static GroundingMetadata fromJson(String jsonString)
Deserializes a JSON string to a GroundingMetadata 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> googleMapsWidgetContextToken()
Optional.
Link copied to clipboard
public abstract Optional<List<GroundingChunk>> groundingChunks()
A list of supporting references retrieved from the grounding source.
Link copied to clipboard
public abstract Optional<List<GroundingSupport>> groundingSupports()
List of grounding support.
Link copied to clipboard
public abstract Optional<List<String>> imageSearchQueries()
Optional.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<RetrievalMetadata> retrievalMetadata()
Metadata related to retrieval in the grounding flow.
Link copied to clipboard
public abstract Optional<List<String>> retrievalQueries()
Optional.
Link copied to clipboard
public abstract Optional<SearchEntryPoint> searchEntryPoint()
Optional.
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
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract GroundingMetadata.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<List<String>> webSearchQueries()
Web search queries for the following-up web search.