google-genai/com.google.genai.interactions.models.interactions/Interaction/ResponseFormat

ResponseFormat

public final class ResponseFormat

Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

Types

InnerResponseFormat

public final class InnerResponseFormat

Configuration for audio output format.

Visitor

public interface Visitor<T extends Object>

An interface that defines how to map each variant of ResponseFormat to a value of type T.

Functions

_json

public final Optional<JsonValue> _json()

public final T accept<T extends Any>(Interaction.ResponseFormat.Visitor<T> visitor)

asAudio

public final AudioResponseFormat asAudio()

Configuration for audio output format.

asImage

public final ImageResponseFormat asImage()

Configuration for image output format.

asJsonValue

public final JsonValue asJsonValue()

asList

public final List<Interaction.ResponseFormat.InnerResponseFormat> asList()

asText

public final TextResponseFormat asText()

Configuration for text output format.

audio

public final Optional<AudioResponseFormat> audio()

Configuration for audio output format.

equals

public Boolean equals(Object other)

hashCode

public Integer hashCode()

image

public final Optional<ImageResponseFormat> image()

Configuration for image output format.

isAudio

public final Boolean isAudio()

isImage

public final Boolean isImage()

isJsonValue

public final Boolean isJsonValue()

isList

public final Boolean isList()

isText

public final Boolean isText()

isValid

public final Boolean isValid()

jsonValue

public final Optional<JsonValue> jsonValue()

list

public final Optional<List<Interaction.ResponseFormat.InnerResponseFormat>> list()

ofAudio

public final static Interaction.ResponseFormat ofAudio(AudioResponseFormat audio)

Configuration for audio output format.

ofImage

public final static Interaction.ResponseFormat ofImage(ImageResponseFormat image)

Configuration for image output format.

ofJsonValue

public final static Interaction.ResponseFormat ofJsonValue(JsonValue jsonValue)

ofList

public final static Interaction.ResponseFormat ofList(List<Interaction.ResponseFormat.InnerResponseFormat> list)

ofText

public final static Interaction.ResponseFormat ofText(TextResponseFormat text)

Configuration for text output format.

text

public final Optional<TextResponseFormat> text()

Configuration for text output format.

toString

public String toString()

validate

public final Interaction.ResponseFormat validate()