Struct Files 

pub struct Files<'c, C: Config> { /* private fields */ }

Available on crate feature file only.

Files are used to upload documents that can be used with features like Assistants and Fine-tuning.

Implementations

impl<'c, C: Config> Files<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create( &self, request: CreateFileRequest, ) -> Result<OpenAIFile, OpenAIError>

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit.

The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details.

The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models.

The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format.

pub async fn create_byot<T0: Clone, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

where Form: AsyncTryFrom<T0, Error = OpenAIError>,

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit.

The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details.

The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models.

The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format.

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

Returns a list of files that belong to the user’s organization.

pub async fn list_byot<R: DeserializeOwned>(&self) -> Result<R, OpenAIError>

Returns a list of files that belong to the user’s organization.

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

Returns information about a specific file.

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, file_id: T0, ) -> Result<R, OpenAIError>

Returns information about a specific file.

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

Delete a file.

pub async fn delete_byot<T0: Display, R: DeserializeOwned>( &self, file_id: T0, ) -> Result<R, OpenAIError>

Delete a file.

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

Returns the contents of the specified file

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for Files<'c, C>

Available on crate feature _api only.

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)

fn options(&self) -> &RequestOptions

Get reference to RequestOptions

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

where K: IntoHeaderName, V: TryInto<HeaderValue>, V::Error: Into<InvalidHeaderValue>,

Add a single header to RequestOptions

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions