Skip to content

feat: add min_similarity config to filter query results by relevance #433

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
peterj merged 3 commits into from
May 27, 2025
Merged

feat: add min_similarity config to filter query results by relevance #433

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8feb5c
feat: add min_similarity config to filter query results by relevance
Abhinavcode13 May 24, 2025
a519ab9
Merge branch 'main' into feature/add-min-similarity-filter
peterj May 26, 2025
28496cf
Merge branch 'main' into feature/add-min-similarity-filter
EItanya May 27, 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
8 changes: 7 additions & 1 deletion python/src/kagent/tools/docs/query_documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ class Config(BaseModel):
default=None,
description="API key for OpenAI services. If empty, the environment variable 'OPENAI_API_KEY' will be used.",
)
min_similarity: Optional[float] = Field(
default=0.7,
description="Minimum similarity threshold (0-1) for filtering search results. Results with similarity below this threshold will be excluded.",
)


class QueryResult:
Expand Down Expand Up @@ -228,7 +232,9 @@ def query_documentation(
filter["version"] = version

results = self.query_collection(query_embedding, filter, limit, db_path)
return [{"distance": qr.distance, "content": qr.content} for qr in results]
# Filter results based on min_similarity threshold
filtered_results = [qr for qr in results if qr.distance <= (1 - self.config.min_similarity)]
return [{"distance": qr.distance, "content": qr.content} for qr in filtered_results]

except Exception as e:
logging.error("An error occurred: %s", e)
Expand Down
Loading