Struct CreateImageEditRequest

pub struct CreateImageEditRequest {
    pub image: ImageInput,
    pub prompt: String,
    pub mask: Option<ImageInput>,
    pub model: Option<ImageModel>,
    pub n: Option<u8>,
    pub size: Option<DallE2ImageSize>,
    pub response_format: Option<ImageResponseFormat>,
    pub user: Option<String>,
}

Fields

image: ImageInput

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.

prompt: String

A text description of the desired image(s). The maximum length is 1000 characters.

mask: Option<ImageInput>

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: Option<ImageModel>

The model to use for image generation. Only dall-e-2 is supported at this time.

n: Option<u8>

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

size: Option<DallE2ImageSize>

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

response_format: Option<ImageResponseFormat>

The format in which the generated images are returned. Must be one of url or b64_json.

user: Option<String>

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

Trait Implementations

impl AsyncTryFrom<CreateImageEditRequest> for Form

type Error = OpenAIError

The type returned in the event of a conversion error.

async fn try_from(request: CreateImageEditRequest) -> Result<Self, Self::Error>

Performs the conversion.

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 Default for CreateImageEditRequest

fn default() -> CreateImageEditRequest

Returns the “default value” for a type.

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 StructuralPartialEq for CreateImageEditRequest