Struct OpenAiFile

pub struct OpenAiFile {
    pub id: String,
    pub bytes: u64,
    pub created_at: u64,
    pub expires_at: Option<u64>,
    pub filename: String,
    pub purpose: OpenAiFilePurpose,
    pub status: OpenAiFileStatus,
    pub status_details: Option<String>,
}

The File object represents a document that has been uploaded to OpenAI.

Fields

id: String

The file identifier, which can be referenced in the API endpoints.

bytes: u64

The size of the file, in bytes.

created_at: u64

The Unix timestamp (in seconds) for when the file was created.

expires_at: Option<u64>

The Unix timestamp (in seconds) for when the file will expire.

filename: String

The name of the file.

purpose: OpenAiFilePurpose

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

status: OpenAiFileStatus

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

status_details: Option<String>

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Implementations

impl OpenAiFile

pub fn builder() -> OpenAiFileBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building OpenAiFile. On the builder, call .id(...), .bytes(...), .created_at(...), .expires_at(...)(optional), .filename(...), .purpose(...), .status(...), .status_details(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of OpenAiFile.

Trait Implementations

impl Clone for OpenAiFile

fn clone(&self) -> OpenAiFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAiFile

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenAiFile

fn eq(&self, other: &OpenAiFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenAiFile

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenAiFile