Skip to content

Personal AI, On Personal Devices

Python

feat: upgrade knowledge_search to support TwoStageRetriever

krypticmouse0917ebab25a9
diff --git a/src/openjarvis/tools/knowledge_search.py b/src/openjarvis/tools/knowledge_search.py
index 803d8b05..f35b554b 100644
--- a/src/openjarvis/tools/knowledge_search.py
+++ b/src/openjarvis/tools/knowledge_search.py
@@ -2,29 +2,40 @@
Wraps ``KnowledgeStore`` so agents can search ingested documents by text query
and optional provenance filters (source, doc_type, author, date range).
+Optionally delegates to a ``TwoStageRetriever`` for BM25 + reranking.
"""
from __future__ import annotations
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
from openjarvis.connectors.store import KnowledgeStore
from openjarvis.core.registry import ToolRegistry
from openjarvis.core.types import ToolResult
from openjarvis.tools._stubs import BaseTool, ToolSpec
+if TYPE_CHECKING:
+ from openjarvis.connectors.retriever import TwoStageRetriever
+
@ToolRegistry.register("knowledge_search")
class KnowledgeSearchTool(BaseTool):
"""Search the knowledge store using filtered BM25 retrieval.
Results include source attribution so agents can cite provenance.
+ When a ``TwoStageRetriever`` is supplied it is used in place of the
+ store's direct ``retrieve`` method, enabling optional semantic reranking.
"""
tool_id = "knowledge_search"
- def __init__(self, store: Optional[KnowledgeStore] = None) -> None:
+ def __init__(
+ self,
+ store: Optional[KnowledgeStore] = None,
+ retriever: Optional["TwoStageRetriever"] = None,
+ ) -> None:
self._store = store
+ self._retriever = retriever
@property
def spec(self) -> ToolSpec:
@@ -83,7 +94,7 @@ class KnowledgeSearchTool(BaseTool):
)
def execute(self, **params: Any) -> ToolResult:
- if self._store is None:
+ if self._store is None and self._retriever is None:
return ToolResult(
tool_name="knowledge_search",
content="No knowledge store configured.",
@@ -105,15 +116,26 @@ class KnowledgeSearchTool(BaseTool):
since: Optional[str] = params.get("since")
until: Optional[str] = params.get("until")
- results = self._store.retrieve(
- query,
- top_k=top_k,
- source=source,
- doc_type=doc_type,
- author=author,
- since=since,
- until=until,
- )
+ if self._retriever is not None:
+ results = self._retriever.retrieve(
+ query,
+ top_k=top_k,
+ source=source or "",
+ doc_type=doc_type or "",
+ author=author or "",
+ since=since or "",
+ until=until or "",
+ )
+ else:
+ results = self._store.retrieve( # type: ignore[union-attr]
+ query,
+ top_k=top_k,
+ source=source,
+ doc_type=doc_type,
+ author=author,
+ since=since,
+ until=until,
+ )
if not results:
return ToolResult(
diff --git a/tests/tools/test_knowledge_search.py b/tests/tools/test_knowledge_search.py
index e6b32e50..8d41e13c 100644
--- a/tests/tools/test_knowledge_search.py
+++ b/tests/tools/test_knowledge_search.py
@@ -4,6 +4,7 @@ from __future__ import annotations
import importlib
import sys
+from pathlib import Path
import pytest
@@ -137,3 +138,16 @@ class TestKnowledgeSearchTool:
importlib.import_module(mod_name)
assert ToolRegistry.contains("knowledge_search")
+
+
+def test_tool_uses_two_stage_retriever(tmp_path: Path) -> None:
+ """KnowledgeSearchTool delegates to TwoStageRetriever when supplied."""
+ from openjarvis.connectors.retriever import TwoStageRetriever
+
+ store = KnowledgeStore(db_path=str(tmp_path / "ts_test.db"))
+ store.store(content="Deep learning research paper", source="gdrive", doc_type="document")
+ retriever = TwoStageRetriever(store=store)
+ tool = KnowledgeSearchTool(store=store, retriever=retriever)
+ result = tool.execute(query="deep learning")
+ assert result.success
+ assert result.metadata["num_results"] > 0