Struct ImageEditParameters

pub struct ImageEditParameters {
    pub image: String,
    pub mask: Option<String>,
    pub prompt: String,
    pub num_images: Option<i32>,
    pub image_size: Option<String>,
    pub response_format: Option<String>,
    pub user: Option<String>,
}

Fields

image: String

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

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.

prompt: String

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

num_images: Option<i32>

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

image_size: Option<String>

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

response_format: Option<String>

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 can help OpenAI to monitor and detect abuse. Learn more.

Implementations

impl ImageEditParameters

pub fn new(image: String, prompt: String) -> Self

pub fn mask(self, mask: String) -> Self

pub fn num_images(self, num_images: i32) -> Self

pub fn image_size(self, image_size: String) -> Self

pub fn response_format(self, response_format: String) -> Self

pub fn user(self, user: String) -> Self

pub fn build(self) -> ImageEditParameters

Trait Implementations

impl Debug for ImageEditParameters

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageEditParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageEditParameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.