Skip to content
API Reference
Vector Stores

File Batches

Create vector store file batch
VectorStoreFileBatch vectorStores().fileBatches().create(FileBatchCreateParamsparams = FileBatchCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/vector_stores/{vector_store_id}/file_batches
Retrieve vector store file batch
VectorStoreFileBatch vectorStores().fileBatches().retrieve(FileBatchRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}
Cancel vector store file batch
VectorStoreFileBatch vectorStores().fileBatches().cancel(FileBatchCancelParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
List vector store files in a batch
FileBatchListFilesPage vectorStores().fileBatches().listFiles(FileBatchListFilesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
ModelsExpand Collapse
class VectorStoreFileBatch:

A batch of files attached to a vector store.

String id

The identifier, which can be referenced in API endpoints.

long createdAt

The Unix timestamp (in seconds) for when the vector store files batch was created.

FileCounts fileCounts
long cancelled

The number of files that where cancelled.

long completed

The number of files that have been processed.

long failed

The number of files that have failed to process.

long inProgress

The number of files that are currently being processed.

long total

The total number of files.

JsonValue; object_ "vector_store.files_batch"constant"vector_store.files_batch"constant

The object type, which is always vector_store.file_batch.

Status status

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Accepts one of the following:
IN_PROGRESS("in_progress")
COMPLETED("completed")
CANCELLED("cancelled")
FAILED("failed")
String vectorStoreId

The ID of the vector store that the File is attached to.