hyperforge-generate 1.0.0.post24__tar.gz

hyperforge_generate-1.0.0.post24/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: hyperforge_generate
+Version: 1.0.0.post24
+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
+
+# Generate Hyperforge agents

hyperforge_generate-1.0.0.post24/README.md

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

hyperforge_generate-1.0.0.post24/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hyperforge_generate"
+version = "1.0.0.post24"
+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_generate-1.0.0.post24/setup.cfg

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

hyperforge_generate-1.0.0.post24/src/hyperforge_generate/agent.py

@@ -0,0 +1,101 @@
+from time import time
+from uuid import uuid4
+
+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 nuclia.lib.nua_responses import ChatModel, UserPrompt
+
+from hyperforge import PROMPT_ENVIRONMENT
+from hyperforge_generate.config import GenerateAgentConfig
+
+GENERATE_PROMPT = """
+Generate the following request using **only** the provided context. Refrain from incorporating any outside knowledge. If the context is insufficient to answer the question comprehensively, respond with: "Not enough data to generate this."
+
+
+{% if rules -%}
+# Generation Rules
+{% for rule in rules -%}
+- {{rule}}
+{% endfor -%}
+{% endif -%}
+
+{{prompt}}
+
+{{context}}
+
+MAIN QUESTION: {{question}}
+
+# Notes
+- Use the context provided without being overly selective.
+- Please try to generate if possible, even if it requires to make a bit of a deduction.
+- If they are images attached, look through them carefully.
+- For rules related to charts or images, pay extra attention to extracting details and interpreting data presented visually. Think about it carefully before giving inaccurate interpretations
+
+"""
+
+GENERATE_PROMPT_TEMPLATE = PROMPT_ENVIRONMENT.from_string(GENERATE_PROMPT)
+
+
+@agent(
+    id="generate",
+    agent_type="generation",
+    title="Generate Answer",
+    description="Generate answers based on provided context.",
+    config_schema=GenerateAgentConfig,
+)
+class GenerateAgent(Agent[GenerateAgentConfig]):
+    __root_agent__ = True
+
+    @trace_agent
+    async def __call__(
+        self,
+        memory: QuestionMemory,
+        manager: Manager,
+    ):
+        # For each context in memory add context query, summary and answer onto a text and the initial question
+        prompt = GENERATE_PROMPT_TEMPLATE.render(
+            question=memory.original_question,
+            context=memory.contexts_minimal(),
+            prompt=self.config.prompt,
+            rules=memory.generation_rules,
+        )
+        t0 = time()
+
+        chat_model = ChatModel(
+            user_id="generate",
+            question="",
+            user_prompt=UserPrompt(prompt=prompt),
+            format_prompt=False,
+            generative_model=self.config.model,
+            max_tokens=2000,
+            tracking=memory.get_tracking_info(),
+        )
+
+        agent_path = f"/generation/{self.config.id if self.config.id else 'default'}"
+        resp, input_tokens, output_tokens = await manager.execute_raw(
+            chat_model, memory=memory, module="generate", agent_path=agent_path
+        )
+
+        generated_text = resp.answer or ""
+
+        memory.generated_texts[uuid4().hex] = generated_text
+
+        await memory.add_generated_text(
+            self.config.id if self.config.id else "default", generated_text
+        )
+        # We assume that JSON generation always produces an answer
+        memory.is_answered = True
+
+        await memory.add_step(
+            step_module=self.config.module,
+            step_title=self.step_title("Generate"),
+            step_value="",
+            step_reason="",
+            step_agent_path=agent_path,
+            timeit=time() - t0,
+            input_nuclia_tokens=input_tokens,
+            output_nuclia_tokens=output_tokens,
+        )

hyperforge_generate-1.0.0.post24/src/hyperforge_generate/config.py

@@ -0,0 +1,26 @@
+from typing import Literal, Optional
+
+from hyperforge.agent import AgentConfig
+from hyperforge.utils import WidgetType
+from pydantic import Field
+from pydantic.config import ConfigDict
+
+
+class GenerateAgentConfig(AgentConfig):
+    model_config = ConfigDict(title="Generate")
+    module: Literal["generate"] = "generate"
+    prompt: Optional[str] = Field(
+        None,
+        json_schema_extra={
+            "show_in_node": True,
+            "widget": WidgetType.EXPANDABLE_TEXTAREA,
+        },
+    )
+    model: str = Field(
+        default="chatgpt-azure-4o-mini",
+        title="Generative model",
+        description="Model used to generate the response",
+        json_schema_extra={"widget": WidgetType.MODEL_SELECT},
+    )
+    images: bool = False
+    generate_image: bool = False

