class OpenAI::ImageEditRequest

Included Modules

Extended Modules

Defined in:

openai/api/image.cr

Constructors

Instance Method Summary

Constructor Detail

def self.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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def build_metada(builder : HTTP::FormData::Builder) #

[View source]
def image : File | Path | String #

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.


[View source]
def image=(image : File | Path | String) #

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.


[View source]
def mask : File | Path | String | Nil #

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.


[View source]
def mask=(mask : File | Path | String | Nil) #

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.


[View source]
def num_images : Int32 #

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


[View source]
def num_images=(num_images : Int32) #

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


[View source]
def prompt : String #

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


[View source]
def prompt=(prompt : String) #

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


[View source]
def response_format : ImageRespFormat #

The format in which the generated images are returned.


[View source]
def response_format=(response_format : ImageRespFormat) #

The format in which the generated images are returned.


[View source]
def size : ImageSize #

The size of the generated images


[View source]
def size=(size : ImageSize) #

The size of the generated images


[View source]
def user : String | Nil #

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


[View source]
def user=(user : String | Nil) #

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


[View source]