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 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 contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.

pub async fn list(&self) -> Result<ListFilesResponse, 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 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