Class ImageGenerateParams.Size
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ImageGenerateParams.Size implements EnumThe size of the generated images. For
gpt-image-2andgpt-image-2-2026-04-21, arbitrary resolutions are supported asWIDTHxHEIGHTstrings, for example1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above2560x1440are experimental, and the maximum supported resolution is3840x2160. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes1024x1024,1536x1024, and1024x1536are supported by the GPT image models;autois supported for models that allow automatic sizing. Fordall-e-2, use one of256x256,512x512, or1024x1024. Fordall-e-3, use one of1024x1024,1792x1024, or1024x1792.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumImageGenerateParams.Size.KnownAn enum containing Size's known values.
public enumImageGenerateParams.Size.ValueAn enum containing Size's known values, as well as an _UNKNOWN member.
An instance of Size can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static ImageGenerateParams.SizeAUTOpublic final static ImageGenerateParams.Size_1024X1024public final static ImageGenerateParams.Size_1536X1024public final static ImageGenerateParams.Size_1024X1536public final static ImageGenerateParams.Size_256X256public final static ImageGenerateParams.Size_512X512public final static ImageGenerateParams.Size_1792X1024public final static ImageGenerateParams.Size_1024X1792
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final ImageGenerateParams.Size.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final ImageGenerateParams.Size.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final ImageGenerateParams.Sizevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ImageGenerateParams.Sizeof(String value)-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final ImageGenerateParams.Size.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final ImageGenerateParams.Size.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final ImageGenerateParams.Size validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
of
final static ImageGenerateParams.Size of(String value)
-
-
-
-