Class FileCreateParams.Body
-
- All Implemented Interfaces:
public final class FileCreateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final InputStreamfile()The File object (not file name) to be uploaded. final FilePurposepurpose()The intended purpose of the uploaded file. final Optional<FileCreateParams.ExpiresAfter>expiresAfter()The expiration policy for a file. final MultipartField<InputStream>_file()Returns the raw multipart value of file. final MultipartField<FilePurpose>_purpose()Returns the raw multipart value of purpose. final MultipartField<FileCreateParams.ExpiresAfter>_expiresAfter()Returns the raw multipart value of expiresAfter. final Map<String, JsonValue>_additionalProperties()final FileCreateParams.Body.BuildertoBuilder()final FileCreateParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
file
final InputStream file()
The File object (not file name) to be uploaded.
-
purpose
final FilePurpose purpose()
The intended purpose of the uploaded file. One of: -
assistants: Used in the Assistants API -batch: Used in the Batch API -fine-tune: Used for fine-tuning -vision: Images used for vision fine-tuning -user_data: Flexible file type for any purpose -evals: Used for eval data sets
-
expiresAfter
final Optional<FileCreateParams.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.
-
_file
final MultipartField<InputStream> _file()
Returns the raw multipart value of file.
Unlike file, this method doesn't throw if the multipart field has an unexpected type.
-
_purpose
final MultipartField<FilePurpose> _purpose()
Returns the raw multipart value of purpose.
Unlike purpose, this method doesn't throw if the multipart field has an unexpected type.
-
_expiresAfter
final MultipartField<FileCreateParams.ExpiresAfter> _expiresAfter()
Returns the raw multipart value of expiresAfter.
Unlike expiresAfter, this method doesn't throw if the multipart field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileCreateParams.Body.Builder toBuilder()
-
validate
final FileCreateParams.Body validate()
-
builder
final static FileCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.file() .purpose()
-
-
-
-