hyperforge_generate-1.0.0.post24/src/hyperforge_generate.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: hyperforge_generate
+Version: 1.0.0.post24
+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
+
+# Generate Hyperforge agents

hyperforge_generate-1.0.0.post24/src/hyperforge_generate.egg-info/SOURCES.txt

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

hyperforge_generate-1.0.0.post24/src/hyperforge_generate.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hyperforge_generate-1.0.0.post24/src/hyperforge_generate.egg-info/requires.txt

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

hyperforge_generate-1.0.0.post24/src/hyperforge_generate.egg-info/top_level.txt

@@ -0,0 +1 @@
+hyperforge_generate

hyperforge_generate-1.0.0.post24/tests/test_generate.py

@@ -0,0 +1,83 @@
+from collections import OrderedDict
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+from hyperforge.manager import Manager
+from hyperforge.memory import Chunk, Context
+from hyperforge.memory.memory import EphemeralSessionMemory
+from hyperforge.models import MemoryConfig, Rules
+from hyperforge_generate.agent import GenerateAgent
+from hyperforge_generate.config import GenerateAgentConfig
+
+pytestmark = pytest.mark.asyncio
+
+
+async def test_generate_agent():
+    # 1. Create a mocked manager
+    manager = MagicMock(spec=Manager)
+
+    # Mock execute_raw response.
+    # resp must be an object with an `answer` attribute.
+    resp_mock = MagicMock()
+    resp_mock.answer = "This is a generated response based on context."
+    manager.execute_raw = AsyncMock(return_value=(resp_mock, 10, 20))
+
+    # 2. Create the configuration for GenerateAgent
+    config = GenerateAgentConfig(
+        prompt="Synthesize an answer.", model="chatgpt-azure-4o-mini"
+    )
+
+    # 3. Create the GenerateAgent instance
+    agent = GenerateAgent(config=config)
+
+    # 4. Set up EphemeralSessionMemory and QuestionMemory
+    session = EphemeralSessionMemory.from_config(
+        config=MemoryConfig(), agent_id="test", workflow_id="test", rules=Rules()
+    )
+    session.init("test-session")
+    memory = session.start_question("What is the capital of France?")
+
+    # Let's add some contexts and rules to memory to verify prompt rendering
+    context_obj = Context(
+        id="context-1",
+        original_question_uuid="question-1",
+        actual_question_uuid="question-1",
+        question="What is the capital of France?",
+        source="test-source",
+        agent="static",
+        title="Static Context",
+        chunks=[Chunk(chunk_id="chunk-1", text="The capital of France is Paris.")],
+    )
+    memory.contexts.append(context_obj)
+
+    # Add generation rules
+    memory.generation_rules = OrderedDict([("Only use the context.", "")])
+
+    # 5. Call the agent
+    await agent(memory=memory, manager=manager)
+
+    # 6. Assertions
+    # Verify execute_raw was called with expected arguments
+    assert manager.execute_raw.called
+    call_args = manager.execute_raw.call_args[0]
+    chat_model = call_args[0]
+
+    # Verify that prompt template rendered correctly containing context, question, and rules
+    assert "The capital of France is Paris." in chat_model.user_prompt.prompt
+    assert "What is the capital of France?" in chat_model.user_prompt.prompt
+    assert "Only use the context." in chat_model.user_prompt.prompt
+    assert "Synthesize an answer." in chat_model.user_prompt.prompt
+
+    # Verify the generated text was added to memory
+    assert memory.is_answered is True
+    assert len(memory.generated_texts) == 2
+    for val in memory.generated_texts.values():
+        assert val == "This is a generated response based on context."
+
+    # Verify a step was added
+    assert len(memory.steps) == 1
+    step = memory.steps[0]
+    assert step.module == "generate"
+    assert step.title == "Generate: Generate"
+    assert step.input_nuclia_tokens == 10
+    assert step.output_nuclia_tokens == 20