Cancel batch job — batch_cancel • gpteasyr

Cancel batch job

Usage

batch_cancel(batch_id)

Arguments

batch_id: (chr) the batch id to cancel

Value

(tibble) information about the cancelled batch

Details

For more information, see the OpenAI API documentation.

See also

Other batches: batch_create(), batch_list(), batch_result(), batch_status(), file_upload()

Examples

if (FALSE) {
  batch_cancel("batch_abc123")

  batch_file_info <- file_upload("abc123.jsonl")
  batch_job_info <- batch_file_info[["id"]] |>
    batch_create()
  batch_cancelled <- batch_job_info[["id"]] |>
    batch_cancel()
  batch_cancelled
}