Struct File

pub struct File {
    pub id: String,
    pub object: String,
    pub bytes: usize,
    pub created_at: usize,
    pub filename: String,
    pub purpose: String,
}

Upload, download and delete a file from the openai platform.

Fields

id: String

The unique id for this uploaded the in the openai platform. This id is generated by openai for each uploaded file.

object: String

The object type uploaded. ie: “file”

bytes: usize

The size in bytes of the uploaded file.

created_at: usize

Unix timestamp, seconds since epoch, of when the file was uploaded.

filename: String

The name of the file uploaded.

purpose: String

The purpose of the file. ie: “fine-tine”

Implementations

impl File

pub fn builder() -> FileUploadBuilder

New FileUploadBuilder

pub async fn delete( id: &str, credentials: Credentials, ) -> ApiResponseOrError<DeletedFile>

Delete a file from openai platform by id.

pub async fn get(id: &str) -> ApiResponseOrError<File>

👎Deprecated since 1.0.0-alpha.16: use fetch instead

Get a file from openai platform by id.

pub async fn fetch( id: &str, credentials: Credentials, ) -> ApiResponseOrError<File>

Get a file from openai platform by id.

pub async fn get_content_bytes(id: &str) -> ApiResponseOrError<Vec<u8>>

👎Deprecated since 1.0.0-alpha.16: use fetch_content_bytes instead

Download a file as bytes into memory by id.

pub async fn fetch_content_bytes( id: &str, credentials: Credentials, ) -> ApiResponseOrError<Vec<u8>>

Download a file as bytes into memory by id.

pub async fn download_content_to_file( id: &str, file_path: &str, credentials: Credentials, ) -> ApiResponseOrError<()>

Download a file to a new local file by id.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for File

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.