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 SummaryNested Classes Modifier and Type Class Description public final classUploadCreateParams.BuilderA builder for UploadCreateParams. public final classUploadCreateParams.Bodypublic final classUploadCreateParams.ExpiresAfterThe expiration policy for a file. By default, files with purpose=batchexpire after 30 days and all other files are persisted until they are manually deleted.
 - 
                                
                            
                                Method SummaryModifier 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 Optional<UploadCreateParams.ExpiresAfter>expiresAfter()The expiration policy for a 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 JsonField<UploadCreateParams.ExpiresAfter>_expiresAfter()Returns the raw JSON value of expiresAfter. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final UploadCreateParams.BuildertoBuilder()final UploadCreateParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static UploadCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of UploadCreateParams. - 
                    
                    
                    - 
                                
                            
                                Method Detail- 
                                        mimeTypefinal 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. 
 - 
                                        purposefinal FilePurpose purpose() The intended purpose of the uploaded file. See the documentation on File purposes. 
 - 
                                        expiresAfterfinal Optional<UploadCreateParams.ExpiresAfter> expiresAfter() The expiration policy for a file. By default, files with purpose=batchexpire after 30 days and all other files are persisted until they are manually deleted.
 - 
                                        _bytesfinal 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. 
 - 
                                        _filenamefinal 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. 
 - 
                                        _mimeTypefinal 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. 
 - 
                                        _purposefinal 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. 
 - 
                                        _expiresAfterfinal JsonField<UploadCreateParams.ExpiresAfter> _expiresAfter() Returns the raw JSON value of expiresAfter. Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type. 
 - 
                                        _additionalBodyPropertiesfinal Map<String, JsonValue> _additionalBodyProperties() 
 - 
                                        _additionalHeadersfinal Headers _additionalHeaders() Additional headers to send with the request. 
 - 
                                        _additionalQueryParamsfinal QueryParams _additionalQueryParams() Additional query param to send with the request. 
 - 
                                        toBuilderfinal UploadCreateParams.Builder toBuilder() 
 - 
                                        _bodyfinal UploadCreateParams.Body _body() 
 - 
                                        _headersHeaders _headers() The full set of headers in the parameters, including both fixed and additional headers. 
 - 
                                        _queryParamsQueryParams _queryParams() The full set of query params in the parameters, including both fixed and additional query params. 
 - 
                                        builderfinal static UploadCreateParams.Builder builder() Returns a mutable builder for constructing an instance of UploadCreateParams. The following fields are required: .bytes() .filename() .mimeType() .purpose()
 
- 
                                        
 
- 
                                
                            
                                
 
- 
                    
                    
                    
 
-