ImageGenerationOptions Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

ImageGenerationOptions.cs

Represents the request data used to generate images.

public class ImageGenerationOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ImageGenerationOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ImageGenerationOptions>

type ImageGenerationOptions = class
    interface IJsonModel<ImageGenerationOptions>
    interface IPersistableModel<ImageGenerationOptions>

Public Class ImageGenerationOptions
Implements IJsonModel(Of ImageGenerationOptions), IPersistableModel(Of ImageGenerationOptions)

Inheritance

Object

ImageGenerationOptions

Implements

IJsonModel<ImageGenerationOptions> IPersistableModel<ImageGenerationOptions> IPersistableModel<T>

Constructors

ImageGenerationOptions()	Initializes a new instance of ImageGenerationOptions.
ImageGenerationOptions(String)	Initializes a new instance of ImageGenerationOptions.

Properties

DeploymentName	The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be inferred as a default.
ImageCount	The number of images to generate. Dall-e-2 models support values between 1 and 10. Dall-e-3 models only support a value of 1.
Prompt	Gets or sets the description used to influence the generation of requested images.
Quality	The desired image generation quality level to use. Only configurable with dall-e-3 models.
Size	The desired dimensions for generated images. Dall-e-2 models support 256x256, 512x512, or 1024x1024. Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.
Style	The desired image generation style to use. Only configurable with dall-e-3 models.
User	A unique identifier representing your end-user, which can help to monitor and detect abuse.

Explicit Interface Implementations

IJsonModel<ImageGenerationOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ImageGenerationOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ImageGenerationOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ImageGenerationOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ImageGenerationOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.