Skip to contents

Create edit

Source: R/create_edit.R
create_edit.Rd

Creates an edit based on the provided input, instruction, and parameters. See this page for details.

Usage

create_edit(
  engine_id = deprecated(),
  model,
  input = "\"",
  instruction,
  temperature = 1,
  top_p = 1,
  openai_api_key = Sys.getenv("OPENAI_API_KEY"),
  openai_organization = NULL
)

Arguments

engine_id

[Deprecated]

model

required; a length one character vector.

input

required; defaults to '"'; a length one character vector.

instruction

required; a length one character vector.

temperature

required; defaults to 1; a length one numeric vector with the value between 0 and 2.

top_p

required; defaults to 1; a length one numeric vector with the value between 0 and 1.

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.

Value

Returns a list, elements of which contain edited version of prompt and supplementary information.

Details

For arguments description please refer to the official documentation.

Examples

if (FALSE) { # \dontrun{
create_edit(
    model = "text-davinci-edit-001",
    input = "What day of the wek is it?",
    instruction = "Fix the spelling mistakes"
)
} # }