hyperforge-perplexity-search 1.0.0.post20__tar.gz

hyperforge_perplexity_search-1.0.0.post20/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: hyperforge_perplexity_search
+Version: 1.0.0.post20
+Summary: Perplexity Search 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/hyperforge
+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
+Requires-Dist: httpx
+Requires-Dist: hyperforge_perplexity
+Requires-Dist: perplexityai>=0.35.1
+
+# Perplexity Search Hyperforge agents

hyperforge_perplexity_search-1.0.0.post20/README.md

@@ -0,0 +1 @@
+# Perplexity Search Hyperforge agents

hyperforge_perplexity_search-1.0.0.post20/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hyperforge_perplexity_search"
+version = "1.0.0.post20"
+license = "Apache-2.0"
+description = "Perplexity Search 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",
+    "httpx",
+    "hyperforge_perplexity",
+    "perplexityai>=0.35.1",
+]
+
+[dependency-groups]
+dev = [
+    "mypy",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-recording",
+    "ty",
+]
+
+[project.urls]
+Homepage = "https://progress.com"
+Repository = "https://github.com/nuclia/hyperforge"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

hyperforge_perplexity_search-1.0.0.post20/setup.cfg

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

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search/__init__.py

@@ -0,0 +1,3 @@
+from .agent import PerplexitySearchAgent
+
+__all__ = ["PerplexitySearchAgent"]

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search/agent.py

@@ -0,0 +1,140 @@
+from time import time
+from typing import Any, ClassVar, Dict, List, Optional, cast
+from uuid import uuid4
+
+from hyperforge.agent import Agent
+from hyperforge.configure import agent
+from hyperforge.context.agent import ContextAgent
+from hyperforge.definition import FunctionDefinition
+from hyperforge.manager import Manager
+from hyperforge.memory import Chunk, Context, QuestionMemory
+from hyperforge_perplexity.driver import PerplexityDriver
+
+from hyperforge_perplexity_search.config import PerplexitySearchAgentConfig
+
+SYSTEM_PROMPT = "Be precise and concise"
+
+
+@agent(
+    id="perplexity_search",
+    agent_type="context",
+    title="Perplexity Search",
+    description="Use Perplexity to get information from the internet.",
+    config_schema=PerplexitySearchAgentConfig,
+)
+class PerplexitySearchAgent(ContextAgent, Agent[PerplexitySearchAgentConfig]):
+    driver: Optional[PerplexityDriver] = None
+    __published_functions__: ClassVar[Dict[str, FunctionDefinition]] = {
+        "internet_search": FunctionDefinition(
+            name="internet_search",
+            description="Performs an internet search using Perplexity and returns the results as context to answer questions. Does not generate an answer, only search and return the results as context.",
+            parameters={
+                "question": {
+                    "type": "string",
+                    "description": "The question to search for on the internet.",
+                },
+            },
+        )
+    }
+
+    async def search(
+        self,
+        question: str,
+        memory: QuestionMemory,
+        manager: Manager,
+        question_uuid: Optional[str] = None,
+    ) -> Context:
+        t0 = time()
+
+        if self.driver is None:
+            self.driver: Optional[PerplexityDriver] = cast(
+                Optional[PerplexityDriver], manager.drivers.get(self.config.source)
+            )
+        if self.driver is None:
+            raise Exception("Perplexity driver does not exist")
+
+        response = await self.driver.client.search.create(
+            query=question,
+            search_domain_filter=self.config.domain,
+            max_results=self.config.max_results,
+            max_tokens_per_page=self.config.max_tokens_per_page,
+        )
+        chunks = []
+        if response.results is not None:
+            for result in response.results:
+                text = result.snippet if result.snippet is not None else ""
+                title = (
+                    result.title
+                    if result.title is not None
+                    else result.url
+                    if result.url is not None
+                    else "No title"
+                )
+                chunk = Chunk(
+                    chunk_id=uuid4().hex,
+                    text=text,
+                    title=title,
+                    labels=[],
+                    url=[result.url] if result.url is not None else [],
+                    origin_url=result.url if result.url is not None else "",
+                    origin_agent=self.config.module,
+                )
+                chunks.append(chunk)
+        context = Context(
+            agent_id=self.config.id or self.agent_id,
+            original_question_uuid=memory.original_question_uuid,
+            actual_question_uuid=question_uuid,
+            question=question,
+            title=self.config.title
+            if self.config.title
+            else "Internet search with Perplexity",
+            source="perplexity",
+            agent=self.config.module,
+            chunks=chunks,
+        )
+        await memory.add_step(
+            step_module=self.config.module,
+            step_title=self.step_title("Search results"),
+            step_reason="",
+            step_agent_path=f"/context/{self.config.id or self.agent_id}",
+            step_value=f"{len(chunks)} results found with Perplexity"
+            if chunks
+            else "No results found",
+            timeit=time() - t0,
+            input_nuclia_tokens=0,
+            output_nuclia_tokens=0,
+        )
+        return context
+
+    async def _get_question_context(
+        self,
+        memory: QuestionMemory,
+        manager: Manager,
+        question_uuid: str,
+        question: str,
+        flow_id: str,
+        extra_context: Optional[Dict[str, Any]] = None,
+    ) -> List[tuple[str, str]]:
+        if self.driver is None:
+            self.driver: Optional[PerplexityDriver] = cast(
+                Optional[PerplexityDriver], manager.drivers.get(self.config.source)
+            )
+
+        if self.driver is None:
+            raise Exception("Perplexity driver does not exist")
+
+        context = await self.search(
+            question,
+            memory,
+            manager,
+            question_uuid=question_uuid,
+        )
+
+        missing = await self.save_ctx_and_return_missing(
+            context=context,
+            question=question,
+            memory=memory,
+            manager=manager,
+            flow_id=flow_id,
+        )
+        return [missing] if missing is not None else []

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search/config.py

