Package com.google.genai.types

Class EditImageParameters

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.EditImageParameters

@InternalApi
public abstract class EditImageParameters
extends JsonSerializable

Parameters for the request to edit an image.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
EditImageParameters()

Method Summary

Modifier and Type	Method	Description
static EditImageParameters.Builder	builder()	Instantiates a builder for EditImageParameters.
abstract Optional<EditImageConfig>	config()	Configuration for editing.
static EditImageParameters	fromJson(String jsonString)	Deserializes a JSON string to a EditImageParameters object.
abstract Optional<String>	model()	The model to use.
abstract Optional<String>	prompt()	A text description of the edit to apply to the image.
abstract Optional<List<ReferenceImageAPI>>	referenceImages()	The reference images for editing.
abstract EditImageParameters.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

EditImageParameters

public EditImageParameters()

Method Details

model

public abstract Optional<String> model()

The model to use.

prompt

public abstract Optional<String> prompt()

A text description of the edit to apply to the image.

referenceImages

public abstract Optional<List<ReferenceImageAPI>> referenceImages()

The reference images for editing.

config

public abstract Optional<EditImageConfig> config()

Configuration for editing.

builder

public static EditImageParameters.Builder builder()

Instantiates a builder for EditImageParameters.

toBuilder

public abstract EditImageParameters.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static EditImageParameters fromJson(String jsonString)

Deserializes a JSON string to a EditImageParameters object.