feat(status): add web search provider usage to /status command
This commit is contained in:
@@ -0,0 +1,183 @@
|
||||
"""Web search provider usage fetchers for /status command."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
|
||||
@dataclass
|
||||
class SearchUsageInfo:
|
||||
"""Structured usage info returned by a provider fetcher."""
|
||||
|
||||
provider: str
|
||||
supported: bool = False # True if the provider has a usage API
|
||||
error: str | None = None # Set when the API call failed
|
||||
|
||||
# Usage counters (None = not available for this provider)
|
||||
used: int | None = None
|
||||
limit: int | None = None
|
||||
remaining: int | None = None
|
||||
reset_date: str | None = None # ISO date string, e.g. "2026-05-01"
|
||||
|
||||
# Tavily-specific breakdown
|
||||
search_used: int | None = None
|
||||
extract_used: int | None = None
|
||||
crawl_used: int | None = None
|
||||
|
||||
def format(self) -> str:
|
||||
"""Return a human-readable multi-line string for /status output."""
|
||||
lines = [f"🔍 Web Search: {self.provider}"]
|
||||
|
||||
if not self.supported:
|
||||
lines.append(" Usage tracking: not available for this provider")
|
||||
return "\n".join(lines)
|
||||
|
||||
if self.error:
|
||||
lines.append(f" Usage: unavailable ({self.error})")
|
||||
return "\n".join(lines)
|
||||
|
||||
if self.used is not None and self.limit is not None:
|
||||
lines.append(f" Usage: {self.used} / {self.limit} requests")
|
||||
elif self.used is not None:
|
||||
lines.append(f" Usage: {self.used} requests")
|
||||
|
||||
# Tavily breakdown
|
||||
breakdown_parts = []
|
||||
if self.search_used is not None:
|
||||
breakdown_parts.append(f"Search: {self.search_used}")
|
||||
if self.extract_used is not None:
|
||||
breakdown_parts.append(f"Extract: {self.extract_used}")
|
||||
if self.crawl_used is not None:
|
||||
breakdown_parts.append(f"Crawl: {self.crawl_used}")
|
||||
if breakdown_parts:
|
||||
lines.append(f" Breakdown: {' | '.join(breakdown_parts)}")
|
||||
|
||||
if self.remaining is not None:
|
||||
lines.append(f" Remaining: {self.remaining} requests")
|
||||
|
||||
if self.reset_date:
|
||||
lines.append(f" Resets: {self.reset_date}")
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
async def fetch_search_usage(
|
||||
provider: str,
|
||||
api_key: str | None = None,
|
||||
) -> SearchUsageInfo:
|
||||
"""
|
||||
Fetch usage info for the configured web search provider.
|
||||
|
||||
Args:
|
||||
provider: Provider name (e.g. "tavily", "brave", "duckduckgo").
|
||||
api_key: API key for the provider (falls back to env vars).
|
||||
|
||||
Returns:
|
||||
SearchUsageInfo with populated fields where available.
|
||||
"""
|
||||
p = (provider or "duckduckgo").strip().lower()
|
||||
|
||||
if p == "tavily":
|
||||
return await _fetch_tavily_usage(api_key)
|
||||
elif p == "brave":
|
||||
return await _fetch_brave_usage(api_key)
|
||||
else:
|
||||
# duckduckgo, searxng, jina, unknown — no usage API
|
||||
return SearchUsageInfo(provider=p, supported=False)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tavily
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
async def _fetch_tavily_usage(api_key: str | None) -> SearchUsageInfo:
|
||||
"""Fetch usage from GET https://api.tavily.com/usage."""
|
||||
import httpx
|
||||
|
||||
key = api_key or os.environ.get("TAVILY_API_KEY", "")
|
||||
if not key:
|
||||
return SearchUsageInfo(
|
||||
provider="tavily",
|
||||
supported=True,
|
||||
error="TAVILY_API_KEY not configured",
|
||||
)
|
||||
|
||||
try:
|
||||
async with httpx.AsyncClient(timeout=8.0) as client:
|
||||
r = await client.get(
|
||||
"https://api.tavily.com/usage",
|
||||
headers={"Authorization": f"Bearer {key}"},
|
||||
)
|
||||
r.raise_for_status()
|
||||
data: dict[str, Any] = r.json()
|
||||
return _parse_tavily_usage(data)
|
||||
except httpx.HTTPStatusError as e:
|
||||
return SearchUsageInfo(
|
||||
provider="tavily",
|
||||
supported=True,
|
||||
error=f"HTTP {e.response.status_code}",
|
||||
)
|
||||
except Exception as e:
|
||||
return SearchUsageInfo(
|
||||
provider="tavily",
|
||||
supported=True,
|
||||
error=str(e)[:80],
|
||||
)
|
||||
|
||||
|
||||
def _parse_tavily_usage(data: dict[str, Any]) -> SearchUsageInfo:
|
||||
"""
|
||||
Parse Tavily /usage response.
|
||||
|
||||
Expected shape (may vary by plan):
|
||||
{
|
||||
"used": 142,
|
||||
"limit": 1000,
|
||||
"remaining": 858,
|
||||
"reset_date": "2026-05-01",
|
||||
"breakdown": {
|
||||
"search": 120,
|
||||
"extract": 15,
|
||||
"crawl": 7
|
||||
}
|
||||
}
|
||||
"""
|
||||
used = data.get("used")
|
||||
limit = data.get("limit")
|
||||
remaining = data.get("remaining")
|
||||
reset_date = data.get("reset_date") or data.get("resetDate")
|
||||
|
||||
# Compute remaining if not provided
|
||||
if remaining is None and used is not None and limit is not None:
|
||||
remaining = max(0, limit - used)
|
||||
|
||||
breakdown = data.get("breakdown") or {}
|
||||
search_used = breakdown.get("search")
|
||||
extract_used = breakdown.get("extract")
|
||||
crawl_used = breakdown.get("crawl")
|
||||
|
||||
return SearchUsageInfo(
|
||||
provider="tavily",
|
||||
supported=True,
|
||||
used=used,
|
||||
limit=limit,
|
||||
remaining=remaining,
|
||||
reset_date=str(reset_date) if reset_date else None,
|
||||
search_used=search_used,
|
||||
extract_used=extract_used,
|
||||
crawl_used=crawl_used,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Brave
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
async def _fetch_brave_usage(api_key: str | None) -> SearchUsageInfo:
|
||||
"""
|
||||
Brave Search does not have a public usage/quota endpoint.
|
||||
Rate-limit headers are returned per-request, not queryable standalone.
|
||||
"""
|
||||
return SearchUsageInfo(provider="brave", supported=False)
|
||||
@@ -60,6 +60,21 @@ async def cmd_status(ctx: CommandContext) -> OutboundMessage:
|
||||
pass
|
||||
if ctx_est <= 0:
|
||||
ctx_est = loop._last_usage.get("prompt_tokens", 0)
|
||||
|
||||
# Fetch web search provider usage (best-effort, never blocks the response)
|
||||
search_usage_text: str | None = None
|
||||
try:
|
||||
from nanobot.agent.tools.search_usage import fetch_search_usage
|
||||
web_cfg = getattr(getattr(loop, "config", None), "tools", None)
|
||||
web_cfg = getattr(web_cfg, "web", None) if web_cfg else None
|
||||
search_cfg = getattr(web_cfg, "search", None) if web_cfg else None
|
||||
if search_cfg is not None:
|
||||
provider = getattr(search_cfg, "provider", "duckduckgo")
|
||||
api_key = getattr(search_cfg, "api_key", "") or None
|
||||
usage = await fetch_search_usage(provider=provider, api_key=api_key)
|
||||
search_usage_text = usage.format()
|
||||
except Exception:
|
||||
pass # Never let usage fetch break /status
|
||||
return OutboundMessage(
|
||||
channel=ctx.msg.channel,
|
||||
chat_id=ctx.msg.chat_id,
|
||||
@@ -69,6 +84,7 @@ async def cmd_status(ctx: CommandContext) -> OutboundMessage:
|
||||
context_window_tokens=loop.context_window_tokens,
|
||||
session_msg_count=len(session.get_history(max_messages=0)),
|
||||
context_tokens_estimate=ctx_est,
|
||||
search_usage_text=search_usage_text,
|
||||
),
|
||||
metadata={**dict(ctx.msg.metadata or {}), "render_as": "text"},
|
||||
)
|
||||
|
||||
@@ -396,8 +396,15 @@ def build_status_content(
|
||||
context_window_tokens: int,
|
||||
session_msg_count: int,
|
||||
context_tokens_estimate: int,
|
||||
search_usage_text: str | None = None,
|
||||
) -> str:
|
||||
"""Build a human-readable runtime status snapshot."""
|
||||
"""Build a human-readable runtime status snapshot.
|
||||
|
||||
Args:
|
||||
search_usage_text: Optional pre-formatted web search usage string
|
||||
(produced by SearchUsageInfo.format()). When provided
|
||||
it is appended as an extra section.
|
||||
"""
|
||||
uptime_s = int(time.time() - start_time)
|
||||
uptime = (
|
||||
f"{uptime_s // 3600}h {(uptime_s % 3600) // 60}m"
|
||||
@@ -414,14 +421,17 @@ def build_status_content(
|
||||
token_line = f"\U0001f4ca Tokens: {last_in} in / {last_out} out"
|
||||
if cached and last_in:
|
||||
token_line += f" ({cached * 100 // last_in}% cached)"
|
||||
return "\n".join([
|
||||
lines = [
|
||||
f"\U0001f408 nanobot v{version}",
|
||||
f"\U0001f9e0 Model: {model}",
|
||||
token_line,
|
||||
f"\U0001f4da Context: {ctx_used_str}/{ctx_total_str} ({ctx_pct}%)",
|
||||
f"\U0001f4ac Session: {session_msg_count} messages",
|
||||
f"\u23f1 Uptime: {uptime}",
|
||||
])
|
||||
]
|
||||
if search_usage_text:
|
||||
lines.append(search_usage_text)
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def sync_workspace_templates(workspace: Path, silent: bool = False) -> list[str]:
|
||||
|
||||
Reference in New Issue
Block a user