Interface DallEAPIWrapperParams

An interface for the Dall-E API Wrapper.

interface DallEAPIWrapperParams {
    apiKey?: string;
    model?: string;
    modelName?: string;
    n?: number;
    openAIApiKey?: string;
    organization?: string;
    quality?: "standard" | "hd";
    responseFormat?: "url" | "b64_json";
    size?: "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792";
    style?: "natural" | "vivid";
    user?: string;
}

Hierarchy (view full)

Properties

apiKey? model? modelName? n? openAIApiKey? organization? quality? responseFormat? size? style? user?

Properties

Optional apiKey

apiKey?: string

The OpenAI API key

Optional model

model?: string

The model to use.

Params

"dall-e-2" | "dall-e-3"

Default

"dall-e-3"

Optional modelName

modelName?: string

The model to use. Alias for model

Params

"dall-e-2" | "dall-e-3"

Default

"dall-e-3"

Optional n

n?: number

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n: 1 is supported.

Default

1

Optional openAIApiKey

openAIApiKey?: string

The OpenAI API key Alias for apiKey

Optional organization

organization?: string

The organization to use

Optional quality

quality?: "standard" | "hd"

The quality of the image that will be generated. ‘hd’ creates images with finer details and greater consistency across the image.

Default

"standard"

Optional responseFormat

responseFormat?: "url" | "b64_json"

The format in which the generated images are returned. Must be one of "url" or "b64_json".

Default

"url"

Optional size

size?: "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792"

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for DALL·E-2 models. Must be one of 1024x1024, 1792x1024, or 1024x1792 for DALL·E-3 models.

Default

"1024x1024"

Optional style

style?: "natural" | "vivid"

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

Default

"vivid"

Optional user

user?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc