Package com.azure.ai.openai.models

Class ImageGenerationResponseFormat

java.lang.Object

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

com.azure.ai.openai.models.ImageGenerationResponseFormat

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

The format in which the generated images are returned.

Field Summary

Fields

Modifier and Type	Field	Description
static final ImageGenerationResponseFormat	BASE64	Image generation response items should provide image data as a base64-encoded string.
static final ImageGenerationResponseFormat	URL	Image generation response items should provide a URL from which the image may be retrieved.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

URL

public static final ImageGenerationResponseFormat URL

Image generation response items should provide a URL from which the image may be retrieved.

BASE64

public static final ImageGenerationResponseFormat BASE64

Image generation response items should provide image data as a base64-encoded string.

Constructor Details

ImageGenerationResponseFormat

@Deprecated
public ImageGenerationResponseFormat()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ImageGenerationResponseFormat value.

Method Details

fromString

public static ImageGenerationResponseFormat fromString(String name)

Creates or finds a ImageGenerationResponseFormat from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ImageGenerationResponseFormat.

values

public static Collection<ImageGenerationResponseFormat> values()

Gets known ImageGenerationResponseFormat values.

Returns:

known ImageGenerationResponseFormat values.