openaiRtools (version 0.2.2)

FilesClient: Files Client

Description

Client for the OpenAI Files API. Upload, list, retrieve, and delete files that can be used with fine-tuning, assistants, batch processing, and more. Access via client$files.

Methods

$create(file, purpose)

Upload a file

$list(...)

List uploaded files, optionally filter by purpose

$retrieve(file_id)

Get metadata for a specific file

$delete(file_id)

Delete a file

$content(file_id)

Download the raw content of a file

$wait_for_processing(file_id, ...)

Poll until a file is processed

Methods

Public methods

• FilesClient$new()

• FilesClient$create()

• FilesClient$list()

• FilesClient$retrieve()

• FilesClient$delete()

• FilesClient$content()

• FilesClient$wait_for_processing()

• FilesClient$clone()

---

Method new()

Usage

FilesClient$new(parent)

---

Method create()

Usage

FilesClient$create(file, purpose)

---

Method list()

Usage

FilesClient$list(purpose = NULL, limit = NULL, after = NULL, order = NULL)

---

Method retrieve()

Usage

FilesClient$retrieve(file_id)

---

Method delete()

Usage

FilesClient$delete(file_id)

---

Method content()

Usage

FilesClient$content(file_id)

---

Method wait_for_processing()

Usage

FilesClient$wait_for_processing(file_id, timeout = 300, poll_interval = 5)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FilesClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.