google-genai/com.google.genai.types/ControlReferenceImage

ControlReferenceImage

public abstract class ControlReferenceImage extends JsonSerializable implements ReferenceImage

A control reference image.

The image of the control reference image is either a control image provided by the user, or a regular image which the backend will use to generate a control image of. In the case of the latter, the enable_control_image_computation field in the config should be set to True.

A control image is an image that represents a sketch image of areas for the model to fill in based on the prompt.

Constructors

ControlReferenceImage

public void ControlReferenceImage()

Types

public abstract class Builder

Builder for ControlReferenceImage.

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

public static ControlReferenceImage.Builder builder()

Instantiates a builder for ControlReferenceImage.

public abstract Optional<ControlReferenceConfig> config()

Configuration for the control reference image.

public static ControlReferenceImage fromJson(String jsonString)

Deserializes a JSON string to a ControlReferenceImage object.

@InternalApi()

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

Deserializes a JsonNode to an object of the given type.

@InternalApi()

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

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

public static ObjectMapper objectMapper()

public abstract Optional<Integer> referenceId()

The id of the reference image.

public abstract Optional<Image> referenceImage()

The reference image for the editing operation.

public abstract Optional<String> referenceType()

The type of the reference image.

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.

public abstract ControlReferenceImage.Builder toBuilder()

Creates a builder with the same values as this instance.

public String toJson()

Serializes the instance to a Json string.

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

public static String toJsonString(Object object)

Serializes an object to a Json string.

toReferenceImageAPI

public ReferenceImageAPI toReferenceImageAPI()