Interface DallEAPIWrapperParams

An interface for the Dall-E API Wrapper.

interface DallEAPIWrapperParams {
    apiKey?: string;
    baseUrl?: string;
    callbacks?: Callbacks;
    dallEResponseFormat?: "url" | "b64_json";
    metadata?: Record<string, unknown>;
    model?: string;
    modelName?: string;
    n?: number;
    openAIApiKey?: string;
    organization?: string;
    quality?: "standard" | "hd";
    responseFormat?: any;
    size?:
        | "256x256"
        | "512x512"
        | "1024x1024"
        | "1792x1024"
        | "1024x1792";
    style?: "natural" | "vivid";
    tags?: string[];
    user?: string;
    verbose?: boolean;
    verboseParsingErrors?: boolean;
}

Hierarchy (view full)

Properties

apiKey? baseUrl? callbacks? dallEResponseFormat? metadata? model? modelName? n? openAIApiKey? organization? quality? responseFormat? size? style? tags? user? verbose? verboseParsingErrors?

Properties

OptionalapiKey

apiKey?: string

The OpenAI API key

OptionalbaseUrl

baseUrl?: string

The base URL of the OpenAI API.

Optionalcallbacks

callbacks?: Callbacks

OptionaldallEResponseFormat

dallEResponseFormat?: "url" | "b64_json"

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

Default

"url"

Optionalmetadata

metadata?: Record<string, unknown>

Optionalmodel

model?: string

The model to use.

Params

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

Default

"dall-e-3"

OptionalmodelName

modelName?: string

The model to use. Alias for model

Params

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

Default

"dall-e-3"

Optionaln

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

OptionalopenAIApiKey

openAIApiKey?: string

The OpenAI API key Alias for apiKey

Optionalorganization

organization?: string

The organization to use

Optionalquality

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"

OptionalresponseFormat

responseFormat?: any

Deprecated

Use dallEResponseFormat instead for the Dall-E response type.

Optionalsize

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"

Optionalstyle

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"

Optionaltags

tags?: string[]

Optionaluser

user?: string

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

Optionalverbose

verbose?: boolean

OptionalverboseParsingErrors

verboseParsingErrors?: boolean

Whether to show full details in the thrown parsing errors.

Default

false

Settings

Member Visibility

On This Page

Properties