images: images Class
In openaistream: Streaming Capabilities for 'OpenAI API' Interactions
images R Documentation
images Class
Description
images Class
images Class
Super class
openaistream::openai -> images
Methods
Public methods
Inherited methods
Method create()
Creates an image given a prompt.
Usage
images$create(prompt, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method edit()
Creates an edited or extended image given an original image and a prompt.
Usage
images$edit(image, prompt, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method variation()
Creates a variation of a given image.
Usage
images$variation(image, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method clone()
The objects of this class are cloneable with this method.
Usage
images$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
openaistream documentation built on June 22, 2024, 9:55 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| images | R Documentation |
images Class
Description
images Class
images Class
Super class
openaistream::openai -> images
Methods
Public methods
Inherited methods
Method create()
Creates an image given a prompt.
Usage
images$create(prompt, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method edit()
Creates an edited or extended image given an original image and a prompt.
Usage
images$edit(image, prompt, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method variation()
Creates a variation of a given image.
Usage
images$variation(image, ..., verbosity = 0)
Arguments
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
Returns a list of image objects.
Method clone()
The objects of this class are cloneable with this method.
Usage
images$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.