Skip to main content

ImageEditParamsBase

Struct ImageEditParamsBase 

Source
pub struct ImageEditParamsBase {
Show 14 fields pub image: Value, pub prompt: String, pub background: Option<ImageEditParamsBaseBackground>, pub input_fidelity: Option<ImageEditParamsBaseInputFidelity>, pub mask: Option<Value>, pub model: Option<String>, pub n: Option<i64>, pub output_compression: Option<i64>, pub output_format: Option<ImageEditParamsBaseOutputFormat>, pub partial_images: Option<i64>, pub quality: Option<ImageEditParamsBaseQuality>, pub response_format: Option<ImageEditParamsBaseResponseFormat>, pub size: Option<ImageEditParamsBaseSize>, pub user: Option<String>,
}

Fields§

§image: Value

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

§prompt: String

A text description of the desired image(s).

§background: Option<ImageEditParamsBaseBackground>

Allows to set transparency for the background of the generated image(s). This

§input_fidelity: Option<ImageEditParamsBaseInputFidelity>

Control how much effort the model will exert to match the style and features,

§mask: Option<Value>

An additional image whose fully transparent areas (e.g.

§model: Option<String>

The model to use for image generation. Defaults to gpt-image-1.5.

§n: Option<i64>

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

§output_compression: Option<i64>

The compression level (0-100%) for the generated images.

§output_format: Option<ImageEditParamsBaseOutputFormat>

The format in which the generated images are returned.

§partial_images: Option<i64>

The number of partial images to generate.

§quality: Option<ImageEditParamsBaseQuality>

The quality of the image that will be generated for GPT image models.

§response_format: Option<ImageEditParamsBaseResponseFormat>

The format in which the generated images are returned.

§size: Option<ImageEditParamsBaseSize>

The size of the generated images.

§user: Option<String>

A unique identifier representing your end-user, which can help OpenAI to monitor

Trait Implementations§

Source§

impl Clone for ImageEditParamsBase

Source§

fn clone(&self) -> ImageEditParamsBase

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImageEditParamsBase

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ImageEditParamsBase

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ImageEditParamsBase

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.