⋙ Create Vector Store

Create a vector store.

msg.payload Properties

file_ids array

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

name string

The name of the vector store.

expires_after object

The expiration policy for a vector store.

chunking_strategy object

The chunking strategy used to chunk the file(s).

metadata object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

⋙ List Vector Stores

Returns a list of vector stores.

msg.payload Properties

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.

⋙ Retrieve Vector Store

Retrieves a vector store.

msg.payload Properties

vector_store_id string

The ID of the vector store to retrieve.

⋙ Search Vector Store

Search a vector store for relevant chunks using a query and optional file-attribute filters.

msg.payload Properties

vector_store_id string

The ID of the vector store to search.

query string | array

A search query string, or an array of query strings.

filters object

File-attribute filters using the SDK's ComparisonFilter or CompoundFilter contract. Comparison filters use key, type, and value. Supported comparison operators include eq, ne, gt, gte, lt, lte, in, and nin. Comparison values may be strings, numbers, booleans, or arrays of strings or numbers.

max_num_results integer

The maximum number of search results to return. Must be between 1 and 50.

ranking_options object

Ranking options for the search request.

rewrite_query boolean

Whether to let the API rewrite the natural-language query before searching.

⋙ Modify Vector Store

Modifies a vector store.

msg.payload Properties

vector_store_id string

The ID of the vector store to modify.

name string

The name of the vector store.

expires_after object

The expiration policy for a vector store.

metadata object

Set of 16 key-value pairs that can be attached to an object.

⋙ Delete Vector Store

Delete a vector store.

msg.payload Properties

vector_store_id string

The ID of the vector store to delete.