hyperforge-perplexity-search 1.0.0.post20__py3-none-any.whl

hyperforge_perplexity_search/__init__.py

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

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/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,8 @@
+hyperforge_perplexity_search/__init__.py,sha256=HAUxf99Ni8wUtYVi850xrpbDX_zDCzPvartIdAfx7hM,78
+hyperforge_perplexity_search/agent.py,sha256=wCnPkhh-YIikDzqkL3uBYKQzYck-9SqlivQYKgPY2Nw,5025
+hyperforge_perplexity_search/config.py,sha256=G9ObHUVp3h9SZPDaw6jafzfsKHRUoFPsmNukdwDbiaY,1351
+hyperforge_perplexity_search/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hyperforge_perplexity_search-1.0.0.post20.dist-info/METADATA,sha256=P7HXNPRHbCz0DVF5EET1nwu92PeNcwJJZz50qzpcJIE,854
+hyperforge_perplexity_search-1.0.0.post20.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+hyperforge_perplexity_search-1.0.0.post20.dist-info/top_level.txt,sha256=p7pLED3CsH_kZYaQi6d26rgcjlfC-lGA1zGXkczdQR8,29
+hyperforge_perplexity_search-1.0.0.post20.dist-info/RECORD,,

hyperforge_perplexity_search-1.0.0.post20.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

hyperforge_perplexity_search-1.0.0.post20.dist-info/top_level.txt

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