class

OpenAI::CreateImageEditRequest

Inherits JSON::Serializable < Reference < Object

Constructors

new(pull : JSON::PullParser)

new(image : CreateImageEditRequestImage = "", prompt : String = "", mask : String | Nil = nil, background : CreateImageEditRequestBackground | Nil = nil, model : CreateImageEditRequestModel | Nil = nil, n : Int64 | Nil = nil, size : CreateImageEditRequestSize | Nil = nil, response_format : CreateImageEditRequestResponseFormat | Nil = nil, output_format : CreateImageEditRequestOutputFormat | Nil = nil, output_compression : Int64 | Nil = nil, user : String | Nil = nil, input_fidelity : CreateImageEditRequestInputFidelity | Nil = nil, stream : Bool | Nil = nil, partial_images : PartialImages | Nil = nil, quality : CreateImageEditRequestQuality | Nil = nil)

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

Instance methods

background

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. 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.

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

background=(background : CreateImageEditRequestBackground | Nil)

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. 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.

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

image

The image(s) to edit. Must be a supported image file or an array of images.

For gpt-image-1, each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.

For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

image=(image : CreateImageEditRequestImage)

The image(s) to edit. Must be a supported image file or an array of images.

For gpt-image-1, each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.

For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

input_fidelity

input_fidelity=(input_fidelity : CreateImageEditRequestInputFidelity | Nil)

mask

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

mask=(mask : String | Nil)

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

model

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

model=(model : CreateImageEditRequestModel | Nil)

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

n

The number of images to generate. Must be between 1 and 10.

n=(n : Int64 | Nil)

The number of images to generate. Must be between 1 and 10.

output_compression

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats, and defaults to 100.

output_compression=(output_compression : Int64 | Nil)

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats, and defaults to 100.

output_format

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp. The default value is png.

output_format=(output_format : CreateImageEditRequestOutputFormat | Nil)

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp. The default value is png.

partial_images

partial_images=(partial_images : PartialImages | Nil)

prompt

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for gpt-image-1.

prompt=(prompt : String)

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for gpt-image-1.

quality

The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

quality=(quality : CreateImageEditRequestQuality | Nil)

The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

response_format

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

response_format=(response_format : CreateImageEditRequestResponseFormat | Nil)

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

size

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

size=(size : CreateImageEditRequestSize | Nil)

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

stream

Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

stream=(stream : Bool | Nil)

Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

user=(user : String | Nil)

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.