Struct ImageGenTool

pub struct ImageGenTool {
    pub model: Option<ImageGenToolModel>,
    pub quality: Option<ImageGenToolQuality>,
    pub size: Option<ImageGenToolSize>,
    pub output_format: Option<ImageGenToolOutputFormat>,
    pub output_compression: Option<u64>,
    pub moderation: Option<ImageGenToolModeration>,
    pub background: Option<ImageGenToolBackground>,
    pub input_image_mask: Option<ImageGenToolInputImageMask>,
    pub partial_images: Option<u64>,
}

A tool that generates images using a model like gpt-image-1.

Fields

model: Option<ImageGenToolModel>

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

quality: Option<ImageGenToolQuality>

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

size: Option<ImageGenToolSize>

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

output_format: Option<ImageGenToolOutputFormat>

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

output_compression: Option<u64>

Compression level for the output image. Default: 100.

moderation: Option<ImageGenToolModeration>

Moderation level for the generated image. Default: auto.

background: Option<ImageGenToolBackground>

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

input_image_mask: Option<ImageGenToolInputImageMask>

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

partial_images: Option<u64>

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

Implementations

impl ImageGenTool

pub fn builder() -> ImageGenToolBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building ImageGenTool. On the builder, call .model(...)(optional), .quality(...)(optional), .size(...)(optional), .output_format(...)(optional), .output_compression(...)(optional), .moderation(...)(optional), .background(...)(optional), .input_image_mask(...)(optional), .partial_images(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ImageGenTool.

Trait Implementations

impl Clone for ImageGenTool

fn clone(&self) -> ImageGenTool

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() -> ImageGenTool

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 PartialEq for ImageGenTool

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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