Delete file — delete_file • openai

Deletes a file. See this page for details.

delete_file(
  file_id,
  openai_api_key = Sys.getenv("OPENAI_API_KEY"),
  openai_organization = NULL
)

Arguments

file_id: required; 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.

Value

Returns a list, elements of which contains ID of the deleted file and status whether the file is deleted.

Details

For arguments description please refer to the official documentation.

See also

Other file functions: list_files(), retrieve_file_content(), retrieve_file(), upload_file()

Examples

if (FALSE) { # \dontrun{
file <- system.file("extdata", "classification-file.jsonl", package = "openai")
file_info <- upload_file(file = file, purpose = "classification")
delete_file(file_info$id)
} # }