Struct async_openai::File
source · pub struct File;Expand description
Files are used to upload documents that can be used with features like Fine-tuning.
Implementations§
source§impl File
impl File
sourcepub async fn create(
client: &Client,
request: CreateFileRequest
) -> Result<OpenAIFile, OpenAIError>
pub async fn create(
client: &Client,
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.
sourcepub async fn list(client: &Client) -> Result<ListFilesResponse, OpenAIError>
pub async fn list(client: &Client) -> Result<ListFilesResponse, OpenAIError>
Returns a list of files that belong to the user’s organization.
sourcepub async fn retrieve(
client: &Client,
file_id: &str
) -> Result<OpenAIFile, OpenAIError>
pub async fn retrieve(
client: &Client,
file_id: &str
) -> Result<OpenAIFile, OpenAIError>
Returns information about a specific file.
sourcepub async fn delete(
client: &Client,
file_id: &str
) -> Result<DeleteFileResponse, OpenAIError>
pub async fn delete(
client: &Client,
file_id: &str
) -> Result<DeleteFileResponse, OpenAIError>
Delete a file.
sourcepub async fn retrieve_content(
client: &Client,
file_id: &str
) -> Result<String, OpenAIError>
pub async fn retrieve_content(
client: &Client,
file_id: &str
) -> Result<String, OpenAIError>
Returns the contents of the specified file