Package com.openai.models.uploads
Class Upload
-
- All Implemented Interfaces:
public final class UploadThe Upload object can accept byte chunks in the form of Parts.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUpload.BuilderA builder for Upload.
public final classUpload.StatusThe status of the Upload.
-
Method Summary
Modifier and Type Method Description final Stringid()The Upload unique identifier, which can be referenced in API endpoints. final Longbytes()The intended number of bytes to be uploaded. final LongcreatedAt()The Unix timestamp (in seconds) for when the Upload was created. final LongexpiresAt()The Unix timestamp (in seconds) for when the Upload will expire. final Stringfilename()The name of the file to be uploaded. final JsonValue_object_()The object type, which is always "upload". final Stringpurpose()The intended purpose of the file. final Upload.Statusstatus()The status of the Upload. final Optional<FileObject>file()The Fileobject represents a document that has been uploaded to OpenAI.final JsonField<String>_id()The Upload unique identifier, which can be referenced in API endpoints. final JsonField<Long>_bytes()The intended number of bytes to be uploaded. final JsonField<Long>_createdAt()The Unix timestamp (in seconds) for when the Upload was created. final JsonField<Long>_expiresAt()The Unix timestamp (in seconds) for when the Upload will expire. final JsonField<String>_filename()The name of the file to be uploaded. final JsonField<String>_purpose()The intended purpose of the file. final JsonField<Upload.Status>_status()The status of the Upload. final JsonField<FileObject>_file()The Fileobject represents a document that has been uploaded to OpenAI.final Map<String, JsonValue>_additionalProperties()final Uploadvalidate()final Upload.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Upload.Builderbuilder()Returns a mutable builder for constructing an instance of Upload. -
-
Method Detail
-
purpose
final String purpose()
The intended purpose of the file. Please refer here for acceptable values.
-
status
final Upload.Status status()
The status of the Upload.
-
file
final Optional<FileObject> file()
The
Fileobject represents a document that has been uploaded to OpenAI.
-
_id
final JsonField<String> _id()
The Upload unique identifier, which can be referenced in API endpoints.
-
_createdAt
final JsonField<Long> _createdAt()
The Unix timestamp (in seconds) for when the Upload was created.
-
_expiresAt
final JsonField<Long> _expiresAt()
The Unix timestamp (in seconds) for when the Upload will expire.
-
_purpose
final JsonField<String> _purpose()
The intended purpose of the file. Please refer here for acceptable values.
-
_status
final JsonField<Upload.Status> _status()
The status of the Upload.
-
_file
final JsonField<FileObject> _file()
The
Fileobject represents a document that has been uploaded to OpenAI.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Upload.Builder toBuilder()
-
builder
final static Upload.Builder builder()
Returns a mutable builder for constructing an instance of Upload.
The following fields are required:
.id() .bytes() .createdAt() .expiresAt() .filename() .purpose() .status()
-
-
-
-