Skip to main content

ImageEditRequest

kcode_openai_api

Struct ImageEditRequest

pub struct ImageEditRequest {
    pub images: Vec<ImageInput>,
    pub prompt: String,
    pub size: ImageSize,
    pub quality: ImageQuality,
    pub output_format: ImageFormat,
    pub output_compression: Option<u8>,
    pub background: ImageBackground,
    pub moderation: Moderation,
    pub user: Option<String>,
}

Expand description

One GPT Image 2 request that modifies or combines reference images.

Fields§

§images: Vec<ImageInput>

One or more source or reference images.

§prompt: String

Text description of the requested result.

§size: ImageSize

Output dimensions.

§quality: ImageQuality

Rendering quality.

§output_format: ImageFormat

Output file format.

§output_compression: Option<u8>

JPEG or WebP compression from 0 through 100, when explicitly requested.

§background: ImageBackground

Background behavior.

§moderation: Moderation

Provider moderation level.

§user: Option<String>

Optional stable end-user identifier supplied to abuse monitoring.

Implementations§

impl ImageEditRequest

pub fn new(image: ImageInput, prompt: impl Into<String>) -> Self

Constructs a single-reference edit with automatic size and quality.

Trait Implementations§

impl Clone for ImageEditRequest

fn clone(&self) -> ImageEditRequest

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

impl Debug for ImageEditRequest

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

Formats the value using the given formatter. Read more

impl Eq for ImageEditRequest

impl PartialEq for ImageEditRequest

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for ImageEditRequest

Auto Trait Implementations§

impl Freeze for ImageEditRequest

impl RefUnwindSafe for ImageEditRequest

impl Send for ImageEditRequest

impl Sync for ImageEditRequest

impl Unpin for ImageEditRequest

impl UnsafeUnpin for ImageEditRequest

impl UnwindSafe for ImageEditRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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