provider.py 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. """Brave Search (free-tier Data-for-Search API) — search only, 2,000 queries/month.
  2. Config: ``web.search_backend`` / ``web.backend: "brave-free"`` (hyphen form kept for
  3. existing user configs). Env: ``BRAVE_SEARCH_API_KEY``. Pair with Firecrawl/Tavily/Exa
  4. for ``web_extract``.
  5. """
  6. from __future__ import annotations
  7. import logging
  8. from typing import Any, Dict
  9. from plugins.web._common import BaseWebSearchProvider, http_get_json, provider_env, search_fail, search_ok, setup_schema, titled_rows
  10. logger = logging.getLogger(__name__)
  11. _BRAVE_ENDPOINT = "https://api.search.brave.com/res/v1/web/search"
  12. class BraveFreeWebSearchProvider(BaseWebSearchProvider):
  13. """Search-only Brave provider using the free-tier Data-for-Search API."""
  14. NAME = "brave-free"
  15. DISPLAY_NAME = "Brave Search (Free)"
  16. KEY_ENV = "BRAVE_SEARCH_API_KEY"
  17. def search(self, query: str, limit: int = 5) -> dict[str, Any]:
  18. api_key = provider_env("BRAVE_SEARCH_API_KEY")
  19. if not api_key:
  20. return search_fail("BRAVE_SEARCH_API_KEY is not set")
  21. data, failure = http_get_json(
  22. "Brave Search", _BRAVE_ENDPOINT,
  23. params={"q": query, "count": max(1, min(int(limit), 20))}, # Brave caps count at 20
  24. headers={"X-Subscription-Token": api_key, "Accept": "application/json"},
  25. timeout=15, logger=logger,
  26. )
  27. if failure is not None:
  28. return failure
  29. raw_results = (data.get("web") or {}).get("results", []) or []
  30. web_results = titled_rows(raw_results[:limit], "description")
  31. logger.info("Brave Search '%s': %d results (from %d raw, limit %d)", query, len(web_results), len(raw_results), limit)
  32. return search_ok(web_results)
  33. def get_setup_schema(self) -> dict[str, Any]:
  34. return setup_schema(
  35. "Brave Search (Free)", "free", "Free-tier API key — 2k queries/mo, search only.",
  36. "BRAVE_SEARCH_API_KEY", "Brave Search API key (free tier)", "https://brave.com/search/api/",
  37. )