openai (version 0.4.1)

create_image_edit: Create image edit

Description

Creates an edited or extended image given an original image and a prompt. See this page for details.

Usage

create_image_edit(
  image,
  mask,
  prompt,
  n = 1,
  size = c("1024x1024", "256x256", "512x512"),
  response_format = c("url", "b64_json"),
  user = NULL,
  openai_api_key = Sys.getenv("OPENAI_API_KEY"),
  openai_organization = NULL
)

Value

Returns a list, an element of which contain either a link to the edited image or the edited image decoded in Base64.

Arguments

image

required; a length one character vector.

mask

required; a length one character vector.

prompt

required; a length one character vector.

n

required; defaults to 1; a length one numeric vector with the integer value greater than 0.

size

required; defaults to "1024x1024"; a length one character vector, one among "256x256", "512x512", and "1024x1024".

response_format

required; defaults to "url"; a length one character vector, one among "url" and "b64_json".

user

optional; defaults to NULL; a length one character vector.

openai_api_key

required; defaults to Sys.getenv("OPENAI_API_KEY") (i.e., the value is retrieved from the .Renviron file); a length one character vector. Specifies OpenAI API key.

openai_organization

optional; defaults to NULL; a length one character vector. Specifies OpenAI organization.

Details

For arguments description please refer to the official documentation.

See Also

Other image functions: create_image_variation(), create_image()

Examples

if (FALSE) {
image <- system.file("extdata", "astronaut.png", package = "openai")
mask <- system.file("extdata", "mask.png", package = "openai")
create_image_edit(
    image = image,
    mask = mask,
    prompt = "goat",
    n = 1,
    response_format = "url"
)
}