Struct async_openai::Files

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

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. The size of all the files uploaded by one organization can be up to 100 GB.

The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

Please contact us if you need to increase these storage limits.

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

where Q: Serialize + ?Sized,

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 delete( &self, file_id: &str ) -> Result<DeleteFileResponse, OpenAIError>

Delete a file.

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

Returns the contents of the specified file