openaiRtools (version 0.2.2)

cancel_batch: Cancel a Batch Job (Convenience Function)

Description

Shortcut that creates an OpenAI client from the OPENAI_API_KEY environment variable and cancels a batch job.

Usage

cancel_batch(batch_id)

Value

A batch object with $status = "cancelling".

Arguments

batch_id

Character. Required. The batch ID to cancel.

Examples

if (FALSE) {
Sys.setenv(OPENAI_API_KEY = "sk-xxxxxx")

result <- cancel_batch("batch_abc123")
cat("Status:", result$status)
}