Struct ImageGenerationArgs 

pub struct ImageGenerationArgs { /* private fields */ }

Builder for ImageGenTool.

Implementations

impl ImageGenerationArgs

pub fn background<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolBackground>,

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

pub fn input_fidelity<VALUE>( &mut self, value: VALUE, ) -> &mut ImageGenerationArgs

where VALUE: Into<InputFidelity>,

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

pub fn input_image_mask<VALUE>( &mut self, value: VALUE, ) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolInputImageMask>,

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

pub fn model<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<String>,

The image generation model to use. Default: gpt-image-1.

pub fn moderation<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolModeration>,

Moderation level for the generated image. Default: auto.

pub fn output_compression<VALUE>( &mut self, value: VALUE, ) -> &mut ImageGenerationArgs

where VALUE: Into<u8>,

Compression level for the output image. Default: 100.

pub fn output_format<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolOutputFormat>,

The output format of the generated image. One of png, webp, or jpeg. Default: png.

pub fn partial_images<VALUE>( &mut self, value: VALUE, ) -> &mut ImageGenerationArgs

where VALUE: Into<u8>,

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

pub fn quality<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolQuality>,

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

pub fn size<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenToolSize>,

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

pub fn action<VALUE>(&mut self, value: VALUE) -> &mut ImageGenerationArgs

where VALUE: Into<ImageGenActionEnum>,

Whether to generate a new image or edit an existing image. Default: auto.

pub fn build(&self) -> Result<ImageGenTool, OpenAIError>

Builds a new ImageGenTool.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ImageGenerationArgs

fn clone(&self) -> ImageGenerationArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ImageGenerationArgs

fn default() -> ImageGenerationArgs

Returns the “default value” for a type.