images Class
images Class
openaistream::openai -> images
Inherited methods
create()Creates an image given a prompt.
images$create(prompt, ..., verbosity = 0)promptcharacter Required. A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3
...Additional parameters as required by the OpenAI API.For example:n;quality;response_format...
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns a list of image objects.
edit()Creates an edited or extended image given an original image and a prompt.
images$edit(image, prompt, ..., verbosity = 0)imagecharacter Required. 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.
promptcharacter Required. A text description of the desired image(s). The maximum length is 1000 characters.
...Additional parameters as required by the OpenAI API.For example:mask;model;n...
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns a list of image objects.
variation()Creates a variation of a given image.
images$variation(image, ..., verbosity = 0)imagecharacter Required. The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
...Additional parameters as required by the OpenAI API.For example:model;n;response_format
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns a list of image objects.
clone()The objects of this class are cloneable with this method.
images$clone(deep = FALSE)deepWhether to make a deep clone.