Interface FileService
-
- All Implemented Interfaces:
public interface FileService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceFileService.WithRawResponseA view of FileService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract FileService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract FileObjectcreate(FileCreateParams params, RequestOptions requestOptions)Upload a file that can be used across various endpoints. abstract FileObjectcreate(FileCreateParams params)Upload a file that can be used across various endpoints. abstract FileObjectretrieve(FileRetrieveParams params, RequestOptions requestOptions)Returns information about a specific file. abstract FileObjectretrieve(FileRetrieveParams params)Returns information about a specific file. abstract FileListPagelist(FileListParams params, RequestOptions requestOptions)Returns a list of files. abstract FileListPagelist(FileListParams params)Returns a list of files. abstract FileListPagelist()Returns a list of files. FileListPagelist(RequestOptions requestOptions)Returns a list of files. abstract FileDeleteddelete(FileDeleteParams params, RequestOptions requestOptions)Delete a file. abstract FileDeleteddelete(FileDeleteParams params)Delete a file. abstract HttpResponsecontent(FileContentParams params, RequestOptions requestOptions)Returns the contents of the specified file. abstract HttpResponsecontent(FileContentParams params)Returns the contents of the specified file. -
-
Method Detail
-
withRawResponse
abstract FileService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
abstract 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
.jsonlfiles. The input also has certain required formats for fine-tuning chat or completions models.The Batch API only supports
.jsonlfiles 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)
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
.jsonlfiles. The input also has certain required formats for fine-tuning chat or completions models.The Batch API only supports
.jsonlfiles 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 FileObject retrieve(FileRetrieveParams params, RequestOptions requestOptions)
Returns information about a specific file.
-
retrieve
abstract FileObject retrieve(FileRetrieveParams params)
Returns information about a specific file.
-
list
abstract FileListPage list(FileListParams params, RequestOptions requestOptions)
Returns a list of files.
-
list
abstract FileListPage list(FileListParams params)
Returns a list of files.
-
list
abstract FileListPage list()
Returns a list of files.
-
list
FileListPage list(RequestOptions requestOptions)
Returns a list of files.
-
delete
abstract FileDeleted delete(FileDeleteParams params, RequestOptions requestOptions)
Delete a file.
-
delete
abstract FileDeleted delete(FileDeleteParams params)
Delete a file.
-
content
abstract HttpResponse content(FileContentParams params, RequestOptions requestOptions)
Returns the contents of the specified file.
-
content
abstract HttpResponse content(FileContentParams params)
Returns the contents of the specified file.
-
-
-
-