Package com.google.genai.types

Class TextResponseFormat

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.TextResponseFormat

public abstract class TextResponseFormat
extends JsonSerializable

Configuration for text-specific output formatting.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TextResponseFormat()

Method Summary

Modifier and Type	Method	Description
static TextResponseFormat.Builder	builder()	Instantiates a builder for TextResponseFormat.
static TextResponseFormat	fromJson(String jsonString)	Deserializes a JSON string to a TextResponseFormat object.
abstract Optional<String>	mimeType()	Optional.
abstract Optional<Object>	schema()	Optional.
abstract TextResponseFormat.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

TextResponseFormat

public TextResponseFormat()

Method Details

mimeType

public abstract Optional<String> mimeType()

Optional. The IANA standard MIME type of the response.

schema

public abstract Optional<Object> schema()

Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.

builder

public static TextResponseFormat.Builder builder()

Instantiates a builder for TextResponseFormat.

toBuilder

public abstract TextResponseFormat.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static TextResponseFormat fromJson(String jsonString)

Deserializes a JSON string to a TextResponseFormat object.