Struct ImageGenerationTool 

pub struct ImageGenerationTool {
    pub action: Option<String>,
    pub background: Option<String>,
    pub input_fidelity: Option<String>,
    pub input_image_mask: Option<ImageInputMask>,
    pub model: Option<String>,
    pub moderation: Option<String>,
    pub output_compression: Option<u32>,
    pub output_format: Option<String>,
    pub partial_images: Option<u32>,
    pub quality: Option<String>,
    pub size: Option<String>,
}

Configuration payload for the image_generation built-in tool.

Spec: { type: "image_generation", action?, background?, input_fidelity?, input_image_mask?, model?, moderation?, output_compression?, output_format?, partial_images?, quality?, size? }. All inner fields are optional; the model picks defaults documented in the spec.

Fields

action: Option<String>

"generate" | "edit" | "auto" (default auto). Free-form string here so future actions added by OpenAI deserialize without a wire break.

background: Option<String>

"transparent" | "opaque" | "auto" (default auto).

input_fidelity: Option<String>

"high" | "low" — gpt-image-1 / gpt-image-1.5 only (not 1-mini).

input_image_mask: Option<ImageInputMask>

Reference image used by edit action; mask either by uploaded file or URL.

model: Option<String>

string | "gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5" — kept as String so unknown model identifiers passed through unchanged.

moderation: Option<String>

"auto" | "low".

output_compression: Option<u32>

Output compression level. Spec default 100 when omitted; we keep Option so an unset field round-trips as absent (not null, via #[serde_with::skip_serializing_none]) rather than forcing 100.

output_format: Option<String>

"png" | "webp" | "jpeg".

partial_images: Option<u32>

0..3 — number of partial images to stream.

quality: Option<String>

"low" | "medium" | "high" | "auto".

size: Option<String>

"1024x1024" | "1024x1536" | "1536x1024" | "auto".

Trait Implementations

impl Clone for ImageGenerationTool

fn clone(&self) -> ImageGenerationTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageGenerationTool

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

Formats the value using the given formatter.

impl Default for ImageGenerationTool

fn default() -> ImageGenerationTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageGenerationTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ImageGenerationTool

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ImageGenerationTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.