Body 0.37.0 API

All Implemented Interfaces:


public final class FileCreateParams.Body

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileCreateParams.Body.Builder`	A builder for Body.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final InputStream`	`file()`	The File object (not file name) to be uploaded.
`final FilePurpose`	`purpose()`	The intended purpose of the uploaded file.
`final MultipartField<InputStream>`	`_file()`	Returns the raw multipart value of file.
`final MultipartField<FilePurpose>`	`_purpose()`	Returns the raw multipart value of purpose.
`final FileCreateParams.Body.Builder`	`toBuilder()`
`final FileCreateParams.Body`	`validate()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FileCreateParams.Body.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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
  - _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.
  - toBuilder
```
 final FileCreateParams.Body.Builder toBuilder()
```
  - validate
```
 final FileCreateParams.Body validate()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FileCreateParams.Body.Builder builder()
```
    Returns a mutable builder for constructing an instance of Body.
    The following fields are required:
    .file() .purpose()