ImageGenerationArgs

async_openai_compat::types::responses

Struct ImageGenerationArgs 

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

Builder for ImageGenTool.

Implementations§

Source§

impl ImageGenerationArgs

Source

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

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

Source

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

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

Source

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

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Source

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

The image generation model to use. Default: gpt-image-1.

Source

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

Moderation level for the generated image. Default: auto.

Source

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

Compression level for the output image. Default: 100.

Source

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

The output format of the generated image. One of png, webp, or jpeg. Default: png.

Source

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

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

Source

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

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

Source

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

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

Source

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

Builds a new ImageGenTool.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Clone for ImageGenerationArgs

Source§

fn clone(&self) -> ImageGenerationArgs

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ImageGenerationArgs

Source§

fn default() -> Self

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

Auto Trait Implementations§

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.

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
§

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.

Source§

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

Source§

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
Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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