File Tasks
Files are used to upload documents that can be used with features like Assistants and Fine-tuning. Official OpenAI Docs
list()
Returns a list of files that belong to the user’s organization. Official OpenAI Docs
await io.openai.files.list("list-files");
await io.openai.files.list("list-files", { purpose: "assistants" }); // gets only assistant files
create()
Upload a file that can be used across various endpoints/features. The size of all the files uploaded by one organization can be up to 100 GB.
The size of individual files for can be a maximum of 512MB
. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports .jsonl
files.
const file = await io.openai.files.create("upload-file", {
purpose: "assistants",
file: fs.createReadStream("./fixtures/mydata.csv"),
});
createAndWaitForProcessing()
Upload a file and will return when the file is processed by polling in the background using io.backgroundPoll().
const file = await io.openai.files.createAndWaitForProcessing("upload-file", {
purpose: "assistants",
file: fs.createReadStream("./fixtures/mydata.csv"),
});
waitForProcessing()
Will return when the file is processed by polling in the background using io.backgroundPoll().
const file = await io.openai.files.create("upload-file", {
purpose: "assistants",
file: fs.createReadStream("./fixtures/mydata.csv"),
});
const processedFile = await io.openai.files.waitForProcessing("wait", file.id);
retrieve()
Returns information about a specific file. Official OpenAI Docs
await io.openai.files.retrieve("retrieve-file", "file-id");
Was this page helpful?