@@ -0,0 +1,35 @@
+from typing import List, Literal
+
+from hyperforge.context.config import ContextAgentConfig
+from pydantic import Field
+from pydantic.config import ConfigDict
+
+
+class PerplexitySearchAgentConfig(ContextAgentConfig):
+    model_config = ConfigDict(title="Perplexity Search")
+    module: Literal["perplexity_search"] = "perplexity_search"
+    domain: List[str] = Field(
+        default_factory=list,
+        title="Domain Filter",
+        description="Domains to restrict the Perplexity search to.",
+    )
+    search_context_size: Literal["low", "medium", "high"] = Field(
+        default="low",
+        title="Search Context Size",
+        description="Determines how much search context Perplexity retrieves for the model. "
+        "Options are: `low` (minimizes context for cost savings but less comprehensive answers), "
+        "`medium` (balanced approach suitable for most queries), "
+        "and `high` (maximizes context for comprehensive answers but at higher cost).",
+    )
+    max_results: int = Field(
+        default=10,
+        title="Max Results",
+        description="Maximum number of search results to return.",
+    )
+    max_tokens_per_page: int = Field(
+        default=4096,
+        title="Max Tokens per Page",
+        description="Maximum number of tokens to return per search result page.",
+    )
+
+    source: str = "perplexity"

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: hyperforge_perplexity_search
+Version: 1.0.0.post20
+Summary: Perplexity Search 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/hyperforge
+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
+Requires-Dist: httpx
+Requires-Dist: hyperforge_perplexity
+Requires-Dist: perplexityai>=0.35.1
+
+# Perplexity Search Hyperforge agents

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+src/hyperforge_perplexity_search/__init__.py
+src/hyperforge_perplexity_search/agent.py
+src/hyperforge_perplexity_search/config.py
+src/hyperforge_perplexity_search/py.typed
+src/hyperforge_perplexity_search.egg-info/PKG-INFO
+src/hyperforge_perplexity_search.egg-info/SOURCES.txt
+src/hyperforge_perplexity_search.egg-info/dependency_links.txt
+src/hyperforge_perplexity_search.egg-info/requires.txt
+src/hyperforge_perplexity_search.egg-info/top_level.txt
+tests/test_perplexity_search.py

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search.egg-info/requires.txt

