Option 1: Self-Hosted Indexing
Manual, Sync or Async: If using LanceDB Open Source, you will have to build indexes manually, as well as reindex and tune indexing parameters. The Python SDK lets you do this synchronously and asynchronously.Option 2: Automated Indexing
Automatic and Async: Indexing is automatic in LanceDB Cloud/Enterprise. As soon as data is updated, our system automates index optimization. This is done asynchronously. Here is what happens in the background - when a table contains a single vector column namedvector, LanceDB automatically:
- Infers the vector column from the schema
- Creates an optimized
IVF_PQindex without manual configuration - The default distance is
l2or euclidean
You can create a new index with different parameters using
create_index - this replaces any existing indexAlthough the create_index API returns immediately, the building of the vector index is asynchronous. To wait until all data is fully indexed, you can specify the wait_timeout parameter.Choose the Right Index
Use this table as a quick starting point:| If your top priority is… | Use this index | Why | Typical compressed size vs. raw vectors |
|---|---|---|---|
| Best recall/latency trade-off | IVF_HNSW_SQ | Combines IVF partitioning with HNSW graph search for strong quality at low latency. | Typically a little larger than 1/4 of raw size |
| Maximum compression | IVF_RQ | RaBitQ-style quantization with very strong compression. | Around 1/32 of raw size |
Higher accuracy at small dimensions (dimension <= 256) | IVF_PQ | On small-dimensional vectors, IVF_PQ often provides higher accuracy with similar performance compared to IVF_RQ. | Usually 1/64 to 1/16 of raw size (depends on num_sub_vectors) |
Indexing Tuning by Index Type
Start with these values, then tune for your workload:IVF_HNSW_SQnum_partitions: start atnum_rows / 1,048,576(rounded to an integer)- Lower
num_partitionscan reduce search latency, but index build may become slower because partitions are larger. ef_construction: start at150; increase for better recall, decrease for faster indexing.
IVF_RQnum_partitions: start atnum_rows / 4096(rounded to an integer). This is a strong default for most datasets.
IVF_PQnum_partitions: start atnum_rows / 4096(rounded to an integer).num_sub_vectors: start atdimension / 8. Increase for better recall, decrease for faster search and smaller indexes.- For small dimensions (
dimension <= 256),IVF_PQis often preferred overIVF_RQfor better accuracy at similar query performance.
Example: Construct an IVF Index
In this example, we will create an index for a table containing 1536-dimensional vectors. The index will use IVF_PQ with L2 distance, which is well-suited for high-dimensional vector search. Make sure you have enough data in your table (at least a few thousand rows) for effective index training.Index Configuration
Sometimes you need to configure the index beyond default parameters:- Index Types:
IVF_HNSW_SQ: best recall/latency trade-offIVF_RQ: best compression for large, high-dimensional datasetsIVF_PQ: often higher accuracy thanIVF_RQfor small dimensions (<= 256) at similar query performance
metrics: default isl2, other available arecosineordot- When using
cosinesimilarity, distances range from 0 (identical vectors) to 2 (maximally dissimilar)
- When using
num_partitions: use index-specific starting points from the section above:IVF_HNSW_SQ:num_rows / 1,048,576IVF_RQandIVF_PQ:num_rows / 4096
num_sub_vectors: applies toIVF_PQ; start withdimension / 8. Larger values often improve recall but can slow search.
1. Setup
Connect to LanceDB and open the table you want to index.2. Construct an IVF Index
Create anIVF_PQ index with cosine similarity. Specify vector_column_name if you use multiple vector columns or non-default names. You can switch index_type to IVF_RQ or IVF_HNSW_SQ depending on your recall/latency/compression target.
3. Query the IVF Index
Search using a random 1,536-dimensional embedding.Search Configuration
The previous query uses:limit: number of results to returnnprobes: number of IVF partitions to scan. LanceDB auto-tunes this by default.ef: primarily relevant forIVF_HNSW_SQ; start around1.5 * k(wherek=limit) and increase up to10 * kfor higher recall.nprobesby index type:IVF_HNSW_SQ: usually keep auto-tunednprobes, then tuneeffirst. For filtered search (where(...)), expect higher latency variance.IVF_RQ: keep auto-tunednprobes; increase only when recall is insufficient.IVF_PQ: keep auto-tunednprobes; increase when recall is insufficient. Often preferred overIVF_RQwhendimension <= 256.
refine_factor: reads additional candidates and reranks in memory.to_pandas(): converts the results to a pandas DataFrame
Example: Construct an HNSW Index
Index Configuration
There are three key parameters to set when constructing an HNSW index:metric: The default isl2euclidean distance metric. Other available aredotandcosine.m: The number of neighbors to select for each vector in the HNSW graph.ef_construction: The number of candidates to evaluate during the construction of the HNSW graph.
1. Construct an HNSW Index
2. Query the HNSW Index
Example: Construct a Binary Vector Index
Binary vectors are useful for hash-based retrieval, fingerprinting, or any scenario where data can be represented as bits.Index Configuration
- Store binary vectors as fixed-size binary data (uint8 arrays, with 8 bits per byte). For storage, pack binary vectors into bytes to save space.
- Index Type:
IVF_FLATis used for indexing binary vectors metric: thehammingdistance is used for similarity search- The dimension of binary vectors must be a multiple of 8. For example, a 128-dimensional vector is stored as a uint8 array of size 16.
1. Create Table and Schema
2. Generate and Add Data
3. Construct the Binary Index
4. Vector Search
Check Index Status
Vector index creation is fast - typically a few minutes for 1 million vectors with 1536 dimensions. You can check index status in two ways:Option 1: Check the UI
Navigate to your table page - the “Index” column shows index status. It remains blank if no index exists or if creation is in progress.Option 2: Use the API
Uselist_indices() and index_stats() to check index status. The index name is formed by appending “_idx” to the column name. Note that list_indices() only returns information after the index is fully built.
To wait until all data is fully indexed, you can specify the wait_timeout parameter on create_index() or call wait_for_index() on the table.