img {GenAI} | R Documentation |
Image Generation with Text as the Input
Description
This function establishes a connection to a generative AI model through a generative AI object. It generates an image response based on the provided prompt.
Usage
img(genai.object, prompt, verbose = FALSE, config = list())
Arguments
genai.object |
A generative AI object containing necessary and correct information. |
prompt |
A character string representing the query for image generation. |
verbose |
Optional. Default to |
config |
Optional. Default to |
Details
Providing accurate and valid information for each argument is crucial for successful image
generation by the generative AI model. If any parameter is incorrect, the function responds with an
error message based on the API feedback. To view all supported generative AI models, use the
function available.models
.
This function is only available when using OpenAI's models.
For OpenAI models, available configurations are as follows. For more detail, please refer to
https://platform.openai.com/docs/api-reference/images/create
.
-
quality
Optional. A character string. The quality of the image that will be generated.
hd
creates images with finer details and greater consistency across the image. -
size
Optional. A character string. The size of the generated images. Must be one of
256x256
,512x512
, or1024x1024
fordall-e-2
. Must be one of1024x1024
,1792x1024
, or1024x1792
fordall-e-3
models. -
style
Optional. The style of the generated images. Must be one of
vivid
ornatural
. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. -
user
Optional. A character string. A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
Value
If successful, a image in ggplot
format will be returned. If the API response indicates
an error, the function halts execution and provides an error message.
See Also
GenAI - R Package "GenAI" Documentation
Examples
## Not run:
# Assuming there is a GenAI object named 'genai.model' supporting this
# function, please refer to the "Live Demo in Colab" above for real
# examples. The following examples are just some basic guidelines.
# Method 1 (recommended): use the pipe operator "%>%"
generated.image = genai.model %>%
img(prompt = "A very cute panda eating banboo.")
generated.image
# Method 2: use the reference operator "$"
generated.image = genai.model$img(prompt = "A very cute sea otter on a rock.")
generated.image
# Method 3: use the function img() directly
generated.image = img(genai.object = genai.model,
prompt = "A very cute bear.")
generated.image
## End(Not run)