Struct ImageOptions 

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

Options for one ImageModel::do_generate call.

Fields

prompt: String

Prompt describing the desired image.

n: Option<u32>

Number of images to generate.

size: Option<String>

Size, formatted as WIDTHxHEIGHT (e.g. "1024x1024").

aspect_ratio: Option<String>

Aspect ratio (e.g. "16:9").

seed: Option<u64>

Random seed for deterministic generation.

files: Option<Vec<FilePart>>

Source images for editing / variation endpoints.

Plain do_generate (text → image) ignores this field. Edit / variation endpoints take the first entry as the source; OpenAI’s edit endpoint accepts multiple files.

mask: Option<FilePart>

Optional mask for image edits (transparent regions = areas to edit).

headers: Option<Headers>

Extra HTTP headers (HTTP providers only).

provider_options: Option<ProviderOptions>

Provider-specific options.

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() -> ImageOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.