Create Vector Index

POST

Create a vector index for a given table.

Request

This endpoint expects an object.
table_nameenumOptional
Allowed values: vectorsdocument_entitycollection_entitycommunity_report

The table to create the index on. Default: vectors

index_methodenumOptional
Allowed values: autoivfflathnsw

The indexing method to use. Options: hnsw, ivfflat, auto. Default: hnsw

index_measureenumOptional

Distance measure for vector comparisons. Options: cosine_distance, l2_distance, max_inner_product. Default: cosine_distance

index_argumentsobjectOptional

Configuration parameters for the chosen index method. For HNSW: {m: int, ef_construction: int}. For IVFFlat: {n_lists: int}

index_namestringOptional

Optional custom name for the index. If not provided, one will be auto-generated

index_columnstringOptional

The column containing the vectors to index. Default: vec, or vec_binary when using hamming or jaccard distance.

concurrentlybooleanOptional

Whether to create the index concurrently. Default: true

Response

Successful Response

resultsobject

Errors