Method: OpenAI::Models::ImageEditParams#initialize

Defined in:

lib/openai/models/image_edit_params.rb

#initialize(image: , prompt: , background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {}) ⇒ void

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

Parameters:

• image (Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>) (defaults to: ) —

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

• prompt (String) (defaults to: ) —

  A text description of the desired image(s). The maximum length is 1000 character

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

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

• input_fidelity (Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil) (defaults to: nil) —

  Control how much effort the model will exert to match the style and features,

• mask (Pathname, StringIO, IO, String, OpenAI::FilePart) (defaults to: nil) —

  An additional image whose fully transparent areas (e.g. where alpha is zero) ind

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

  The model to use for image generation. Only dall-e-2 and gpt-image-1 are sup

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

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

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

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

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

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

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

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

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

  The quality of the image that will be generated. high, medium and low are

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

  The format in which the generated images are returned. Must be one of url or `

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

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

• 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_edit_params.rb', line 134