class

OpenAI::ImageGenTool

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)

new(type_value : ImageGenToolType = ImageGenToolType::ImageGeneration, model : ImageGenToolModel | Nil = nil, quality : ImageGenToolQuality | Nil = nil, size : ImageGenToolSize | Nil = nil, output_format : ImageGenToolOutputFormat | Nil = nil, output_compression : Int64 | Nil = nil, moderation : ImageGenToolModeration | Nil = nil, background : ImageGenToolBackground | Nil = nil, input_fidelity : ImageGenToolInputFidelity | Nil = nil, input_image_mask : ImageGenToolInputImageMask | Nil = nil, partial_images : Int64 | Nil = nil)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

background

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

background=(background : ImageGenToolBackground | Nil)

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

input_fidelity

input_fidelity=(input_fidelity : ImageGenToolInputFidelity | Nil)

input_image_mask

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

input_image_mask=(input_image_mask : ImageGenToolInputImageMask | Nil)

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

model

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

model=(model : ImageGenToolModel | Nil)

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

moderation

Moderation level for the generated image. Default: auto.

moderation=(moderation : ImageGenToolModeration | Nil)

Moderation level for the generated image. Default: auto.

output_compression

Compression level for the output image. Default: 100.

output_compression=(output_compression : Int64 | Nil)

Compression level for the output image. Default: 100.

output_format

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

output_format=(output_format : ImageGenToolOutputFormat | Nil)

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

partial_images

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

partial_images=(partial_images : Int64 | Nil)

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

quality

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

quality=(quality : ImageGenToolQuality | Nil)

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

size

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

size=(size : ImageGenToolSize | Nil)

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

type_value

The type of the image generation tool. Always image_generation.

type_value=(type_value : ImageGenToolType)

The type of the image generation tool. Always image_generation.