⋙ Create Vector Store File

Create a vector store file by attaching a File to a vector store.

msg.payload Properties

vector_store_id string

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

file_id string

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

attributes object

Optional file attributes stored on the vector store file.

chunking_strategy object

Optional chunking strategy for the attached file.

⋙ Create and Poll Vector Store File

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

msg.payload Properties

vector_store_id string

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

file_id string

A File ID that the vector store should use.

attributes object

Optional file attributes stored on the vector store file.

chunking_strategy object

Optional chunking strategy for the attached file.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

⋙ Upload Vector Store File

SDK helper that uploads a local file and then attaches it to a vector store.

msg.payload Properties

vector_store_id string

The ID of the vector store that will receive the uploaded file.

file string

Absolute path to the local file to upload.

⋙ Upload and Poll Vector Store File

SDK helper that uploads a local file, attaches it to the vector store, and polls until processing completes.

msg.payload Properties

vector_store_id string

The ID of the vector store that will receive the uploaded file.

file string

Absolute path to the local file to upload.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

⋙ Poll Vector Store File

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

msg.payload Properties

vector_store_id string

The ID of the vector store that owns the file.

file_id string

The ID of the file to poll.

pollIntervalMs integer

Optional polling interval in milliseconds for the helper.

⋙ List Vector Store Files

Returns a list of vector store files.

msg.payload Properties

vector_store_id string

The ID of the vector store 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.

before string

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

after string

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

filter string

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

⋙ Retrieve Vector Store File

Retrieves a vector store file.

msg.payload Properties

vector_store_id string

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

file_id string

The ID of the file being retrieved.

⋙ Modify Vector Store File

Update attributes on a vector store file.

msg.payload Properties

vector_store_id string

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

file_id string

The ID of the file to update.

attributes object

Attributes to store on the vector store file. Set to null to clear them.

⋙ Get Vector Store File Content

Retrieve the parsed contents of a vector store file.

msg.payload Properties

vector_store_id string

The ID of the vector store that owns the file.

file_id string

The ID of the file whose parsed content should be returned.

⋙ Delete Vector Store File

Remove a file from a vector store.

msg.payload Properties

vector_store_id string

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

file_id string

The ID of the file to remove from the vector store.