Struct CreateImageEditRequest

pub struct CreateImageEditRequest {
    pub image: CreateImageEditRequestImage,
    pub prompt: String,
    pub mask: Option<Vec<u8>>,
    pub background: Option<CreateImageEditRequestBackground>,
    pub model: Option<String>,
    pub n: Option<u64>,
    pub size: Option<CreateImageEditRequestSize>,
    pub response_format: Option<CreateImageEditRequestResponseFormat>,
    pub user: Option<String>,
    pub quality: Option<CreateImageEditRequestQuality>,
}

Fields

image: CreateImageEditRequestImage

The image(s) to edit. Must be a supported image file or an array of images.

For gpt-image-1, each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.

For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

prompt: String

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for gpt-image-1.

mask: Option<Vec<u8>>

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

background: Option<CreateImageEditRequestBackground>

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image.

If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

model: Option<String>

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

n: Option<u64>

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

size: Option<CreateImageEditRequestSize>

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

response_format: Option<CreateImageEditRequestResponseFormat>

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. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

user: Option<String>

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

quality: Option<CreateImageEditRequestQuality>

The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

Implementations

impl CreateImageEditRequest

pub fn builder() -> CreateImageEditRequestBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building CreateImageEditRequest. On the builder, call .image(...), .prompt(...), .mask(...)(optional), .background(...)(optional), .model(...)(optional), .n(...)(optional), .size(...)(optional), .response_format(...)(optional), .user(...)(optional), .quality(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateImageEditRequest.

Trait Implementations

impl Clone for CreateImageEditRequest

fn clone(&self) -> CreateImageEditRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateImageEditRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateImageEditRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateImageEditRequest

fn eq(&self, other: &CreateImageEditRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateImageEditRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateImageEditRequest