mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-11-12 22:20:33 +00:00
2a97ec3e58
* docs: turn README into an index and move reference detail to docs/guide The README had grown to 393 KB because every change appended its notes there. The text moves verbatim into 18 topic guides under docs/guide/; only headings are re-leveled and relative links re-pointed. The README keeps the introduction, a quick start and a guide index. Contributor test notes move to CONTRIBUTING.md. * docs: send user docs to topic guides and budget the root README The rule 'update README.md for user-facing changes' is what grew the README. Guidance now points to docs/guide/, and check_agent_guidance.py fails when the root README exceeds 16 KiB (AG003). * chore: remove unreferenced screenshots and finished plan notes pr-build/ holds two PR screenshots (3 MB) from #1986. plans/ holds the plan for the merged #4049. docs/SKILL_NAME_CONFLICT_FIX.md is a February change note. Nothing references them. * docs: route always-loaded AGENTS.md files to scoped guides * docs(agents): cut scoped guides to scope, verify, traps, decisions Each AGENTS.md keeps four kinds of content: the scope of the directory, the verification commands, traps a local test run does not show, and decisions the code cannot state. Values, field lists, function inventories, test names, issue numbers and history are deleted, because the code, the tests and git state them. Search and fetch providers share one community guide. Four guides with no remaining content are removed. The size check now allows 6 KiB per file (hard limit 8 KiB) and 24 KiB per chain (hard limit 32 KiB). * style: format frontend guide table and guidance test imports --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
1.2 KiB
1.2 KiB
LightRAG retrieval example
HTTP calls, connection bindings and response mapping stay in this package. It
uses the core contextual tool dispatcher and the unchanged source envelope. Live
results and their limits are in VALIDATION.md.
cd backend && python -m pytest tests -q -k "lightrag"
Responses in these tests are synthetic. The opt-in live checks need fixtures
that are already indexed, and the model loop needs KNOWLEDGE_RUN_MODEL_TEST=1.
A live test never uploads data and never enables API usage on its own.
- An entity or edge summary is not a document excerpt. Join
source_idto a returnedchunk_idonly. Do not infer edges or multi-hop paths, and do not usefile_pathalone as evidence. - Reject a selected scope, a missing binding, an HTTP error and a redirect. Do not retry with broader credentials.
- A shared evidence chunk is emitted once, before the first edge that refers to it. Every edge names the result positions of its evidence, so truncating the tail cannot leave an edge that points to omitted evidence.
- At the hit limit, tell omitted evidence apart from evidence that was not retrieved.
- Build the SSL client off the event loop.