Class: OpenAI::Models::ImageGenerateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/image_generate_params.rb,
sig/openai/models/image_generate_params.rbs

Overview

See Also:

  • OpenAI::Resources::Images#generate
  • OpenAI::Resources::Images#generate_stream_raw

Defined Under Namespace

Modules: Background, Model, Moderation, OutputFormat, Quality, ResponseFormat, Size, Style

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {}) ⇒ Object

Parameters:

  • prompt —

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

  • background (defaults to: nil) —

    Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

  • model (defaults to: nil) —

    The model to use for image generation. One of dall-e-2, dall-e-3, or a GPT image model (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, gpt-image-2.5-flare-2026-09-08). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

  • moderation (defaults to: nil) —

    Control the content-moderation level for images generated by the GPT image models. Must be either low for less restrictive filtering or auto (default value).

  • n (defaults to: nil) —

    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

  • output_compression (defaults to: nil) —

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

  • output_format (defaults to: nil) —

    The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp.

  • partial_images (defaults to: nil) —

    The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

    Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

  • quality (defaults to: nil) —

    The quality of the image that will be generated.

    • auto (default value) will automatically select the best quality for the given model.
    • high, medium and low are supported for the GPT image models.
    • gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max.
    • hd and standard are supported for dall-e-3.
    • standard is the only option for dall-e-2.
  • response_format (defaults to: nil) —

    The format in which generated images with dall-e-2 and dall-e-3 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 isn't supported for the GPT image models, which always return base64-encoded images.

  • size (defaults to: nil) —

    The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, 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.

  • style (defaults to: nil) —

    The style of the generated images. This parameter is only supported for dall-e-3. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

  • user (defaults to: nil) —

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




# File 'lib/openai/models/image_generate_params.rb', line 143

Instance Attribute Details

#background ⇒ OpenAI::Models::ImageGenerateParams::background?

Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

Returns:

  • (OpenAI::Models::ImageGenerateParams::background, nil) 


32
 
# File 'lib/openai/models/image_generate_params.rb', line 32

optional :background, enum: -> { OpenAI::ImageGenerateParams::Background }, nil?: true

#model ⇒ OpenAI::Models::ImageGenerateParams::model?

The model to use for image generation. One of dall-e-2, dall-e-3, or a GPT image model (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, gpt-image-2.5-flare-2026-09-08). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

Returns:

  • (OpenAI::Models::ImageGenerateParams::model, nil) 


43
 
# File 'lib/openai/models/image_generate_params.rb', line 43

optional :model, union: -> { OpenAI::ImageGenerateParams::Model }, nil?: true

#moderation ⇒ OpenAI::Models::ImageGenerateParams::moderation?

Control the content-moderation level for images generated by the GPT image models. Must be either low for less restrictive filtering or auto (default value).

Returns:

  • (OpenAI::Models::ImageGenerateParams::moderation, nil) 


51
 
# File 'lib/openai/models/image_generate_params.rb', line 51

optional :moderation, enum: -> { OpenAI::ImageGenerateParams::Moderation }, nil?: true

#n ⇒ Integer?

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

Returns:

  • (Integer, nil) 


58
 
# File 'lib/openai/models/image_generate_params.rb', line 58

optional :n, Integer, nil?: true

#output_compression ⇒ Integer?

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

Returns:

  • (Integer, nil) 


66
 
# File 'lib/openai/models/image_generate_params.rb', line 66

optional :output_compression, Integer, nil?: true

#output_format ⇒ OpenAI::Models::ImageGenerateParams::output_format?

The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp.

Returns:

  • (OpenAI::Models::ImageGenerateParams::output_format, nil) 


73
 
# File 'lib/openai/models/image_generate_params.rb', line 73

optional :output_format, enum: -> { OpenAI::ImageGenerateParams::OutputFormat }, nil?: true

#partial_images ⇒ Integer?

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

Returns:

  • (Integer, nil) 


84
 
# File 'lib/openai/models/image_generate_params.rb', line 84

optional :partial_images, Integer, nil?: true

#prompt ⇒ String

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

Returns:

  • (String) 


18
 
# File 'lib/openai/models/image_generate_params.rb', line 18

required :prompt, String

#quality ⇒ OpenAI::Models::ImageGenerateParams::quality?

The quality of the image that will be generated.

  • auto (default value) will automatically select the best quality for the given model.
  • high, medium and low are supported for the GPT image models.
  • gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max.
  • hd and standard are supported for dall-e-3.
  • standard is the only option for dall-e-2.

Returns:

  • (OpenAI::Models::ImageGenerateParams::quality, nil) 


98
 
# File 'lib/openai/models/image_generate_params.rb', line 98

optional :quality, enum: -> { OpenAI::ImageGenerateParams::Quality }, nil?: true

#response_format ⇒ OpenAI::Models::ImageGenerateParams::response_format?

The format in which generated images with dall-e-2 and dall-e-3 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 isn't supported for the GPT image models, which always return base64-encoded images.

Returns:

  • (OpenAI::Models::ImageGenerateParams::response_format, nil) 


107
 
# File 'lib/openai/models/image_generate_params.rb', line 107

optional :response_format, enum: -> { OpenAI::ImageGenerateParams::ResponseFormat }, nil?: true

#size ⇒ OpenAI::Models::ImageGenerateParams::size?

The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, 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.

Returns:

  • (OpenAI::Models::ImageGenerateParams::size, nil) 


124
 
# File 'lib/openai/models/image_generate_params.rb', line 124

optional :size, union: -> { OpenAI::ImageGenerateParams::Size }, nil?: true

#style ⇒ OpenAI::Models::ImageGenerateParams::style?

The style of the generated images. This parameter is only supported for dall-e-3. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

Returns:

  • (OpenAI::Models::ImageGenerateParams::style, nil) 


133
 
# File 'lib/openai/models/image_generate_params.rb', line 133

optional :style, enum: -> { OpenAI::ImageGenerateParams::Style }, nil?: true

#user ⇒ String?

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

Returns:

  • (String, nil) 


141
 
# File 'lib/openai/models/image_generate_params.rb', line 141

optional :user, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/image_generate_params.rb', line 254

.variants ⇒ Array(String, Symbol, OpenAI::Models::ImageModel)

Returns:




# File 'lib/openai/models/image_generate_params.rb', line 272

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


218
 
# File 'sig/openai/models/image_generate_params.rbs', line 218

def to_hash: -> {