Files
hermes-agent/plugins/web/keenable/provider.py

112 lines
4.3 KiB
Python

"""Keenable (https://keenable.ai) web search + fetch — keyless-ring member.
Env: ``KEENABLE_API_KEY`` (optional; keyless free tier works without it).
Config: ``web.provider_tier.keenable: free|paid`` pins the tier (unset = auto).
"""
from __future__ import annotations
import logging
from typing import Any, Dict, List
from plugins.web._common import (
SEARCH_LIMIT_CAP,
BaseWebSearchProvider,
document,
http_status_detail,
keyless_variant_schema,
provider_env,
run_extract,
run_search,
search_fail,
search_ok,
use_keyless,
web_hit,
)
logger = logging.getLogger(__name__)
_KEENABLE_API_URL = "https://api.keenable.ai"
def _keenable_headers(api_key: str) -> Dict[str, str]:
# The keyless tier structurally requires an app-identifier header; no user identifiers are sent.
headers = {"X-Keenable-Title": "hermes-agent"}
if api_key:
headers["Authorization"] = f"Bearer {api_key}"
return headers
class KeenableWebSearchProvider(BaseWebSearchProvider):
"""Keenable search + extract provider (keyed or keyless)."""
NAME = "keenable"
DISPLAY_NAME = "Keenable"
KEY_ENV = "KEENABLE_API_KEY"
EXTRACT = True
KEYLESS = True
def search(self, query: str, limit: int = 5) -> Dict[str, Any]:
def _body() -> Dict[str, Any]:
from plugins.web.keyless_mcp import search_with_failover
api_key = provider_env("KEENABLE_API_KEY")
if use_keyless("keenable", api_key):
logger.info("Keenable keyless search: '%s' (limit=%d)", query, limit)
return search_with_failover("keenable", query, limit)
import requests
logger.info("Keenable search: '%s' (limit=%d)", query, limit)
response = requests.post(
f"{_KEENABLE_API_URL}/v1/search",
json={"query": query, "max_results": min(max(1, int(limit)), SEARCH_LIMIT_CAP)},
headers=_keenable_headers(api_key),
timeout=30,
)
if response.status_code >= 400:
return search_fail(f"Keenable search failed: {http_status_detail(response)}")
return search_ok([
web_hit(r.get("url") or "", r.get("title") or "", r.get("snippet") or r.get("description") or "", i + 1)
for i, r in enumerate(response.json().get("results") or [])
])
return run_search("Keenable", logger, _body, verbatim_value_error=False)
def extract(self, urls: List[str], **kwargs: Any) -> List[Dict[str, Any]]:
def _body() -> List[Dict[str, Any]]:
from plugins.web.keyless_mcp import extract_with_failover
api_key = provider_env("KEENABLE_API_KEY")
if use_keyless("keenable", api_key):
logger.info("Keenable keyless extract: %d URL(s)", len(urls))
return extract_with_failover("keenable", list(urls))
import requests
logger.info("Keenable extract: %d URL(s)", len(urls))
results: List[Dict[str, Any]] = []
for url in urls:
try:
response = requests.get(
f"{_KEENABLE_API_URL}/v1/fetch", params={"url": url}, headers=_keenable_headers(api_key), timeout=30
)
if response.status_code >= 400:
raise ValueError(http_status_detail(response))
data = response.json()
results.append(
document(data.get("url") or url, data.get("title") or "", data.get("content") or "", source_url=url)
)
except Exception as exc: # noqa: BLE001 — per-URL error entry
results.append({"url": url, "title": "", "content": "", "error": f"Keenable extract failed: {exc}"})
return results
return run_extract("Keenable", logger, urls, _body, verbatim_value_error=False)
def get_setup_schema(self) -> Dict[str, Any]:
return keyless_variant_schema(
"Keenable", "KEENABLE_API_KEY", "https://keenable.ai",
free_tag="Independent web index for AI apps — fast search + page fetch on Keenable's anonymous free tier.",
paid_tag="Independent web index for AI apps. Keyed access with higher limits and guaranteed service.",
)