Create a vector store file batch.
POST /vector_stores/{vector_store_id}/file_batches
Authorizations
Parameters
Path Parameters
The ID of the vector store for which to create a File Batch.
Request Body required
object
A list of File IDs that the vector store should use. Useful for tools like file_search
that can access files.
The default strategy. This strategy currently uses a max_chunk_size_tokens
of 800
and chunk_overlap_tokens
of 400
.
object
Always auto
.
object
Always static
.
object
The maximum number of tokens in each chunk. The default value is 800
. The minimum value is 100
and the maximum value is 4096
.
The number of tokens that overlap between chunks. The default value is 400
.
Note that the overlap must not exceed half of max_chunk_size_tokens
.
Responses
200
OK
A batch of files attached to a vector store.
object
The identifier, which can be referenced in API endpoints.
The object type, which is always vector_store.file_batch
.
The Unix timestamp (in seconds) for when the vector store files batch was created.
The ID of the vector store that the File is attached to.
The status of the vector store files batch, which can be either in_progress
, completed
, cancelled
or failed
.
object
The number of files that are currently being processed.
The number of files that have been processed.
The number of files that have failed to process.
The number of files that where cancelled.
The total number of files.