Compare commits

...
2 Commits
Author SHA1 Message Date
moosecrap 31dc984197 Documentation 2026-07-24 22:53:22 -07:00
moosecrap 50c06cc134 Wikipedia 2026-07-24 22:24:23 -07:00
4 changed files with 198 additions and 0 deletions
+6
View File
@@ -32,6 +32,12 @@ Extracts AI generation parameters from PNG files.
Returns the full-resolution image. Returns the full-resolution image.
* **Best for**: Final confirmation or deep visual analysis where every pixel counts. * **Best for**: Final confirmation or deep visual analysis where every pixel counts.
### 🌐 `browse_wikipedia`
Allows the model to browse Wikipedia using its API.
* **Best for**: Quickly retrieving summaries, structural maps (ToC), or specific section content from Wikipedia without dumping the entire page.
* **Workflow**: Use `mode='summary'` (default) to get an overview and a Table of Contents. Use `mode='section'` with a linear index from the ToC to dive into specific details.
* **Features**: Returns raw Wikitext to save tokens, handles redirects, and automatically falls back to a search result list if a page is not found.
--- ---
## Installation & Requirements ## Installation & Requirements
+1
View File
@@ -5,6 +5,7 @@ HOST = "127.0.0.1"
PORT = 8000 PORT = 8000
LOG_LEVEL = "WARNING" # Options: "DEBUG", "INFO", "WARNING", "ERROR" LOG_LEVEL = "WARNING" # Options: "DEBUG", "INFO", "WARNING", "ERROR"
LOG_FILE = "debug.log" LOG_FILE = "debug.log"
USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64; rv:151.0) Gecko/20100101 Firefox/151.0" # Stealth User-Agent to bypass Wikipedia's bot detection
# --- Model Specific Token Tuning (Tuned for Gemma 4) --- # --- Model Specific Token Tuning (Tuned for Gemma 4) ---
# Patch size is typically (clip.vision.patch_size * n_merge) # Patch size is typically (clip.vision.patch_size * n_merge)
+21
View File
@@ -22,6 +22,7 @@ from .contact_sheet import handle as contact_sheet_handler
from .list_directory import handle as list_directory_details_handler from .list_directory import handle as list_directory_details_handler
from .preview_image import handle as preview_image_handler from .preview_image import handle as preview_image_handler
from .get_text_context import handle as get_text_context_handler from .get_text_context import handle as get_text_context_handler
from .wikipedia import handle as wikipedia_handler
# Central registry of all available tools # Central registry of all available tools
TOOL_REGISTRY = [ TOOL_REGISTRY = [
@@ -103,4 +104,24 @@ TOOL_REGISTRY = [
}, },
handler=get_text_context_handler handler=get_text_context_handler
), ),
Tool(
name="browse_wikipedia",
description="Browse Wikipedia pages to retrieve information. Defaults to the page summary. Can also retrieve the table of contents or a specific section. If a page is not found, it automatically returns search results.",
schema={
"type": "object",
"properties": {
"title": {"type": "string", "description": "The title of the Wikipedia page to browse or the search query."},
"mode": {
"type": "string",
"description": "The retrieval mode. 'summary' (default) for the lead section, 'toc' for the table of contents, 'section' for a specific section, or 'search' for explicit search results.",
"enum": ["summary", "toc", "section", "search"],
"default": "summary"
},
"section_index": {"type": "integer", "description": "The linear index of the section to retrieve. Required if mode='section'. This index can be found by calling the tool in 'toc' mode."},
"search_limit": {"type": "integer", "description": "The maximum number of search results to return. Default is 5.", "default": 5},
},
"required": ["title"],
},
handler=wikipedia_handler
),
] ]
+170
View File
@@ -0,0 +1,170 @@
import urllib.request
import urllib.parse
import json
import re
import asyncio
from typing import Any, Dict, Optional
from .utils import ToolError
import config
API_URL = "https://en.wikipedia.org/w/api.php"
def strip_html(text: str) -> str:
"""Removes HTML tags from a string using regex to provide clean text to the LLM."""
return re.sub(r'<[^>]*>', '', text)
def _make_request(params: Dict[str, Any]) -> Dict[str, Any]:
"""
Synchronous helper to make the API request using urllib.
urllib is used instead of httpx to avoid TLS/HTTP fingerprinting
that triggers 403 Forbidden responses from Wikipedia.
"""
query_string = urllib.parse.urlencode(params)
url = f"{API_URL}?{query_string}"
headers = {
"User-Agent": config.USER_AGENT
}
req = urllib.request.Request(url, headers=headers)
with urllib.request.urlopen(req) as response:
return json.loads(response.read().decode('utf-8'))
async def _search(title: str, limit: int = 5, fallback: bool = False) -> str:
"""
Searches Wikipedia for a title.
fallback=True: Used when a direct page request fails, providing 'Article not found' header.
"""
params = {
"action": "query",
"list": "search",
"srsearch": title,
"format": "json",
"srlimit": limit
}
# Run synchronous urllib call in a thread to avoid blocking the event loop
data = await asyncio.to_thread(_make_request, params)
search_results = data.get("query", {}).get("search", [])
if not search_results:
return f"No Wikipedia results found for '{title}'."
if fallback:
header = f"Article not found. Here are some similar results for '{title}':"
else:
header = f"Search results for '{title}':"
lines = [header]
for i, res in enumerate(search_results, 1):
title_res = res.get("title")
snippet = strip_html(res.get("snippet", ""))
# Brackets around title help the AI identify the exact string for subsequent calls
lines.append(f"{i}. [{title_res}] - Snippet: {snippet}")
return "\n".join(lines)
async def _fetch_content(title: str, section_index: int) -> Optional[str]:
"""
Retrieves raw Wikitext for a specific section.
section_index=0 returns the lead section.
"""
params = {
"action": "query",
"prop": "revisions",
"rvprop": "content",
"rvsection": section_index,
"titles": title,
"redirects": 1,
"format": "json"
}
data = await asyncio.to_thread(_make_request, params)
pages = data.get("query", {}).get("pages", {})
if not pages:
return None
page_id = next(iter(pages))
page = pages[page_id]
if "missing" in page:
return None
revisions = page.get("revisions", [])
if not revisions:
return None
return revisions[0].get("*")
async def _fetch_toc(title: str) -> Optional[str]:
"""
Retrieves the Table of Contents data and formats it hierarchically.
"""
params = {
"action": "parse",
"page": title,
"prop": "tocdata",
"format": "json",
"redirects": 1
}
data = await asyncio.to_thread(_make_request, params)
parse_data = data.get("parse")
if not parse_data:
return None
toc_data = parse_data.get("tocdata", {})
sections = toc_data.get("sections", [])
if not sections:
return "No table of contents found for this page."
lines = [f"Table of Contents for \"{parse_data.get('title', title)}\":"]
for s in sections:
level = s.get("tocLevel", 1)
index = s.get("index")
line = s.get("line")
indent = " " * (level - 1)
lines.append(f"{indent}[{index}] {line}")
return "\n".join(lines)
async def handle(args: Dict[str, Any]) -> Dict[str, Any]:
"""
Main handler for the browse_wikipedia tool.
Supports modes: summary, toc, section, and search.
"""
title = args.get("title")
if not title:
raise ToolError("Missing required parameter: 'title'")
mode = args.get("mode", "summary")
section_index = args.get("section_index")
search_limit = args.get("search_limit", 5)
if mode == "search":
result = await _search(title, search_limit, fallback=False)
elif mode == "summary":
# Lead section + ToC is the default 'summary' to guide the AI's next steps
content = await _fetch_content(title, 0)
if content is None:
result = await _search(title, search_limit, fallback=True)
else:
toc = await _fetch_toc(title)
result = f"{content}\n\n---\n\n{toc}"
elif mode == "toc":
toc = await _fetch_toc(title)
if toc is None:
result = await _search(title, search_limit, fallback=True)
else:
result = toc
elif mode == "section":
if section_index is None:
raise ToolError("Missing required parameter 'section_index' for mode='section'")
content = await _fetch_content(title, int(section_index))
if content is None:
result = await _search(title, search_limit, fallback=True)
else:
result = content
else:
raise ToolError(f"Invalid mode '{mode}'. Supported modes: summary, toc, section, search")
return {"text": result}