Class UploadCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class UploadCreateParams implements Params
Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.
Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.
For certain
purposevalues, the correctmime_typemust be specified. Please refer to documentation for the supported MIME types for your use case.For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUploadCreateParams.Bodypublic final classUploadCreateParams.BuilderA builder for UploadCreateParams.
-
Method Summary
Modifier and Type Method Description final Longbytes()The number of bytes in the file you are uploading. final Stringfilename()The name of the file to upload. final StringmimeType()The MIME type of the file. final FilePurposepurpose()The intended purpose of the uploaded file. final JsonField<Long>_bytes()The number of bytes in the file you are uploading. final JsonField<String>_filename()The name of the file to upload. final JsonField<String>_mimeType()The MIME type of the file. final JsonField<FilePurpose>_purpose()The intended purpose of the uploaded file. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. final UploadCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static UploadCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of UploadCreateParams. -
-
Method Detail
-
mimeType
final String mimeType()
The MIME type of the file.
This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.
-
purpose
final FilePurpose purpose()
The intended purpose of the uploaded file.
See the documentation on File purposes.
-
_mimeType
final JsonField<String> _mimeType()
The MIME type of the file.
This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.
-
_purpose
final JsonField<FilePurpose> _purpose()
The intended purpose of the uploaded file.
See the documentation on File purposes.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
toBuilder
final UploadCreateParams.Builder toBuilder()
-
builder
final static UploadCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of UploadCreateParams.
The following fields are required:
.bytes() .filename() .mimeType() .purpose()
-
-
-
-