Package com.google.genai.types

Class GroundingChunkCustomMetadata

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.GroundingChunkCustomMetadata

public abstract class GroundingChunkCustomMetadata
extends JsonSerializable

User provided metadata about the GroundingFact. This data type is not supported in Vertex AI.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
GroundingChunkCustomMetadata()

Method Summary

Modifier and Type	Method	Description
static GroundingChunkCustomMetadata.Builder	builder()	Instantiates a builder for GroundingChunkCustomMetadata.
static GroundingChunkCustomMetadata	fromJson(String jsonString)	Deserializes a JSON string to a GroundingChunkCustomMetadata object.
abstract Optional<String>	key()	The key of the metadata.
abstract Optional<Float>	numericValue()	Optional.
abstract Optional<GroundingChunkStringList>	stringListValue()	Optional.
abstract Optional<String>	stringValue()	Optional.
abstract GroundingChunkCustomMetadata.Builder	toBuilder()	Creates a builder with the same values as this instance.

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

GroundingChunkCustomMetadata

public GroundingChunkCustomMetadata()

Method Details

key

public abstract Optional<String> key()

The key of the metadata.

numericValue

public abstract Optional<Float> numericValue()

Optional. The numeric value of the metadata. The expected range for this value depends on the specific `key` used.

stringListValue

public abstract Optional<GroundingChunkStringList> stringListValue()

Optional. A list of string values for the metadata.

stringValue

public abstract Optional<String> stringValue()

Optional. The string value of the metadata.

builder

public static GroundingChunkCustomMetadata.Builder builder()

Instantiates a builder for GroundingChunkCustomMetadata.

toBuilder

public abstract GroundingChunkCustomMetadata.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static GroundingChunkCustomMetadata fromJson(String jsonString)

Deserializes a JSON string to a GroundingChunkCustomMetadata object.