Constructor Detail

Method Detail

• _type

   final JsonValue _type()

  The type of the image generation tool. Always image_generation.

  Expected to always return the following:

  JsonValue.from("image_generation")

  However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).

• action

   final Optional<Tool.ImageGeneration.Action> action()

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

• background

   final Optional<Tool.ImageGeneration.Background> background()

  Allows to set transparency for the background of the generated image(s). This parameter is only supported for GPT image models that support transparent backgrounds. Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.

  gpt-image-2 and gpt-image-2-2026-04-21 do not support transparent backgrounds. Requests with background set to transparent will return an error for these models; use opaque or auto instead.

  If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

• inputFidelity

   final Optional<Tool.ImageGeneration.InputFidelity> 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 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

• inputImageMask

   final Optional<Tool.ImageGeneration.InputImageMask> inputImageMask()

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

• model

   final Optional<Tool.ImageGeneration.Model> model()

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

• moderation

   final Optional<Tool.ImageGeneration.Moderation> moderation()

  Moderation level for the generated image. Default: auto.

• outputCompression

   final Optional<Long> outputCompression()

  Compression level for the output image. Default: 100.

• outputFormat

   final Optional<Tool.ImageGeneration.OutputFormat> outputFormat()

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

• partialImages

   final Optional<Long> partialImages()

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

• quality

   final Optional<Tool.ImageGeneration.Quality> quality()

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

• size

   final Optional<Tool.ImageGeneration.Size> size()

  The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, 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. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

• _action

   final JsonField<Tool.ImageGeneration.Action> _action()

  Returns the raw JSON value of action.

  Unlike action, this method doesn't throw if the JSON field has an unexpected type.

• _background

   final JsonField<Tool.ImageGeneration.Background> _background()

  Returns the raw JSON value of background.

  Unlike background, this method doesn't throw if the JSON field has an unexpected type.

• _inputFidelity

   final JsonField<Tool.ImageGeneration.InputFidelity> _inputFidelity()

  Returns the raw JSON value of inputFidelity.

  Unlike inputFidelity, this method doesn't throw if the JSON field has an unexpected type.

• _inputImageMask

   final JsonField<Tool.ImageGeneration.InputImageMask> _inputImageMask()

  Returns the raw JSON value of inputImageMask.

  Unlike inputImageMask, this method doesn't throw if the JSON field has an unexpected type.

• _model

   final JsonField<Tool.ImageGeneration.Model> _model()

  Returns the raw JSON value of model.

  Unlike model, this method doesn't throw if the JSON field has an unexpected type.

• _moderation

   final JsonField<Tool.ImageGeneration.Moderation> _moderation()

  Returns the raw JSON value of moderation.

  Unlike moderation, this method doesn't throw if the JSON field has an unexpected type.

• _outputCompression

   final JsonField<Long> _outputCompression()

  Returns the raw JSON value of outputCompression.

  Unlike outputCompression, this method doesn't throw if the JSON field has an unexpected type.

• _outputFormat

   final JsonField<Tool.ImageGeneration.OutputFormat> _outputFormat()

  Returns the raw JSON value of outputFormat.

  Unlike outputFormat, this method doesn't throw if the JSON field has an unexpected type.

• _partialImages

   final JsonField<Long> _partialImages()

  Returns the raw JSON value of partialImages.

  Unlike partialImages, this method doesn't throw if the JSON field has an unexpected type.

• _quality

   final JsonField<Tool.ImageGeneration.Quality> _quality()

  Returns the raw JSON value of quality.

  Unlike quality, this method doesn't throw if the JSON field has an unexpected type.

• _size

   final JsonField<Tool.ImageGeneration.Size> _size()

  Returns the raw JSON value of size.

  Unlike size, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final Tool.ImageGeneration.Builder toBuilder()

• validate

   final Tool.ImageGeneration validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static Tool.ImageGeneration.Builder builder()

  Returns a mutable builder for constructing an instance of ImageGeneration.