openaiRtools (version 0.2.2)

ImagesClient: Images Client

Description

Client for OpenAI Images API (DALL-E image generation and editing). Access via client$images.

Methods

$create(prompt, ...)

Generate a new image from a text description

$edit(image, prompt, ...)

Edit an existing image using a mask

$create_variation(image, ...)

Create variations of an existing image

Methods

Public methods

• ImagesClient$new()

• ImagesClient$create()

• ImagesClient$edit()

• ImagesClient$create_variation()

• ImagesClient$clone()

---

Method new()

Usage

ImagesClient$new(parent)

---

Method create()

Usage

ImagesClient$create(
  prompt,
  model = "dall-e-3",
  n = NULL,
  quality = NULL,
  response_format = NULL,
  size = NULL,
  style = NULL,
  user = NULL
)

---

Method edit()

Usage

ImagesClient$edit(
  image,
  prompt,
  mask = NULL,
  model = "dall-e-2",
  n = NULL,
  response_format = NULL,
  size = NULL,
  user = NULL
)

---

Method create_variation()

Usage

ImagesClient$create_variation(
  image,
  model = "dall-e-2",
  n = NULL,
  response_format = NULL,
  size = NULL,
  user = NULL
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ImagesClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.