hyperforge-historical 1.0.0.post19__tar.gz

hyperforge_historical-1.0.0.post19/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: hyperforge_historical
+Version: 1.0.0.post19
+Summary: External Hyperforge agent
+Author-email: Nuclia <nucliadb@nuclia.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://progress.com
+Project-URL: Repository, https://github.com/nuclia/forge
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: hyperforge
+
+# Historical Hyperforge agents

hyperforge_historical-1.0.0.post19/README.md

@@ -0,0 +1 @@
+# Historical Hyperforge agents

hyperforge_historical-1.0.0.post19/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hyperforge_historical"
+version = "1.0.0.post19"
+license = "Apache-2.0"
+description = "External Hyperforge agent"
+authors = [{ name = "Nuclia", email = "nucliadb@nuclia.com" }]
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.10, <4"
+dependencies = ["hyperforge"]
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-benchmark",
+    "pytest-docker-fixtures>=1.4.2",
+    "pytest-lazy-fixtures",
+    "pytest-recording",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-mock",
+]
+
+[project.urls]
+Homepage = "https://progress.com"
+Repository = "https://github.com/nuclia/forge"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

hyperforge_historical-1.0.0.post19/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hyperforge_historical-1.0.0.post19/src/hyperforge_historical/agent.py

@@ -0,0 +1,47 @@
+from time import time
+
+from hyperforge.agent import Agent
+from hyperforge.configure import agent
+from hyperforge.manager import Manager
+from hyperforge.memory import QuestionMemory
+from hyperforge.trace import trace_agent
+
+from hyperforge_historical.config import HistoricalAgentConfig
+
+
+@agent(
+    id="historical",
+    agent_type="preprocess",
+    title="Historical Context",
+    description="Agent that provides historical context for a given question.",
+    config_schema=HistoricalAgentConfig,
+)
+class HistoricalAgent(Agent[HistoricalAgentConfig]):
+    @trace_agent
+    async def __call__(
+        self,
+        memory: QuestionMemory,
+        manager: Manager,
+    ):
+        t0 = time()
+        if memory.original_question is not None:
+            result = await memory.search_in_questions(
+                memory.original_question, self.config.all
+            )
+            if result.total > 0:
+                # Summarize the fins results
+
+                # Check if its answers
+
+                answer = ""
+                await memory.add_answer(
+                    answer=answer,
+                    module="historical",
+                    agent_path=f"/preprocess/{self.agent_id}",
+                )
+        await memory.add_step(
+            step_module="historical",
+            step_title=self.step_title("Historical context"),
+            step_agent_path=f"/preprocess/{self.agent_id}",
+            timeit=time() - t0,
+        )

hyperforge_historical-1.0.0.post19/src/hyperforge_historical/config.py

@@ -0,0 +1,10 @@
+from typing import Literal
+
+from hyperforge.agent import AgentConfig
+from pydantic.config import ConfigDict
+
+
+class HistoricalAgentConfig(AgentConfig):
+    model_config = ConfigDict(title="History")
+    all: bool
+    module: Literal["historical"] = "historical"

hyperforge_historical-1.0.0.post19/src/hyperforge_historical.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: hyperforge_historical
+Version: 1.0.0.post19
+Summary: External Hyperforge agent
+Author-email: Nuclia <nucliadb@nuclia.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://progress.com
+Project-URL: Repository, https://github.com/nuclia/forge
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: hyperforge
+
+# Historical Hyperforge agents

hyperforge_historical-1.0.0.post19/src/hyperforge_historical.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/hyperforge_historical/__init__.py
+src/hyperforge_historical/agent.py
+src/hyperforge_historical/config.py
+src/hyperforge_historical.egg-info/PKG-INFO
+src/hyperforge_historical.egg-info/SOURCES.txt
+src/hyperforge_historical.egg-info/dependency_links.txt
+src/hyperforge_historical.egg-info/requires.txt
+src/hyperforge_historical.egg-info/top_level.txt
+tests/test_historical.py

hyperforge_historical-1.0.0.post19/src/hyperforge_historical.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hyperforge_historical-1.0.0.post19/src/hyperforge_historical.egg-info/requires.txt

@@ -0,0 +1 @@
+hyperforge

hyperforge_historical-1.0.0.post19/src/hyperforge_historical.egg-info/top_level.txt