@@ -0,0 +1,4 @@
+hyperforge
+httpx
+hyperforge_perplexity
+perplexityai>=0.35.1

hyperforge_perplexity_search-1.0.0.post20/src/hyperforge_perplexity_search.egg-info/top_level.txt

@@ -0,0 +1 @@
+hyperforge_perplexity_search

hyperforge_perplexity_search-1.0.0.post20/tests/test_perplexity_search.py

@@ -0,0 +1,90 @@
+import os
+from uuid import uuid4
+
+import pytest
+from hyperforge.configure import get_driver_config_instance, load_all_configurations
+from hyperforge.manager import Manager
+from hyperforge.memory import Context
+from hyperforge.memory.memory import EphemeralSessionMemory
+from hyperforge.minimal_fixtures import cassette_nua_key
+from hyperforge.models import MemoryConfig, Rules
+from hyperforge_perplexity_search.agent import PerplexitySearchAgent
+from hyperforge_perplexity_search.config import PerplexitySearchAgentConfig
+from nuclia.lib.nua import AsyncNuaClient
+
+NUA_KEY = os.environ.get(
+    "NUA_KEY",
+) or cassette_nua_key("https://europe-1.nuclia.cloud/")
+
+PERPLEXITY_KEY = os.environ.get("PERPLEXITY_API_KEY", "DUMMY_PERPLEXITY_KEY")
+
+pytestmark = [
+    pytest.mark.vcr(ignore_localhost=True),
+    pytest.mark.asyncio,
+]
+
+DRIVERS = [
+    {
+        "provider": "perplexity",
+        "identifier": "perplexity-01",
+        "name": "perplexity",
+        "config": {"key": PERPLEXITY_KEY},
+    },
+]
+
+
+async def _run_question(
+    drivers: list[dict], question: str, config_overrides: dict | None = None
+) -> list[Context]:
+    load_all_configurations("hyperforge_perplexity_search")
+    load_all_configurations("hyperforge_perplexity")  # register the perplexity driver
+    # Perplexity agent doesn't use nua — construct client directly with test values
+    nua = AsyncNuaClient(region="europe-1", account="test", token=NUA_KEY)
+    manager = await Manager.from_config(
+        drivers=[get_driver_config_instance(d) for d in drivers],
+        nua=nua,
+    )
+    config = PerplexitySearchAgentConfig.model_validate(
+        {
+            "module": "perplexity_search",
+            "title": "Perplexity Search Agent",
+            "source": "perplexity-01",
+            **(config_overrides or {}),
+        }
+    )
+    agent = PerplexitySearchAgent(config=config)
+    await agent.inner_from_config(config)
+
+    session = EphemeralSessionMemory.from_config(
+        config=MemoryConfig(), agent_id="test", workflow_id="test", rules=Rules()
+    )
+    session.init("test-session")
+    memory = session.start_question(question)
+    flow_id = uuid4().hex
+    await agent.get_question_context(
+        memory=memory,
+        manager=manager,
+        question_uuid=memory.original_question_uuid,
+        question=question,
+        flow_id=flow_id,
+    )
+    return memory.get_agent_contexts(flow_id=flow_id, agent_id=agent.agent_id)
+
+
+async def test_perplexity_search():
+    contexts = await _run_question(
+        DRIVERS,
+        "What is Nuclia?",
+        config_overrides={"domain": ["nuclia.com"], "max_results": 3},
+    )
+    assert len(contexts) > 0
+    assert any(ctx.chunks for ctx in contexts)
+
+
+async def test_perplexity_search_domain():
+    contexts = await _run_question(
+        DRIVERS,
+        "What is Marklogic?",
+        config_overrides={"domain": ["progress.com"], "max_results": 5},
+    )
+    assert len(contexts) > 0