FileServiceImpl 0.33.0 API

All Implemented Interfaces:: com.openai.services.blocking.FileService


public final class FileServiceImpl
 implements FileService

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileServiceImpl.WithRawResponseImpl`

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
`FileService.WithRawResponse`	`withRawResponse()`	Returns a view of this service that provides access to raw HTTP responses for each method.
`FileObject`	`create(FileCreateParams params, RequestOptions requestOptions)`	Upload a file that can be used across various endpoints.
`FileObject`	`retrieve(FileRetrieveParams params, RequestOptions requestOptions)`	Returns information about a specific file.
`FileListPage`	`list(FileListParams params, RequestOptions requestOptions)`	Returns a list of files.
`FileDeleted`	`delete(FileDeleteParams params, RequestOptions requestOptions)`	Delete a file.
`HttpResponse`	`content(FileContentParams params, RequestOptions requestOptions)`	Returns the contents of the specified file.

Methods inherited from class com.openai.services.blocking.FileService
list
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - withRawResponse
```
 FileService.WithRawResponse withRawResponse()
```
    Returns a view of this service that provides access to raw HTTP responses for each method.
  - create
```
 FileObject create(FileCreateParams params, RequestOptions requestOptions)
```
    Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB.
    The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details.
    The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models.
    The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format.
    Please contact us if you need to increase these storage limits.
  - retrieve
```
 FileObject retrieve(FileRetrieveParams params, RequestOptions requestOptions)
```
    Returns information about a specific file.
  - list
```
 FileListPage list(FileListParams params, RequestOptions requestOptions)
```
    Returns a list of files.
  - delete
```
 FileDeleted delete(FileDeleteParams params, RequestOptions requestOptions)
```
    Delete a file.
  - content
```
 HttpResponse content(FileContentParams params, RequestOptions requestOptions)
```
    Returns the contents of the specified file.