The File object represents a document that has been uploaded to OpenAI.
Constructors
new(id :
String = "", bytes :
Int64 = 0, created_at :
Int64 = 0, expires_at :
Int64 |
Nil = nil, filename :
String = "", object :
OpenAIFileObject =
OpenAIFileObject::File, purpose :
OpenAIFilePurpose =
OpenAIFilePurpose::Assistants, status :
OpenAIFileStatus =
OpenAIFileStatus::Uploaded, status_details :
String |
Nil = nil)
SourceInstance methods
bytes
The size of the file, in bytes.
The size of the file, in bytes.
created_at
The Unix timestamp (in seconds) for when the file was created.
created_at=(created_at :
Int64)
The Unix timestamp (in seconds) for when the file was created.
expires_at
The Unix timestamp (in seconds) for when the file will expire.
expires_at=(expires_at :
Int64 |
Nil)
The Unix timestamp (in seconds) for when the file will expire.
id
The file identifier, which can be referenced in the API endpoints.
The file identifier, which can be referenced in the API endpoints.
object
The object type, which is always file.
object=(object : OpenAIFileObject)
The object type, which is always file.
purpose
The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
purpose=(purpose : OpenAIFilePurpose)
The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
status
Deprecated. The current status of the file, which can be either uploaded, processed, or error.
status=(status : OpenAIFileStatus)
Deprecated. The current status of the file, which can be either uploaded, processed, or error.
status_details
Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.
status_details=(status_details :
String |
Nil)
Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.