Struct Files 

pub struct Files<'a> { /* private fields */ }

Access file endpoints.

API reference: https://platform.openai.com/docs/api-reference/files

Implementations

impl<'a> Files<'a>

pub async fn create_from_path( &self, path: impl AsRef<Path>, purpose: FilePurpose, ) -> Result<FileObject, OpenAIError>

Upload a file from a filesystem path.

Reads the file asynchronously and infers the filename from the path.

let file = client.files().create_from_path("data.jsonl", FilePurpose::FineTune).await?;

pub async fn create( &self, params: FileUploadParams, ) -> Result<FileObject, OpenAIError>

Upload a file.

POST /files

pub async fn list(&self) -> Result<FileList, OpenAIError>

List files.

GET /files

pub async fn list_page( &self, params: FileListParams, ) -> Result<FileList, OpenAIError>

List files with pagination parameters.

GET /files

pub fn list_auto(&self, params: FileListParams) -> Paginator<FileObject>

Auto-paginate through all files.

Returns a Paginator stream that yields individual FileObject items, automatically fetching subsequent pages.

pub async fn retrieve(&self, file_id: &str) -> Result<FileObject, OpenAIError>

Retrieve a file by ID.

GET /files/{file_id}

pub async fn delete(&self, file_id: &str) -> Result<FileDeleted, OpenAIError>

Delete a file.

DELETE /files/{file_id}

pub async fn content(&self, file_id: &str) -> Result<Bytes, OpenAIError>

Retrieve file content as bytes.

GET /files/{file_id}/content