provider.py 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. """SearXNG search via a user-hosted instance (``/search?format=json``).
  2. Search-only — SearXNG aggregates upstream engines but does not fetch URLs.
  3. Env: ``SEARXNG_URL=http://localhost:8080``.
  4. """
  5. from __future__ import annotations
  6. import logging
  7. from typing import Any, Dict
  8. from plugins.web._common import BaseWebSearchProvider, http_get_json, provider_env, search_fail, search_ok, setup_schema, titled_rows
  9. logger = logging.getLogger(__name__)
  10. class SearXNGWebSearchProvider(BaseWebSearchProvider):
  11. """Search via a user-hosted SearXNG instance."""
  12. NAME = "searxng"
  13. DISPLAY_NAME = "SearXNG"
  14. KEY_ENV = "SEARXNG_URL"
  15. def search(self, query: str, limit: int = 5) -> dict[str, Any]:
  16. base_url = provider_env("SEARXNG_URL").rstrip("/")
  17. if not base_url:
  18. return search_fail("SEARXNG_URL is not set")
  19. data, failure = http_get_json(
  20. "SearXNG", f"{base_url}/search", params={"q": query, "format": "json", "pageno": 1},
  21. headers={"Accept": "application/json"}, timeout=15, logger=logger, reach_target=f"SearXNG at {base_url}",
  22. )
  23. if failure is not None:
  24. return failure
  25. raw_results = data.get("results", [])
  26. # SearXNG may return a score field; sort descending and cap to limit.
  27. sorted_results = sorted(raw_results, key=lambda r: float(r.get("score", 0)), reverse=True)[:limit]
  28. web_results = titled_rows(sorted_results, "content")
  29. logger.info("SearXNG search '%s': %d results (from %d raw, limit %d)", query, len(web_results), len(raw_results), limit)
  30. return search_ok(web_results)
  31. def get_setup_schema(self) -> dict[str, Any]:
  32. return setup_schema(
  33. "SearXNG", "free · self-hosted", "Free, privacy-respecting metasearch. Point SEARXNG_URL at your instance.",
  34. "SEARXNG_URL", "SearXNG instance URL (e.g. http://localhost:8080)", "https://searx.space/",
  35. )