Package com.google.genai.types

Class GeneratedImage

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.GeneratedImage

public abstract class GeneratedImage
extends JsonSerializable

An output image.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
GeneratedImage()

Method Summary

Modifier and Type	Method	Description
static GeneratedImage.Builder	builder()	Instantiates a builder for GeneratedImage.
abstract Optional<String>	enhancedPrompt()	The rewritten prompt used for the image generation if the prompt enhancer is enabled.
static GeneratedImage	fromJson(String jsonString)	Deserializes a JSON string to a GeneratedImage object.
abstract Optional<Image>	image()	The output image data.
abstract Optional<String>	raiFilteredReason()	Responsible AI filter reason if the image is filtered out of the response.
abstract Optional<SafetyAttributes>	safetyAttributes()	Safety attributes of the image.
abstract GeneratedImage.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

toJson

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GeneratedImage

public GeneratedImage()

Method Details

image

public abstract Optional<Image> image()

The output image data.

raiFilteredReason

public abstract Optional<String> raiFilteredReason()

Responsible AI filter reason if the image is filtered out of the response.

safetyAttributes

public abstract Optional<SafetyAttributes> safetyAttributes()

Safety attributes of the image. Lists of RAI categories and their scores of each content.

enhancedPrompt

public abstract Optional<String> enhancedPrompt()

The rewritten prompt used for the image generation if the prompt enhancer is enabled.

builder

public static GeneratedImage.Builder builder()

Instantiates a builder for GeneratedImage.

toBuilder

public abstract GeneratedImage.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static GeneratedImage fromJson(String jsonString)

Deserializes a JSON string to a GeneratedImage object.