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.

• withOptions

   abstract FileServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• create

   CompletableFuture<FileObject> create(FileCreateParams params)

  Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit. Uploads to this endpoint are rate-limited to 2,000 files per minute per organization.

  • 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.

  • For Retrieval or file_search ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use /vector_stores/{vector_store_id}/file_batches instead of attaching them one by one.

  Please contact us if you need to increase these storage limits.

• create

   abstract CompletableFuture<FileObject> create(FileCreateParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<FileObject> retrieve(String fileId)

  Returns information about a specific file.

• retrieve

   CompletableFuture<FileObject> retrieve(String fileId, FileRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<FileObject> retrieve(String fileId, FileRetrieveParams params)

• retrieve

   abstract CompletableFuture<FileObject> retrieve(FileRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<FileObject> retrieve(FileRetrieveParams params)

• retrieve

   CompletableFuture<FileObject> retrieve(String fileId, RequestOptions requestOptions)

• list

   CompletableFuture<FileListPageAsync> list()

  Returns a list of files.

• list

   abstract CompletableFuture<FileListPageAsync> list(FileListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<FileListPageAsync> list(FileListParams params)

• list

   CompletableFuture<FileListPageAsync> list(RequestOptions requestOptions)

• delete

   CompletableFuture<FileDeleted> delete(String fileId)

  Delete a file and remove it from all vector stores.

• delete

   CompletableFuture<FileDeleted> delete(String fileId, FileDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<FileDeleted> delete(String fileId, FileDeleteParams params)

• delete

   abstract CompletableFuture<FileDeleted> delete(FileDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<FileDeleted> delete(FileDeleteParams params)

• delete

   CompletableFuture<FileDeleted> delete(String fileId, RequestOptions requestOptions)

• content

   CompletableFuture<HttpResponse> content(String fileId)

  Returns the contents of the specified file.

• content

   CompletableFuture<HttpResponse> content(String fileId, FileContentParams params, RequestOptions requestOptions)

• content

   CompletableFuture<HttpResponse> content(String fileId, FileContentParams params)

• content

   abstract CompletableFuture<HttpResponse> content(FileContentParams params, RequestOptions requestOptions)

• content

   CompletableFuture<HttpResponse> content(FileContentParams params)

• content

   CompletableFuture<HttpResponse> content(String fileId, RequestOptions requestOptions)