Struct FilesClient 

pub struct FilesClient<'a, T = ()> { /* private fields */ }

Client for files API.

Implementations

impl<T: Default + Send + Sync> FilesClient<'_, T>

pub async fn upload(&self, builder: FileUploadBuilder) -> Result<OpenAiFile>

Upload a file to OpenAI.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::files::FilePurpose;

let client = Client::from_env()?;
let builder = client
    .files()
    .upload_text("training.jsonl", FilePurpose::FineTune, "training data");
let file = client.files().create(builder).await?;
println!("Uploaded file: {}", file.id);

pub async fn create(&self, builder: FileUploadBuilder) -> Result<OpenAiFile>

Convenience method to upload a file (alias for upload).

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::files::FilePurpose;

let client = Client::from_env()?;
let builder = client
    .files()
    .upload_text("data.txt", FilePurpose::Assistants, "content");
let file = client.files().create(builder).await?;
println!("File ID: {}", file.id);

pub fn upload_text( &self, filename: impl Into<String>, purpose: FilePurpose, text: impl Into<String>, ) -> FileUploadBuilder

Create a file upload builder from text content.

pub fn upload_bytes( &self, filename: impl Into<String>, purpose: FilePurpose, content: Vec<u8>, ) -> FileUploadBuilder

Create a file upload builder from bytes.

pub fn upload_from_path( &self, path: impl AsRef<Path>, purpose: FilePurpose, ) -> Result<FileUploadBuilder>

Create a file upload builder from a file path.

pub async fn list(&self, builder: FileListBuilder) -> Result<ListFilesResponse>

List files.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let builder = client.files().list_builder();
let files = client.files().list(builder).await?;
println!("Found {} files", files.data.len());

pub fn list_builder(&self) -> FileListBuilder

Create a list files builder.

pub async fn retrieve(&self, file_id: impl Into<String>) -> Result<OpenAiFile>

Retrieve information about a specific file.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let file = client.files().retrieve("file-123").await?;
println!("File: {} ({})", file.filename, file.id);

pub async fn get(&self, builder: FileRetrievalBuilder) -> Result<OpenAiFile>

Retrieve information about a file using a builder.

pub async fn download(&self, file_id: impl Into<String>) -> Result<String>

Download file content.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let content = client.files().download("file-123").await?;
println!("Downloaded {} bytes", content.len());

pub async fn download_bytes( &self, file_id: impl Into<String>, ) -> Result<Vec<u8>>

Download file content as bytes.

pub async fn delete( &self, file_id: impl Into<String>, ) -> Result<DeleteFileResponse>

Delete a file.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.files().delete("file-123").await?;
println!("Deleted: {}", response.deleted);

pub async fn remove( &self, builder: FileDeleteBuilder, ) -> Result<DeleteFileResponse>

Delete a file using a builder.

Trait Implementations

impl<'a, T: Clone> Clone for FilesClient<'a, T>

fn clone(&self) -> FilesClient<'a, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for FilesClient<'a, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, T: Copy> Copy for FilesClient<'a, T>