create_image_edit: Create Image Edit

In samterfa/openai: Consumes the Open AI API

Create Image Edit

Description

Creates an edited or extended image given an original image and a prompt.

Usage

create_image_edit(
  image,
  prompt,
  mask = NULL,
  model = NULL,
  n = NULL,
  response_format = NULL,
  size = NULL,
  user = NULL,
  return_response = F
)

Arguments

image	(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. Required
prompt	(string) A text description of the desired image(s). The maximum length is 1000 characters. Required
mask	(string) 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.
model	(string) The model to use for image generation. Only dall-e-2 is supported at this time.
n	(integer or null) The number of images to generate. Must be between 1 and 10.
response_format	(string or null) The format in which the generated images are returned. Must be one of url or b64_json.
size	(string or null) The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
user	(string) A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
return_response	(boolean) Whether to return the API response or parse the contents of the response. Defaults to FALSE (parse the response).

See Also

Open AI Documentation

samterfa/openai documentation built on Oct. 9, 2024, 5:18 p.m.