First tutorial
An optional fictional example of reviewed body versus heading-context retrieval.
v0.2.1Local CLI · Offline reports
On this page
Run it
Terminal
ragvi tutorialCreates workspaces/first-run and writes workspaces/first-run/reports/tutorial.html. The command refuses to overwrite an existing workspace. Use ragvi tutorial --name first-run-2 to repeat.
Expected result
The bundled fictional English exercise compares BM25 body and authentic heading-context representations at k=2. It teaches mechanics; it is not a benchmark for your corpus.
| Run | Sufficient | Rate |
|---|---|---|
| bm25-body | 6 / 10 | 60% |
| bm25-heading_context | 9 / 10 | 90% |
Inspect the evidence
- Check the fixed k and representation.
- Open changed question details and compare ranked source units.
- Check all required evidence, including conditions and exceptions.
- Read the limitation beside the diagnosis.
Was something unclear? Send documentation feedback.