Struct ImageGenTool 

pub struct ImageGenTool {
    pub background: Option<ImageGenToolBackground>,
    pub input_fidelity: Option<InputFidelity>,
    pub input_image_mask: Option<ImageGenToolInputImageMask>,
    pub model: Option<String>,
    pub moderation: Option<ImageGenToolModeration>,
    pub output_compression: Option<u8>,
    pub output_format: Option<ImageGenToolOutputFormat>,
    pub partial_images: Option<u8>,
    pub quality: Option<ImageGenToolQuality>,
    pub size: Option<ImageGenToolSize>,
    pub action: Option<ImageGenActionEnum>,
}

Available on crate feature response-types only.

Image generation tool definition.

Fields

background: Option<ImageGenToolBackground>

Set the background of the generated image. One of transparent, opaque, or auto. Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp. Default: auto.

input_fidelity: Option<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.

input_image_mask: Option<ImageGenToolInputImageMask>

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

model: Option<String>

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

moderation: Option<ImageGenToolModeration>

Moderation level for the generated image. Default: auto.

output_compression: Option<u8>

Compression level for the output image. Default: 100.

output_format: Option<ImageGenToolOutputFormat>

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

partial_images: Option<u8>

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

quality: Option<ImageGenToolQuality>

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

size: Option<ImageGenToolSize>

The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing.

action: Option<ImageGenActionEnum>

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

Trait Implementations

impl Clone for ImageGenTool

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 ImageGenTool

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

Formats the value using the given formatter.

impl Default for ImageGenTool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageGenTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ImageGenTool> for Tool

fn from(tool: ImageGenTool) -> Self

Converts to this type from the input type.

impl From<ImageGenTool> for Vec<Tool>

fn from(tool: ImageGenTool) -> Self

Converts to this type from the input type.

impl PartialEq for ImageGenTool

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ImageGenTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ImageGenTool