Struct ImageCallOptions 

pub struct ImageCallOptions {
    pub prompt: Option<String>,
    pub n: u32,
    pub size: Option<Size>,
    pub aspect_ratio: Option<AspectRatio>,
    pub seed: Option<u64>,
    pub files: Option<Vec<ImageFile>>,
    pub mask: Option<ImageFile>,
    pub provider_options: SharedProviderOptions,
    pub abort_signal: Option<AbortSignal>,
    pub max_retries: Option<u32>,
    pub timeout: Option<TimeoutConfiguration>,
    pub headers: Option<SharedHeaders>,
}

Options passed to ImageModel::do_generate.

Aligned with V4 ImageModelV4CallOptions.

Fields

prompt: Option<String>

Prompt for the image generation. None for operations (e.g. upscaling) that do not require a prompt.

n: u32

Number of images to generate.

size: Option<Size>

Size of the images, in {width}x{height} format. None uses the provider’s default size.

aspect_ratio: Option<AspectRatio>

Aspect ratio of the images, in {width}:{height} format. None uses the provider’s default aspect ratio.

seed: Option<u64>

Seed for deterministic generation. None uses the provider’s default.

files: Option<Vec<ImageFile>>

Images for image editing or variation generation.

mask: Option<ImageFile>

Mask image for inpainting operations.

provider_options: SharedProviderOptions

Additional provider-specific options, keyed by provider name.

abort_signal: Option<AbortSignal>

Abort signal for cancelling the operation.

max_retries: Option<u32>

Per-call retry override. None uses the model default.

timeout: Option<TimeoutConfiguration>

Per-call operation timeout.

headers: Option<SharedHeaders>

Additional HTTP headers to send with the request.

Implementations

impl ImageCallOptions

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

Create options with a prompt and n = 1, all other fields defaulted.

Trait Implementations

impl Clone for ImageCallOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageCallOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageCallOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageCallOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for ImageCallOptions

type WithoutGenerics = ImageCallOptions

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ImageCallOptions

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.