Class FileObject
-
- All Implemented Interfaces:
public final class FileObjectThe
Fileobject represents a document that has been uploaded to OpenAI.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileObject.Builderpublic final classFileObject.PurposeThe intended purpose of the file. Supported values are
assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-resultsandvision.public final classFileObject.StatusDeprecated. The current status of the file, which can be either
uploaded,processed, orerror.
-
Method Summary
Modifier and Type Method Description final Stringid()The file identifier, which can be referenced in the API endpoints. final Longbytes()The size of the file, in bytes. final LongcreatedAt()The Unix timestamp (in seconds) for when the file was created. final Stringfilename()The name of the file. final JsonValue_object_()The object type, which is always file.final FileObject.Purposepurpose()The intended purpose of the file. final FileObject.Statusstatus()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.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 FileObjectvalidate()final FileObject.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileObject.Builderbuilder()-
-
Method Detail
-
purpose
final FileObject.Purpose purpose()
The intended purpose of the file. Supported values are
assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-resultsandvision.
-
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
errorfield 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.
-
_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-resultsandvision.
-
_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
errorfield onfine_tuning.job.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final FileObject validate()
-
toBuilder
final FileObject.Builder toBuilder()
-
builder
final static FileObject.Builder builder()
-
-
-
-