Class FileObject
-
- All Implemented Interfaces:
public final class FileObject
The
File
object represents a document that has been uploaded to OpenAI.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileObject.Builder
public final class
FileObject.Object
The object type, which is always
file
.public final class
FileObject.Purpose
The intended purpose of the file. Supported values are
assistants
,assistants_output
,batch
,batch_output
,fine-tune
,fine-tune-results
andvision
.public final class
FileObject.Status
Deprecated. The current status of the file, which can be either
uploaded
,processed
, orerror
.
-
Method Summary
Modifier and Type Method Description final String
id()
The file identifier, which can be referenced in the API endpoints. final Long
bytes()
The size of the file, in bytes. final Long
createdAt()
The Unix timestamp (in seconds) for when the file was created. final String
filename()
The name of the file. final FileObject.Object
object_()
The object type, which is always file
.final FileObject.Purpose
purpose()
The intended purpose of the file. final FileObject.Status
status()
Deprecated. final Optional<String>
statusDetails()
Deprecated. final JsonField<String>
_id()
The file identifier, which can be referenced in the API endpoints. final JsonField<Long>
_bytes()
The size of the file, in bytes. final JsonField<Long>
_createdAt()
The Unix timestamp (in seconds) for when the file was created. final JsonField<String>
_filename()
The name of the file. final JsonField<FileObject.Object>
_object_()
The object type, which is always file
.final JsonField<FileObject.Purpose>
_purpose()
The intended purpose of the file. final JsonField<FileObject.Status>
_status()
Deprecated. final JsonField<String>
_statusDetails()
Deprecated. final Map<String, JsonValue>
_additionalProperties()
final FileObject
validate()
final FileObject.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileObject.Builder
builder()
-
-
Method Detail
-
object_
final FileObject.Object object_()
The object type, which is always
file
.
-
purpose
final FileObject.Purpose purpose()
The intended purpose of the file. Supported values are
assistants
,assistants_output
,batch
,batch_output
,fine-tune
,fine-tune-results
andvision
.
-
status
@Deprecated(message = "deprecated") final FileObject.Status status()
Deprecated. The current status of the file, which can be either
uploaded
,processed
, orerror
.
-
statusDetails
@Deprecated(message = "deprecated") final Optional<String> statusDetails()
Deprecated. For details on why a fine-tuning training file failed validation, see the
error
field onfine_tuning.job
.
-
_id
final JsonField<String> _id()
The file identifier, which can be referenced in the API endpoints.
-
_createdAt
final JsonField<Long> _createdAt()
The Unix timestamp (in seconds) for when the file was created.
-
_object_
final JsonField<FileObject.Object> _object_()
The object type, which is always
file
.
-
_purpose
final JsonField<FileObject.Purpose> _purpose()
The intended purpose of the file. Supported values are
assistants
,assistants_output
,batch
,batch_output
,fine-tune
,fine-tune-results
andvision
.
-
_status
@Deprecated(message = "deprecated") final JsonField<FileObject.Status> _status()
Deprecated. The current status of the file, which can be either
uploaded
,processed
, orerror
.
-
_statusDetails
@Deprecated(message = "deprecated") final JsonField<String> _statusDetails()
Deprecated. For details on why a fine-tuning training file failed validation, see the
error
field onfine_tuning.job
.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final FileObject validate()
-
toBuilder
final FileObject.Builder toBuilder()
-
builder
final static FileObject.Builder builder()
-
-
-
-