Interface FileService
-
- All Implemented Interfaces:
public interface FileService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
FileService.WithRawResponse
A view of FileService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract FileService.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. FileObject
create(FileCreateParams params)
Upload a file that can be used across various endpoints. abstract FileObject
create(FileCreateParams params, RequestOptions requestOptions)
FileObject
retrieve(FileRetrieveParams params)
Returns information about a specific file. abstract FileObject
retrieve(FileRetrieveParams params, RequestOptions requestOptions)
FileListPage
list()
Returns a list of files. abstract FileListPage
list(FileListParams params, RequestOptions requestOptions)
FileListPage
list(FileListParams params)
FileListPage
list(RequestOptions requestOptions)
FileDeleted
delete(FileDeleteParams params)
Delete a file. abstract FileDeleted
delete(FileDeleteParams params, RequestOptions requestOptions)
HttpResponse
content(FileContentParams params)
Returns the contents of the specified file. abstract HttpResponse
content(FileContentParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract FileService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
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.
-
create
abstract FileObject create(FileCreateParams params, RequestOptions requestOptions)
-
retrieve
FileObject retrieve(FileRetrieveParams params)
Returns information about a specific file.
-
retrieve
abstract FileObject retrieve(FileRetrieveParams params, RequestOptions requestOptions)
-
list
FileListPage list()
Returns a list of files.
-
list
abstract FileListPage list(FileListParams params, RequestOptions requestOptions)
-
list
FileListPage list(FileListParams params)
-
list
FileListPage list(RequestOptions requestOptions)
-
delete
FileDeleted delete(FileDeleteParams params)
Delete a file.
-
delete
abstract FileDeleted delete(FileDeleteParams params, RequestOptions requestOptions)
-
content
@MustBeClosed() HttpResponse content(FileContentParams params)
Returns the contents of the specified file.
-
content
@MustBeClosed() abstract HttpResponse content(FileContentParams params, RequestOptions requestOptions)
-
-
-
-