class OpenAI::ImageEditRequest

• OpenAI::ImageEditRequest
• Reference
• Object

Included Modules

• JSON::Serializable

Extended Modules

• JSON::Schema

Defined in:

openai/api/image.cr

Constructors

• .new(image : File | Path | String, prompt : String, mask : File | Path | String | Nil = nil, num_images : Int32 = 1, size : OpenAI::ImageSize = :large, response_format : OpenAI::ImageRespFormat = :url, user : Nil | String = nil)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #build_metada(builder : HTTP::FormData::Builder)
• #image : File | Path | String
• #image=(image : File | Path | String)
• #mask : File | Path | String | Nil
• #mask=(mask : File | Path | String | Nil)
• #num_images : Int32
• #num_images=(num_images : Int32)
• #prompt : String

  A text description of the desired image(s).

• #prompt=(prompt : String)

  A text description of the desired image(s).

• #response_format : ImageRespFormat

  The format in which the generated images are returned.

• #response_format=(response_format : ImageRespFormat)

  The format in which the generated images are returned.

• #size : ImageSize

  The size of the generated images

• #size=(size : ImageSize)

  The size of the generated images

• #user : String | Nil

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

• #user=(user : String | Nil)

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

Constructor Detail

Instance Method Detail