image_edit_params

Classes:

Name	Description
`ImageEditParams`

Attributes:

Name	Type	Description
`image`	`Required[FileTypes]`	The image to edit.
`mask`	`FileTypes`	An additional image whose fully transparent areas (e.g.
`model`	`Union[str, Literal['dall-e-2'], None]`	The model to use for image generation.
`n`	`Optional[int]`	The number of images to generate. Must be between 1 and 10.
`prompt`	`Required[str]`	A text description of the desired image(s).
`response_format`	`Optional[Literal['url', 'b64_json']]`	The format in which the generated images are returned.
`size`	`Optional[Literal['256x256', '512x512', '1024x1024']]`	The size of the generated images.
`user`	`str`	A unique identifier representing your end-user, which can help OpenAI to monitor

image: Required[FileTypes]

The image to edit.

Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

mask: FileTypes

An additional image whose fully transparent areas (e.g.

where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

model: Union[str, Literal['dall-e-2'], None]

The model to use for image generation.

Only dall-e-2 is supported at this time.

n: Optional[int]

The number of images to generate. Must be between 1 and 10.

prompt: Required[str]

A text description of the desired image(s).

The maximum length is 1000 characters.

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: Optional[Literal['256x256', '512x512', '1024x1024']]

The size of the generated images.

Must be one of 256x256, 512x512, or 1024x1024.

user: str

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