google-genai/com.google.genai.types/EditImageConfig

EditImageConfig

public abstract class EditImageConfig extends JsonSerializable

Configuration for editing an image.

Constructors

EditImageConfig

public void EditImageConfig()

Types

Builder

public abstract class Builder

Builder for EditImageConfig.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

addWatermark

public abstract Optional<Boolean> addWatermark()

Whether to add a watermark to the generated images.

aspectRatio

public abstract Optional<String> aspectRatio()

Aspect ratio of the generated images.

baseSteps

public abstract Optional<Integer> baseSteps()

The number of sampling steps.

builder

public static EditImageConfig.Builder builder()

Instantiates a builder for EditImageConfig.

editMode

public abstract Optional<EditMode> editMode()

Describes the editing mode for the request.

fromJson

public static EditImageConfig fromJson(String jsonString)

Deserializes a JSON string to a EditImageConfig object.

fromJsonNode

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

fromJsonString

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

guidanceScale

public abstract Optional<Float> guidanceScale()

Controls how much the model adheres to the text prompt.

httpOptions

public abstract Optional<HttpOptions> httpOptions()

Used to override HTTP request options.

includeRaiReason

public abstract Optional<Boolean> includeRaiReason()

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

includeSafetyAttributes

public abstract Optional<Boolean> includeSafetyAttributes()

Whether to report the safety scores of each generated image and the positive prompt in the response.

labels

public abstract Optional<Map<String, String>> labels()

User specified labels to track billing usage.

language

public abstract Optional<ImagePromptLanguage> language()

Language of the text in the prompt.

negativePrompt

public abstract Optional<String> negativePrompt()

Description of what to discourage in the generated images.

numberOfImages

public abstract Optional<Integer> numberOfImages()

Number of images to generate.

objectMapper

public static ObjectMapper objectMapper()

outputCompressionQuality

public abstract Optional<Integer> outputCompressionQuality()

Compression quality of the generated image (for ``image/jpeg`` only).

outputGcsUri

public abstract Optional<String> outputGcsUri()

Cloud Storage URI used to store the generated images.

outputMimeType

public abstract Optional<String> outputMimeType()

MIME type of the generated image.

personGeneration

public abstract Optional<PersonGeneration> personGeneration()

Allows generation of people by the model.

safetyFilterLevel

public abstract Optional<SafetyFilterLevel> safetyFilterLevel()

Filter level for safety filtering.

seed

public abstract Optional<Integer> seed()

Random seed for image generation.

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

toBuilder

public abstract EditImageConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

toJson

public String toJson()

Serializes the instance to a Json string.

toJsonNode

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

toJsonString

public static String toJsonString(Object object)

Serializes an object to a Json string.