async_openai::types

Struct CreateImageRequestArgs

pub struct CreateImageRequestArgs { /* private fields */ }

Expand description

Builder for CreateImageRequest.

Implementations§

impl CreateImageRequestArgs

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

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

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

The model to use for image generation.

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

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

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

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

pub fn response_format<VALUE: Into<ImageResponseFormat>>( &mut self, value: VALUE, ) -> &mut Self

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.

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

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

pub fn style<VALUE: Into<ImageStyle>>(&mut self, value: VALUE) -> &mut Self

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

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

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

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

Builds a new CreateImageRequest.

§Errors

If a required field has not been initialized.

Trait Implementations§

impl Clone for CreateImageRequestArgs

fn clone(&self) -> CreateImageRequestArgs

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CreateImageRequestArgs

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

Formats the value using the given formatter. Read more

impl Default for CreateImageRequestArgs

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for CreateImageRequestArgs

impl RefUnwindSafe for CreateImageRequestArgs

impl Send for CreateImageRequestArgs

impl Sync for CreateImageRequestArgs

impl Unpin for CreateImageRequestArgs

impl UnwindSafe for CreateImageRequestArgs

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

impl<T> ErasedDestructor for T
where T: 'static,