⋙ Create Vector Store File Batch

Create a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store for which to create a File Batch.

file_ids array

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

files array

An array of per-file objects that each include file_id plus optional attributes or chunking_strategy.

attributes object

Global attributes to apply to all files when using file_ids.

chunking_strategy object

Global chunking strategy to apply to all files when using file_ids.

⋙ Create and Poll Vector Store File Batch

SDK helper that creates a vector store file batch, then polls until processing completes.

msg.payload Properties

vector_store_id string

The ID of the vector store for which to create a File Batch.

file_ids array

A list of File IDs to attach to the batch.

files array

An array of per-file objects that each include file_id plus optional attributes or chunking_strategy.

attributes object

Global attributes to apply to all files when using file_ids.

chunking_strategy object

Global chunking strategy to apply to all files when using file_ids.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

⋙ Retrieve Vector Store File Batch

Retrieves a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the file batch belongs to.

batch_id string

The ID of the file batch being retrieved.

⋙ Poll Vector Store File Batch

SDK helper that waits for a vector store file batch to finish processing.

msg.payload Properties

vector_store_id string

The ID of the vector store that the file batch belongs to.

batch_id string

The ID of the file batch to poll.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

⋙ Cancel Vector Store File Batch

Cancel a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the file batch belongs to.

batch_id string

The ID of the file batch to cancel.

⋙ List Vector Store Batch Files

Returns a list of vector store files in a batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the files belong to.

batch_id string

The ID of the file batch that the files belong to.

limit integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order string

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after string

A cursor for use in pagination. after is an object ID that defines your place in the list.

before string

A cursor for use in pagination. before is an object ID that defines your place in the list.

filter string

Filter by file status. One of in_progress, completed, failed, cancelled.

⋙ Upload and Poll Vector Store File Batch

SDK helper that uploads local files concurrently, creates a vector store file batch, and polls until processing completes.

msg.payload Properties

vector_store_id string

The id of the vector store to which the files are being uploaded.

files array

A list of absolute file paths to the files that are being uploaded.

file_ids array

A list of previously uploaded file ids.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

maxConcurrency integer

Optional maximum number of concurrent file uploads for the helper.