Package com.azure.ai.openai.models

Class ImageSize

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ImageSize>

com.azure.ai.openai.models.ImageSize

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class ImageSize
extends com.azure.core.util.ExpandableStringEnum<ImageSize>

The desired size of generated images.

Field Summary

Fields

Modifier and Type	Field	Description
static final ImageSize	SIZE1024X1024	A standard, square image size of 1024x1024 pixels.
static final ImageSize	SIZE1024X1792	A taller image size of 1792x1024 pixels.
static final ImageSize	SIZE1792X1024	A wider image size of 1024x1792 pixels.
static final ImageSize	SIZE256X256	Very small image size of 256x256 pixels.
static final ImageSize	SIZE512X512	A smaller image size of 512x512 pixels.

Constructor Summary

Constructors

Constructor	Description
ImageSize()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ImageSize	fromString(String name)	Creates or finds a ImageSize from its string representation.
static Collection<ImageSize>	values()	Gets known ImageSize values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SIZE256X256

public static final ImageSize SIZE256X256

Very small image size of 256x256 pixels. Only supported with dall-e-2 models.

SIZE512X512

public static final ImageSize SIZE512X512

A smaller image size of 512x512 pixels. Only supported with dall-e-2 models.

SIZE1024X1024

public static final ImageSize SIZE1024X1024

A standard, square image size of 1024x1024 pixels. Supported by both dall-e-2 and dall-e-3 models.

SIZE1792X1024

public static final ImageSize SIZE1792X1024

A wider image size of 1024x1792 pixels. Only supported with dall-e-3 models.

SIZE1024X1792

public static final ImageSize SIZE1024X1792

A taller image size of 1792x1024 pixels. Only supported with dall-e-3 models.

Constructor Details

ImageSize

@Deprecated
public ImageSize()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ImageSize value.

Method Details

fromString

public static ImageSize fromString(String name)

Creates or finds a ImageSize from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ImageSize.

values

public static Collection<ImageSize> values()

Gets known ImageSize values.

Returns:

known ImageSize values.