rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-04 10:52:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: support distance range in queries (#1999)

Browse Source 
this also updates the docs

---------

Signed-off-by: BubbleCal <bubble-cal@outlook.com>
This commit is contained in:
BubbleCal
2025-01-08 11:03:27 +08:00
committed by GitHub
parent 0e496ed3b5
commit 3c0a64be8f
8 changed files with 337 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
python/python/lancedb/query.py
View File

@@ -647,7 +647,7 @@ class LanceVectorQueryBuilder(LanceQueryBuilder):
Parameters
----------
lower: Optional[float]
lower_bound: Optional[float]
The lower bound of the distance range.
upper_bound: Optional[float]
The upper bound of the distance range.
@@ -1309,7 +1309,7 @@ class LanceHybridQueryBuilder(LanceQueryBuilder):
Parameters
----------
lower: Optional[float]
lower_bound: Optional[float]
The lower bound of the distance range.
upper_bound: Optional[float]
The upper bound of the distance range.
@@ -1940,7 +1940,7 @@ class AsyncVectorQuery(AsyncQueryBase):
Parameters
----------
lower: Optional[float]
lower_bound: Optional[float]
The lower bound of the distance range.
upper_bound: Optional[float]
The upper bound of the distance range.

62
python/python/tests/docs/test_distance_range.py Normal file
View File

@@ -0,0 +1,62 @@
import shutil
import pytest
# --8<-- [start:imports]
import lancedb
import numpy as np
# --8<-- [end:imports]
shutil.rmtree("data/distance_range_demo", ignore_errors=True)
def test_binary_vector():
# --8<-- [start:sync_distance_range]
db = lancedb.connect("data/distance_range_demo")
data = [
{
"id": i,
"vector": np.random.random(256),
}
for i in range(1024)
]
tbl = db.create_table("my_table", data=data)
query = np.random.random(256)
# Search for the vectors within the range of [0.1, 0.5)
tbl.search(query).distance_range(0.1, 0.5).to_arrow()
# Search for the vectors with the distance less than 0.5
tbl.search(query).distance_range(upper_bound=0.5).to_arrow()
# Search for the vectors with the distance greater or equal to 0.1
tbl.search(query).distance_range(lower_bound=0.1).to_arrow()
# --8<-- [end:sync_distance_range]
db.drop_table("my_table")
@pytest.mark.asyncio
async def test_binary_vector_async():
# --8<-- [start:async_distance_range]
db = await lancedb.connect_async("data/distance_range_demo")
data = [
{
"id": i,
"vector": np.random.random(256),
}
for i in range(1024)
]
tbl = await db.create_table("my_table", data=data)
query = np.random.random(256)
# Search for the vectors within the range of [0.1, 0.5)
await tbl.query().nearest_to(query).distance_range(0.1, 0.5).to_arrow()
# Search for the vectors with the distance less than 0.5
await tbl.query().nearest_to(query).distance_range(upper_bound=0.5).to_arrow()
# Search for the vectors with the distance greater or equal to 0.1
await tbl.query().nearest_to(query).distance_range(lower_bound=0.1).to_arrow()
# --8<-- [end:async_distance_range]
await db.drop_table("my_table")