Skip to main content

CreateImageVariationRequest

async_openai::types::images

Struct CreateImageVariationRequest

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

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

Available on crate feature image-types only.

Fields§

§image: ImageInput

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

§model: Option<ImageModel>

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

The legacy model used by the retired image variations endpoint. This endpoint no longer accepts requests.

§n: Option<u8>

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

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

§response_format: Option<ImageResponseFormat>

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.

§size: Option<DallE2ImageSize>

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

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

§user: Option<String>

👎Deprecated:

DALL-E 2 and image variations shut down on February 26, 2027.

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

Trait Implementations§

impl AsyncTryFrom<CreateImageVariationRequest> for Form

Available on crate feature _api only.

type Error = OpenAIError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Clone for CreateImageVariationRequest

fn clone(&self) -> Self

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 CreateImageVariationRequest

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

Formats the value using the given formatter. Read more

impl Default for CreateImageVariationRequest

fn default() -> Self

Returns the “default value” for a type. Read more

impl PartialEq for CreateImageVariationRequest

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for CreateImageVariationRequest

Auto Trait Implementations§

impl !Freeze for CreateImageVariationRequest

impl RefUnwindSafe for CreateImageVariationRequest

impl Send for CreateImageVariationRequest

impl Sync for CreateImageVariationRequest

impl Unpin for CreateImageVariationRequest

impl UnsafeUnpin for CreateImageVariationRequest

impl UnwindSafe for CreateImageVariationRequest

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> MaybeSend for T
where T: Send,

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> Same for T

type Output = T

Should always be Self

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 = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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