Struct ImageBatchRequest 

pub struct ImageBatchRequest {
    pub id: String,
    pub model_id: ModelId,
    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,
}

An image generation request of a batch.

Fields

id: String

Request id, unique within the batch.

model_id: ModelId

Model id at the provider.

prompt: Option<String>

Text prompt.

n: u32

Number of images.

size: Option<ImageSize>

Image size.

aspect_ratio: Option<AspectRatio>

Aspect ratio.

seed: Option<u64>

Seed.

files: Vec<ImageFile>

Reference images.

mask: Option<ImageFile>

Mask.

provider_options: ProviderOptions

Provider options.

Implementations

impl ImageBatchRequest

pub fn new( id: impl Into<String>, model_id: impl Into<ModelId>, prompt: impl Into<String>, ) -> Self

Creates a request for model_id.

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

Number of images (default 1).

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

Image size.

pub fn aspect_ratio(self, aspect_ratio: AspectRatio) -> Self

Aspect ratio.

pub fn seed(self, seed: u64) -> Self

Seed.

pub fn files(self, files: Vec<ImageFile>) -> Self

Reference images.

pub fn mask(self, mask: ImageFile) -> Self

Mask.

pub fn provider_options(self, provider_options: ProviderOptions) -> Self

Provider options.

Trait Implementations

impl Clone for ImageBatchRequest

fn clone(&self) -> ImageBatchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageBatchRequest

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

Formats the value using the given formatter.

impl From<ImageBatchRequest> for BatchRequest

fn from(request: ImageBatchRequest) -> Self

Converts to this type from the input type.