All Implemented Interfaces:


public interface FileServiceAsync

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`FileServiceAsync.WithRawResponse`	A view of FileServiceAsync that provides access to raw HTTP responses for each method.

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

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

- Constructor Detail
- Method Detail
  - withRawResponse
```
 abstract FileServiceAsync.WithRawResponse withRawResponse()
```
    Returns a view of this service that provides access to raw HTTP responses for each method.
  - create
```
 abstract CompletableFuture<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.
  - create
```
 abstract CompletableFuture<FileObject> create(FileCreateParams params)
```
    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
```
 abstract CompletableFuture<FileObject> retrieve(FileRetrieveParams params, RequestOptions requestOptions)
```
    Returns information about a specific file.
  - retrieve
```
 abstract CompletableFuture<FileObject> retrieve(FileRetrieveParams params)
```
    Returns information about a specific file.
  - list
```
 abstract CompletableFuture<FileListPageAsync> list(FileListParams params, RequestOptions requestOptions)
```
    Returns a list of files.
  - list
```
 abstract CompletableFuture<FileListPageAsync> list(FileListParams params)
```
    Returns a list of files.
  - list
```
 abstract CompletableFuture<FileListPageAsync> list()
```
    Returns a list of files.
  - list
```
 CompletableFuture<FileListPageAsync> list(RequestOptions requestOptions)
```
    Returns a list of files.
  - delete
```
 abstract CompletableFuture<FileDeleted> delete(FileDeleteParams params, RequestOptions requestOptions)
```
    Delete a file.
  - delete
```
 abstract CompletableFuture<FileDeleted> delete(FileDeleteParams params)
```
    Delete a file.
  - content
```
 abstract CompletableFuture<HttpResponse> content(FileContentParams params, RequestOptions requestOptions)
```
    Returns the contents of the specified file.
  - content
```
 abstract CompletableFuture<HttpResponse> content(FileContentParams params)
```
    Returns the contents of the specified file.

Interface FileServiceAsync

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

withRawResponse

create

create

retrieve

retrieve

list

list

list

list

delete

delete

content

content