Documentation Index
Fetch the complete documentation index at: https://hexxladb.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Configuration
Embeddings are configured via options when opening the database:Distance metrics
| Metric | Description | Range |
|---|---|---|
DistanceCosine | Cosine similarity (default) | [-1, 1] |
DistanceDotProduct | Raw dot product (assumes normalized vectors) | - |
DistanceL2 | Euclidean distance (inverted for ranking) | - |
PutEmbedding
Store a vector embedding for a cell coordinate.EmbeddingDimension. HNSW graph is maintained automatically.
GetEmbedding
Retrieve the vector embedding for a cell coordinate.DeleteEmbedding
Remove an embedding. Idempotent.SearchByEmbedding
HNSW-accelerated nearest-neighbor search with flat-scan fallback. Returns top-K results sorted by score.MaxResults— Maximum results to return (default 10)MinScore— Minimum similarity threshold
Coord— Packed coordinate of the matching cellScore— Similarity score
ReindexEmbeddings
Bulk recompute all embeddings via a user-supplied function. Intended for model changes.Integration with query engine
CellQuery.Embedding and CellSearchConfig.Embedding trigger ANN-accelerated seed selection in QueryCells / SearchCells. Embedding similarity is added to the composite relevance score; all other predicates (tags, temporal, spatial) apply as post-filters.
Errors
| Error | Description |
|---|---|
ErrEmbeddingsDisabled | Embedding operation on a database with dimension 0 |
ErrEmbeddingDimension | Vector length does not match EmbeddingDimension |
Cascade behavior
DeleteCell cascades to remove the cell’s embedding and HNSW node automatically.