GetImagesOptions interface

  • Reference
Package:
@azure/openai

Represents the request data used to generate images.

Extends
OperationOptions

Properties

n

The number of images to generate. Dall-e-3 models only support a value of 1.
quality

The desired image generation quality level to use.
responseFormat

The format in which image generation response items should be presented.
size

The desired dimensions for generated images. Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.
style

The desired image generation style to use.
user

A unique identifier representing your end-user, which can help to monitor and detect abuse.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Property Details

n

The number of images to generate. Dall-e-3 models only support a value of 1.

n?: number

Property Value

number

quality

The desired image generation quality level to use.

quality?: string

Property Value

string

responseFormat

The format in which image generation response items should be presented.

responseFormat?: string

Property Value

string

size

The desired dimensions for generated images. Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792.

size?: string

Property Value

string

style

The desired image generation style to use.

style?: string

Property Value

string

user

A unique identifier representing your end-user, which can help to monitor and detect abuse.

user?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions