Spaces:
Running
Running
| # search_engine.py DOX | |
| ## Purpose | |
| - Own the `search_engine.py` agent tool. | |
| - This module runs web search through the configured search helper. | |
| - Keep this file-level DOX profile synchronized with `search_engine.py` because this directory is intentionally flat. | |
| ## Ownership | |
| - `search_engine.py` owns the runtime implementation. | |
| - `search_engine.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. | |
| - Classes: | |
| - `SearchEngine` (`Tool`) | |
| - `async execute(self, query=..., **kwargs)` | |
| - `async searxng_search(self, question)` | |
| - `format_result_searxng(self, result, source)` | |
| - Notable constants/configuration names: `SEARCH_ENGINE_RESULTS`. | |
| ## Runtime Contracts | |
| - Tool modules must define `helpers.tool.Tool` subclasses and return `helpers.tool.Response` from `execute(...)`. | |
| - Update this file whenever tool arguments, output shape, `break_loop` behavior, intervention handling, prompt instructions, or side effects change. | |
| - `SearchEngine` is a `Tool`. | |
| - `SearchEngine` defines `execute(...)`. | |
| - Imported dependency areas include: `asyncio`, `helpers`, `helpers.errors`, `helpers.print_style`, `helpers.searxng`, `helpers.tool`, `os`. | |
| ## Key Concepts | |
| - Important called helpers/classes observed in the source: `Response`, `self.format_result_searxng`, `join.strip`, `self.searxng_search`, `self.agent.handle_intervention`, `searxng`, `handle_error`, `join`. | |
| - Keep request/response, tool, or helper semantics documented here at the same time as source changes. | |
| ## Work Guidance | |
| - Keep tool output concise, model-readable, and safe for history persistence. | |
| - Coordinate argument or behavior changes with prompt tool instructions and skill guidance. | |
| - Respect intervention flow for long-running, external, or user-visible operations. | |
| ## Verification | |
| - Run targeted tool and prompt-contract tests for changed behavior; smoke-test agent execution when no focused test exists. | |
| - No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check. | |
| ## Child DOX Index | |
| No child DOX files. | |
| Search unavailability is returned as structured JSON with reason, backend, | |
| fallback status and empty results, preserving the ordinary non-breaking tool | |
| response. Successful results retain titles, URLs and snippets. | |