Skip to main content

EditImageJsonRequestArgs

Struct EditImageJsonRequestArgs 

Source
pub struct EditImageJsonRequestArgs { /* private fields */ }
Expand description

Builder for EditImageJsonRequest.

Implementations§

Source§

impl EditImageJsonRequestArgs

Source

pub fn model<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageModel>,

The model to use for image editing.

Source

pub fn images<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<Vec<ImageRefParam>>,

Input image references to edit. For GPT image models, you can provide up to 16 images.

Source

pub fn mask<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageRefParam>,

An optional mask image reference indicating which areas of the image should be edited.

Source

pub fn prompt<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<String>,

A text description of the desired image edit.

Source

pub fn n<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<u8>,

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

Source

pub fn quality<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageQuality>,

The quality of the image that will be generated.

Source

pub fn input_fidelity<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<InputFidelity>,

Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports high and low. Defaults to low.

Source

pub fn size<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageSize>,

The size of the generated image.

Source

pub fn user<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<String>,

A unique identifier representing your end-user.

Source

pub fn output_format<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageOutputFormat>,

The output format for the generated image.

Source

pub fn output_compression<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<u8>,

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

Source

pub fn moderation<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageModeration>,

Control the content-moderation level for images.

Source

pub fn background<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<ImageBackground>,

The background style for the generated image.

Source

pub fn stream<VALUE>(&mut self, value: VALUE) -> &mut EditImageJsonRequestArgs
where VALUE: Into<bool>,

Whether to stream the image generation. Defaults to false.

Source

pub fn partial_images<VALUE>( &mut self, value: VALUE, ) -> &mut EditImageJsonRequestArgs
where VALUE: Into<u8>,

The number of partial images to generate during streaming.

Source

pub fn build(&self) -> Result<EditImageJsonRequest, OpenAIError>

Builds a new EditImageJsonRequest.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Clone for EditImageJsonRequestArgs

Source§

fn clone(&self) -> EditImageJsonRequestArgs

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 EditImageJsonRequestArgs

Source§

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

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

impl Default for EditImageJsonRequestArgs

Source§

fn default() -> EditImageJsonRequestArgs

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more