Package com.openai.models
Class Upload
-
- All Implemented Interfaces:
public final class Upload
The Upload object can accept byte chunks in the form of Parts.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
Upload.Builder
A builder for Upload.
public final class
Upload.Status
The status of the Upload.
-
Method Summary
Modifier and Type Method Description final String
id()
The Upload unique identifier, which can be referenced in API endpoints. final Long
bytes()
The intended number of bytes to be uploaded. final Long
createdAt()
The Unix timestamp (in seconds) for when the Upload was created. final Long
expiresAt()
The Unix timestamp (in seconds) for when the Upload was created. final String
filename()
The name of the file to be uploaded. final JsonValue
_object_()
The object type, which is always "upload". final String
purpose()
The intended purpose of the file. final Upload.Status
status()
The status of the Upload. final Optional<FileObject>
file()
The File
object 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 was created. 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 File
object represents a document that has been uploaded to OpenAI.final Map<String, JsonValue>
_additionalProperties()
final Upload
validate()
final Upload.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static Upload.Builder
builder()
-
-
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
File
object 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 was created.
-
_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
File
object 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()
-
-
-
-