Added example of getting items within a certain distance with SQLAlchemy - closes pgvector#11

ankane · ankane · commit 57226caaf3e0 · 2023-05-11T09:26:36.000-07:00
diff --git a/README.md b/README.md
@@ -129,6 +129,12 @@ session.scalars(select(Item).order_by(Item.embedding.l2_distance([3, 1, 2])).lim
 
 Also supports `max_inner_product` and `cosine_distance`
 
+Get items within a certain distance
+
+```python
+session.scalars(select(Item).filter(Item.embedding.l2_distance([3, 1, 2]) < 5))
+```
+
 Add an approximate index
 
 ```python
diff --git a/tests/test_sqlalchemy.py b/tests/test_sqlalchemy.py
@@ -105,6 +105,12 @@ def test_cosine_distance(self):
             items = session.query(Item).order_by(Item.embedding.cosine_distance([1, 1, 1])).all()
             assert [v.id for v in items] == [1, 2, 3]
 
+    def test_filter(self):
+        create_items()
+        with Session(engine) as session:
+            items = session.query(Item).filter(Item.embedding.l2_distance([1, 1, 1]) < 1).all()
+            assert [v.id for v in items] == [1]
+
     def test_select(self):
         with Session(engine) as session:
             session.add(Item(embedding=[2, 3, 3]))
