Method: OpenAI::Resources::Images#generate

Defined in:

lib/openai/resources/images.rb

#generate(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: {}) ⇒ OpenAI::Models::ImagesResponse

See #generate_stream_raw for streaming counterpart.

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

Creates an image given a prompt. Learn more.

Parameters:

• prompt (String) —

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

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

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

• model (String, Symbol, OpenAI::Models::ImageModel, 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) —

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

• n (Integer, nil) —

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

• output_compression (Integer, nil) —

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

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

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

• partial_images (Integer, nil) —

  The number of partial images to generate. This parameter is used for

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

  The quality of the image that will be generated.

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

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

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

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

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

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

• user (String) —

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

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

Returns:

• (OpenAI::Models::ImagesResponse)

See Also:

• Models::ImageGenerateParams

# File 'lib/openai/resources/images.rb', line 203

def generate(params)
  parsed, options = OpenAI::ImageGenerateParams.dump_request(params)
  if parsed[:stream]
    message = "Please use `#generate_stream_raw` for the streaming use case."
    raise ArgumentError.new(message)
  end
  @client.request(
    method: :post,
    path: "images/generations",
    body: parsed,
    model: OpenAI::ImagesResponse,
    options: options
  )
end