image_generate_params
Classes:
Name | Description |
---|---|
ImageGenerateParams |
|
ImageGenerateParams
Attributes:
Name | Type | Description |
---|---|---|
model |
Union[str, Literal['dall-e-2', 'dall-e-3'], None]
|
The model to use for image generation. |
n |
Optional[int]
|
The number of images to generate. |
prompt |
Required[str]
|
A text description of the desired image(s). |
quality |
Literal['standard', 'hd']
|
The quality of the image that will be generated. |
response_format |
Optional[Literal['url', 'b64_json']]
|
The format in which the generated images are returned. |
size |
Optional[Literal['256x256', '512x512', '1024x1024', '1792x1024', '1024x1792']]
|
The size of the generated images. |
style |
Optional[Literal['vivid', 'natural']]
|
The style of the generated images. |
user |
str
|
A unique identifier representing your end-user, which can help OpenAI to monitor |
model
instance-attribute
The model to use for image generation.
n
instance-attribute
The number of images to generate.
Must be between 1 and 10. For dall-e-3
, only n=1
is supported.
prompt
instance-attribute
prompt: Required[str]
A text description of the desired image(s).
The maximum length is 1000 characters for dall-e-2
and 4000 characters for
dall-e-3
.
quality
instance-attribute
The quality of the image that will be generated.
hd
creates images with finer details and greater consistency across the image.
This param is only supported for dall-e-3
.
response_format
instance-attribute
response_format: Optional[Literal['url', 'b64_json']]
The format in which the generated images are returned.
Must be one of url
or b64_json
. URLs are only valid for 60 minutes after the
image has been generated.
size
instance-attribute
size: Optional[
Literal[
"256x256",
"512x512",
"1024x1024",
"1792x1024",
"1024x1792",
]
]
The size of the generated images.
Must be one of 256x256
, 512x512
, or 1024x1024
for dall-e-2
. Must be one
of 1024x1024
, 1792x1024
, or 1024x1792
for dall-e-3
models.
style
instance-attribute
style: Optional[Literal['vivid', 'natural']]
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. This param is only supported for
dall-e-3
.
user
instance-attribute
user: str
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.