ImageGenerationBuilder

Struct ImageGenerationBuilder 

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

Builder for image generation (/images/generations).

Implementations§

Source§

impl ImageGenerationBuilder

Source

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

Create a new generation builder with the required prompt text.

Source

pub fn model(self, model: impl Into<String>) -> Self

Override the model (gpt-image-1, dall-e-3, etc.).

Source

pub fn n(self, n: i32) -> Self

Set how many images to generate (1-10).

Source

pub fn quality(self, quality: Quality) -> Self

Select image quality.

Source

pub fn response_format(self, format: ResponseFormat) -> Self

Select the response format for dall-e-* models.

Source

pub fn output_format(self, format: OutputFormat) -> Self

Choose the binary output format (only supported for gpt-image-1).

Source

pub fn output_compression(self, compression: i32) -> Self

Tune image compression (0-100). Only applies to JPEG/WEBP outputs.

Source

pub fn stream(self, stream: bool) -> Self

Enable streaming responses.

Source

pub fn partial_images(self, partial_images: Option<i32>) -> Self

Configure the number of partial images to emit when streaming (0-3).

Source

pub fn size(self, size: Size) -> Self

Select the output size preset.

Source

pub fn moderation(self, moderation: Moderation) -> Self

Control content moderation (auto/low).

Source

pub fn background(self, background: Background) -> Self

Configure transparent/opaque backgrounds.

Source

pub fn style(self, style: Style) -> Self

Select stylistic hints supported by dall-e-3.

Source

pub fn user(self, user: impl Into<String>) -> Self

Attach an end-user identifier for abuse monitoring.

Source

pub fn prompt(&self) -> &str

Borrow the configured prompt.

Trait Implementations§

Source§

impl Builder<CreateImageRequest> for ImageGenerationBuilder

Source§

fn build(self) -> Result<CreateImageRequest>

Build the final request type.
Source§

impl Clone for ImageGenerationBuilder

Source§

fn clone(&self) -> ImageGenerationBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImageGenerationBuilder

Source§

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

Formats the value using the given formatter. 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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> 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
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<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
Source§

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