Package com.google.genai.types

Class ResponseFormat

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ResponseFormat

public abstract class ResponseFormat
extends JsonSerializable

Configuration for the model to configure output formatting and delivery. This data type is not supported in Gemini API.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ResponseFormat()

Method Summary

Modifier and Type	Method	Description
abstract Optional<AudioResponseFormat>	audio()	Audio output format.
static ResponseFormat.Builder	builder()	Instantiates a builder for ResponseFormat.
static ResponseFormat	fromJson(String jsonString)	Deserializes a JSON string to a ResponseFormat object.
abstract Optional<ImageResponseFormat>	image()	Image output format.
abstract Optional<TextResponseFormat>	text()	Text output format.
abstract ResponseFormat.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<VideoResponseFormat>	video()	Video output format.

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

ResponseFormat

public ResponseFormat()

Method Details

audio

public abstract Optional<AudioResponseFormat> audio()

Audio output format.

image

public abstract Optional<ImageResponseFormat> image()

Image output format.

text

public abstract Optional<TextResponseFormat> text()

Text output format.

video

public abstract Optional<VideoResponseFormat> video()

Video output format.

builder

public static ResponseFormat.Builder builder()

Instantiates a builder for ResponseFormat.

toBuilder

public abstract ResponseFormat.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ResponseFormat fromJson(String jsonString)

Deserializes a JSON string to a ResponseFormat object.