openaiRtools (version 0.2.2)

list_files: List Uploaded Files (Convenience Function)

Description

Shortcut that creates an OpenAI client from the OPENAI_API_KEY environment variable and calls client$files$list().

Usage

list_files(purpose = NULL, ...)

Value

A list with $data — a list of file objects, each containing $id, $filename, $bytes, $purpose, $status, and $created_at.

Arguments

purpose

Character or NULL. Filter by purpose: "assistants", "vision", "batch", or "fine-tune". If NULL, all files are returned. Default: NULL.

...

Additional parameters passed to FilesClient$list(), such as limit, after, order.

Examples

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

# List all files
all_files <- list_files()
cat("Total files:", length(all_files$data))

# List only fine-tuning files
ft_files <- list_files(purpose = "fine-tune")
for (f in ft_files$data) cat(f$id, f$filename, "\n")
}