Expand description
Distance operators and similarity metrics for pgvector.
pgvector supports multiple distance functions, each with a corresponding PostgreSQL operator. This module provides type-safe abstractions for these.
§Operators
| Metric | Operator | Index Ops Class |
|---|---|---|
| L2 (Euclidean) | <-> | vector_l2_ops |
| Inner Product | <#> | vector_ip_ops |
| Cosine | <=> | vector_cosine_ops |
| L1 (Manhattan) | <+> | vector_l1_ops |
| Hamming | <~> | bit_hamming_ops |
| Jaccard | <%> | bit_jaccard_ops |
Structs§
- Search
Params - Configuration for setting pgvector search parameters.
Enums§
- Binary
Distance Metric - Binary vector distance metric supported by pgvector.
- Distance
Metric - Vector distance metric supported by pgvector.
Functions§
- distance_
param_ sql - Generate SQL for computing distance with a parameter placeholder.
- distance_
sql - Generate SQL for computing the distance between a column and a query vector.
- nearest_
neighbor_ sql - Generate a complete nearest-neighbor search query.
- order_
by_ distance - Generate an ORDER BY clause for nearest-neighbor search.
- radius_
search_ sql - Generate SQL for a distance-filtered search (within a radius).