@@ -0,0 +1 @@
+hyperforge_historical

hyperforge_historical-1.0.0.post19/tests/test_historical.py

@@ -0,0 +1,119 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from nucliadb_models.search import KnowledgeboxFindResults
+from hyperforge.manager import Manager
+from hyperforge.memory.memory import EphemeralSessionMemory
+from hyperforge.models import MemoryConfig, Rules
+from hyperforge_historical.agent import HistoricalAgent
+from hyperforge_historical.config import HistoricalAgentConfig
+
+def make_agent(all_sessions: bool = False) -> HistoricalAgent:
+    config = HistoricalAgentConfig(id="test-historical", all=all_sessions)
+    return HistoricalAgent(config=config)
+
+
+def make_memory(question: str = "What is the capital of France?"):
+    session = EphemeralSessionMemory.from_config(
+        config=MemoryConfig(), agent_id="test", workflow_id="test", rules=Rules()
+    )
+    session.init("test-session")
+    return session.start_question(question)
+
+
+# --- Config tests ---
+
+def test_config_module_literal():
+    config = HistoricalAgentConfig(all=True)
+    assert config.module == "historical"
+
+
+def test_step_title():
+    agent = make_agent()
+    assert agent.step_title("Historical context") == "History: Historical context"
+
+
+# --- Behaviour tests ---
+
+async def test_no_history_hit_adds_step_but_no_answer():
+    """When search returns no results, only a step is added, no answer."""
+    agent = make_agent()
+    memory = make_memory()
+
+    # EphemeralSessionMemory already returns total=0 by default
+    await agent(memory=memory, manager=None)
+
+    assert len(memory.steps) == 1
+    assert memory.steps[0].module == "historical"
+    assert len(memory.answers) == 0
+
+
+async def test_history_hit_adds_empty_answer_and_step():
+    """When search finds results, an empty answer and a step are both recorded."""
+    agent = make_agent()
+    memory = make_memory()
+
+    with patch.object(
+        memory,
+        "search_in_questions",
+        new=AsyncMock(return_value=KnowledgeboxFindResults(total=2, resources={})),
+    ):
+        await agent(memory=memory, manager=None)
+
+    assert len(memory.steps) == 1
+    assert memory.steps[0].module == "historical"
+    assert len(memory.answers) == 1
+    # answers are stored as (text, metadata) tuples
+    assert memory.answers[0][0] == ""
+
+
+async def test_all_false_passed_to_search():
+    """config.all=False is forwarded to search_in_questions."""
+    agent = make_agent(all_sessions=False)
+    memory = make_memory()
+
+    mock_search = AsyncMock(return_value=KnowledgeboxFindResults(total=0, resources={}))
+    with patch.object(memory, "search_in_questions", new=mock_search):
+        await agent(memory=memory, manager=None)
+
+    mock_search.assert_awaited_once_with(memory.original_question, False)
+
+
+async def test_all_true_passed_to_search():
+    """config.all=True is forwarded to search_in_questions."""
+    agent = make_agent(all_sessions=True)
+    memory = make_memory()
+
+    mock_search = AsyncMock(return_value=KnowledgeboxFindResults(total=0, resources={}))
+    with patch.object(memory, "search_in_questions", new=mock_search):
+        await agent(memory=memory, manager=None)
+
+    mock_search.assert_awaited_once_with(memory.original_question, True)
+
+
+async def test_step_has_correct_fields():
+    """Recorded step has the right module, title and agent_path."""
+    agent = make_agent()
+    memory = make_memory()
+
+    await agent(memory=memory, manager=None)
+
+    step = memory.steps[0]
+    assert step.module == "historical"
+    assert step.title == "History: Historical context"
+    assert step.agent_path == f"/preprocess/{agent.agent_id}"
+
+
+async def test_none_question_skips_search_and_adds_step():
+    """When original_question is None the search is skipped but a step is still added."""
+    agent = make_agent()
+    memory = make_memory()
+    memory.original_question = None
+
+    mock_search = AsyncMock(return_value=KnowledgeboxFindResults(total=0, resources={}))
+    with patch.object(memory, "search_in_questions", new=mock_search):
+        await agent(memory=memory, manager=None)
+
+    mock_search.assert_not_awaited()
+    assert len(memory.steps) == 1
+    assert len(memory.answers) == 0