Class ImageGenerationTool
A tool that generates images using a model like gpt-image-1.
public class ImageGenerationTool : Tool
- Inheritance
-
objectImageGenerationTool
- Inherited Members
Properties
Background
Optional. Background type for the generated image. One of transparent, opaque, or auto.
public ImageBackground? Background { get; set; }
Property Value
InputFidelity
Optional. 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. Supports high and low. Defaults to low.
public OpenAITypes.Fidelity? InputFidelity { get; set; }
Property Value
InputImageMask
Optional. Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).
public ImageReference InputImageMask { get; set; }
Property Value
Model
Optional. The image generation model to use. Default: gpt-image-1.
public string Model { get; set; }
Property Value
- string
Moderation
Optional. Moderation level for the generated image. Default: auto.
public string Moderation { get; set; }
Property Value
- string
OutputCompression
Optional. Compression level for the output image. Default: 100.
public int? OutputCompression { get; set; }
Property Value
- int?
OutputFormat
Optional. The output format of the generated image. One of png, webp, or jpeg. Default: png.
public string OutputFormat { get; set; }
Property Value
- string
PartialImages
Optional. Number of partial images to generate in streaming mode, from 0 (default value) to 3.
public int? PartialImages { get; set; }
Property Value
- int?
Quality
Optional. The quality of the generated image. One of low, medium, high, or auto. Default: auto.
public ImageQuality? Quality { get; set; }
Property Value
Size
Optional. The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.
public ImageSize? Size { get; set; }