Skip to content

Add the approximate threshold parameter to search #288

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
merged 2 commits into from
Jun 4, 2025
Merged

Add the approximate threshold parameter to search #288

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bc70f0
Add the approximate threshold parameter to search
farshidz May 23, 2025
8553689
Move parameter to the end and add docstring
farshidz Jun 3, 2025
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
7 changes: 6 additions & 1 deletion src/marqo/index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ def search(self, q: Optional[Union[str, dict]] = None, searchable_attributes: Op
text_query_prefix: Optional[str] = None, hybrid_parameters: Optional[dict] = None,
rerank_depth: Optional[int] = None, facets: Optional[dict] = None,
track_total_hits: Optional[bool] = None,
approximate_threshold: Optional[float] = None,
) -> Dict[str, Any]:
"""Search the index.

Expand Down Expand Up @@ -264,6 +265,10 @@ def search(self, q: Optional[Union[str, dict]] = None, searchable_attributes: Op
rerank_depth: The number of documents to rerank with score modifiers if used with hybrid search.
Number of hits to get from each shard if used with tensor search.
facets: a dictionary of facets to be used for facet search.
track_total_hits: return total number of lexical matches
approximate_threshold: hit ratio threshold for deciding if a nearest neighbor search should be performed as
an exact search, rather than an approximate search

Returns:
Dictionary with hits and other metadata
"""
Expand All @@ -289,6 +294,7 @@ def search(self, q: Optional[Union[str, dict]] = None, searchable_attributes: Op
"modelAuth": model_auth,
"efSearch": ef_search,
"approximate": approximate,
"approximateThreshold": approximate_threshold,
"searchableAttributes": searchable_attributes,
"limit": limit,
"offset": offset,
Expand Down Expand Up @@ -455,7 +461,6 @@ def embed(self, content: Union[Union[str, Dict[str, float]], List[Union[str, Dic
body["imageDownloadHeaders"] = image_download_headers
if model_auth is not None:
body["modelAuth"] = model_auth


res = self.http.post(
path=path_with_query_str,
Expand Down
Loading