Struct ImageOptions 

pub struct ImageOptions {
    pub prompt: Option<String>,
    pub n: u32,
    pub size: Option<ImageSize>,
    pub aspect_ratio: Option<AspectRatio>,
    pub seed: Option<u64>,
    pub files: Vec<ImageFile>,
    pub mask: Option<ImageFile>,
    pub provider_options: ProviderOptions,
    pub headers: Headers,
    pub cancellation: CancellationToken,
}

Options for an image generation call.

Fields

prompt: Option<String>

Text prompt; None for pure edit/variation calls.

n: u32

Number of images to generate.

size: Option<ImageSize>

Requested size.

aspect_ratio: Option<AspectRatio>

Requested aspect ratio.

seed: Option<u64>

Random seed.

files: Vec<ImageFile>

Reference or input images.

mask: Option<ImageFile>

Mask image for edits.

provider_options: ProviderOptions

Provider-specific options keyed by provider name.

headers: Headers

Additional request headers.

cancellation: CancellationToken

Cancellation token.

Implementations

impl ImageOptions

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

Creates options for prompt requesting one image.

Trait Implementations

impl Clone for ImageOptions

fn clone(&self) -> ImageOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageOptions

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

Formats the value using the given formatter.

impl Default for ImageOptions

fn default() -> Self

Returns the “default value” for a type.