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
purpose
values, the correctmime_type
must 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 class
UploadCreateParams.Builder
A builder for UploadCreateParams.
public final class
UploadCreateParams.Body
-
Method Summary
Modifier and Type Method Description final Long
bytes()
The number of bytes in the file you are uploading. final String
filename()
The name of the file to upload. final String
mimeType()
The MIME type of the file. final FilePurpose
purpose()
The intended purpose of the uploaded file. final JsonField<Long>
_bytes()
Returns the raw JSON value of bytes. final JsonField<String>
_filename()
Returns the raw JSON value of filename. final JsonField<String>
_mimeType()
Returns the raw JSON value of mimeType. final JsonField<FilePurpose>
_purpose()
Returns the raw JSON value of purpose. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final UploadCreateParams.Builder
toBuilder()
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. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static UploadCreateParams.Builder
builder()
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.
-
_bytes
final JsonField<Long> _bytes()
Returns the raw JSON value of bytes.
Unlike bytes, this method doesn't throw if the JSON field has an unexpected type.
-
_filename
final JsonField<String> _filename()
Returns the raw JSON value of filename.
Unlike filename, this method doesn't throw if the JSON field has an unexpected type.
-
_mimeType
final JsonField<String> _mimeType()
Returns the raw JSON value of mimeType.
Unlike mimeType, this method doesn't throw if the JSON field has an unexpected type.
-
_purpose
final JsonField<FilePurpose> _purpose()
Returns the raw JSON value of purpose.
Unlike purpose, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final UploadCreateParams.Builder toBuilder()
-
_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.
-
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()
-
-
-
-