EditImageRequest class

Constructors

EditImageRequest({required EditFile image, EditFile? mask, required String prompt, int n = 2, ImageSize size = ImageSize.size1024, Format responseFormat = Format.url, String? user})

Properties

hashCode int
The hash code for this object.
no setterinherited
image EditFile
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.image file name is image
final
mask EditFile?
An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image. mask file name is mask
final
n int
The number of images to generate. Must be between 1 and 10.n
final
prompt String
A text description of the desired image(s). The maximum length is 1000 characters.prompt
final
responseFormat Format
The format in which the generated images are returned. Must be one of or .url b64_json .responseFormat
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
size ImageSize
The size of the generated images.size
final
user String?
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.user
final

Methods

convert() Future<FormData>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited