ImageRequest class

Annotations
  • @freezed

Constructors

ImageRequest({required String prompt, @Default(Models.dallE2) String model, int? n, String? quality, String? size, String? responseFormat, String? style, String? user})
const
factory
ImageRequest.fromJson(dynamic json)
factory

Properties

copyWith → $ImageRequestCopyWith<ImageRequest>
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
model String
The model to use for image generation. Must be one of dall-e-2 or dall-e-3.
no setterinherited
n int?
The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported. Defaults to 1
no setterinherited
prompt String
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.
no setterinherited
quality String?
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. Defaults to standard
no setterinherited
responseFormat String?
Defaults to url The format in which the generated images are returned. Must be one of url or b64_json.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
size String?
Defaults to 1024x1024 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.
no setterinherited
style String?
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. Defaults to vivid
no setterinherited
user String?
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
no setterinherited

Methods

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

Operators

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