Skip to content

fix: incorrect typing on return type #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephantul merged 1 commit into from
Jul 15, 2025
Merged

fix: incorrect typing on return type #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions vicinity/vicinity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from vicinity import Metric
from vicinity.backends import AbstractBackend, BasicBackend, BasicVectorStore, get_backend_class
from vicinity.datatypes import Backend, PathLike, QueryResult
from vicinity.datatypes import Backend, PathLike, SimilarityResult

logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -115,7 +115,7 @@ def query(
self,
vectors: npt.NDArray,
k: int = 10,
) -> list[QueryResult]:
) -> SimilarityResult:
"""
Find the nearest neighbors to some arbitrary vector.

Expand All @@ -142,7 +142,7 @@ def query_threshold(
vectors: npt.NDArray,
threshold: float = 0.5,
max_k: int = 100,
) -> list[QueryResult]:
) -> SimilarityResult:
"""
Find the nearest neighbors to some arbitrary vector with some threshold. Note: the output is not sorted.

Expand Down