Struct FileUploadBuilder 

pub struct FileUploadBuilder { /* private fields */ }

Builder for file upload operations.

This builder provides a fluent interface for uploading files to OpenAI with specified purposes and metadata.

Implementations

impl FileUploadBuilder

pub fn new( filename: impl Into<String>, purpose: FilePurpose, content: Vec<u8>, ) -> Self

Create a new file upload builder with file content and purpose.

Examples

use openai_ergonomic::builders::files::{FileUploadBuilder, FilePurpose};

let content = b"Hello, world!";
let builder = FileUploadBuilder::new("hello.txt", FilePurpose::Assistants, content.to_vec());

pub fn from_path( path: impl AsRef<Path>, purpose: FilePurpose, ) -> Result<Self, Error>

Create a file upload builder from a file path.

This is a convenience method that reads the file from disk. Note: This is a sync operation and will read the entire file into memory.

pub fn from_text( filename: impl Into<String>, purpose: FilePurpose, text: impl Into<String>, ) -> Self

Create a file upload builder from text content.

pub fn from_json( filename: impl Into<String>, purpose: FilePurpose, json: &Value, ) -> Result<Self, Error>

Create a file upload builder from JSON content.

pub fn filename(&self) -> &str

Get the filename for this upload.

pub fn purpose(&self) -> &FilePurpose

Get the purpose for this upload.

pub fn content(&self) -> &[u8]

Get the content for this upload.

pub fn content_size(&self) -> usize

Get the size of the content in bytes.

pub fn is_empty(&self) -> bool

Check if the file is empty.

pub fn content_as_string(&self) -> Option<String>

Get the content as a string (if it’s valid UTF-8).

Trait Implementations

impl Clone for FileUploadBuilder

fn clone(&self) -> FileUploadBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileUploadBuilder

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

Formats the value using the given formatter.