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

Overview

See Also:

Defined Under Namespace

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

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #dump, dump, #inspect, inspect, 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, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::ImageGenerateParams for more details.

Parameters:

  • prompt (String) (defaults to: ) —

    A text description of the desired image(s). The maximum length is 32000 characte

  • background (Symbol, OpenAI::Models::ImageGenerateParams::Background, nil) (defaults to: nil) —

    Allows to set transparency for the background of the generated image(s).

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) (defaults to: nil) —

    The model to use for image generation. One of ‘dall-e-2`, `dall-e-3`, or `gpt-im

  • moderation (Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil) (defaults to: nil) —

    Control the content-moderation level for images generated by ‘gpt-image-1`. Must

  • n (Integer, nil) (defaults to: nil) —

    The number of images to generate. Must be between 1 and 10. For ‘dall-e-3`, only

  • output_compression (Integer, nil) (defaults to: nil) —

    The compression level (0-100%) for the generated images. This parameter is only

  • output_format (Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil) (defaults to: nil) —

    The format in which the generated images are returned. This parameter is only su

  • quality (Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil) (defaults to: nil) —

    The quality of the image that will be generated.

  • response_format (Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil) (defaults to: nil) —

    The format in which generated images with ‘dall-e-2` and `dall-e-3` are returned

  • size (Symbol, OpenAI::Models::ImageGenerateParams::Size, nil) (defaults to: nil) —

    The size of the generated images. Must be one of ‘1024x1024`, `1536x1024` (lands

  • style (Symbol, OpenAI::Models::ImageGenerateParams::Style, nil) (defaults to: nil) —

    The style of the generated images. This parameter is only supported for ‘dall-e-

  • user (String) (defaults to: nil) —

    A unique identifier representing your end-user, which can help OpenAI to monitor

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#background ⇒ Symbol, ...

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`.

Returns:



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

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

#model ⇒ String, ...

The model to use for image generation. One of ‘dall-e-2`, `dall-e-3`, or `gpt-image-1`. Defaults to `dall-e-2` unless a parameter specific to `gpt-image-1` is used.

Returns:



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

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

#moderation ⇒ Symbol, ...

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

Returns:



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

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) 


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

optional :n, Integer, nil?: true

#output_compression ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


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

optional :output_compression, Integer, nil?: true

#output_format ⇒ Symbol, ...

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`.

Returns:



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

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

#prompt ⇒ String

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

Returns:

  • (String) 


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

required :prompt, String

#quality ⇒ Symbol, ...

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 `gpt-image-1`.

  • ‘hd` and `standard` are supported for `dall-e-3`.

  • ‘standard` is the only option for `dall-e-2`.

Returns:



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

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

#response_format ⇒ Symbol, ...

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 ‘gpt-image-1` which will always return base64-encoded images.

Returns:



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

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

#size ⇒ Symbol, ...

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

Returns:



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

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

#style ⇒ Symbol, ...

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:



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

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](platform.openai.com/docs/guides/safety-best-practices#end-user-ids).

Returns:

  • (String, nil) 


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

optional :user, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

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

Returns:




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