Bring your own data

Prepare a small first experiment

Hold the reset button for eight seconds. Use USB-C power.

ragvi bm25 ./manual.txt --query "How do I reset the device?"

The default export is a self-contained HTML report in a unique directory under ragvi-reports/. Original input files stay unchanged. --output DIRECTORY selects another root; --open explicitly opens the HTML in a browser.

Add your questions

How do I reset the device?
What power does it require?

ragvi bm25 ./docs --questions ./questions.txt --format html --format json
ragvi compare-data ./docs --questions ./questions.txt --techniques bm25,parent-child

TXT uses one question per nonblank line. JSON accepts an array of strings or question objects; JSONL uses one object per line. IDs must be unique; portable question objects accept only question_id and question.

{"question_id":"Q1","question":"How do I reset the device?"}

Inspect without questions

ragvi bm25 ./manual.txt --no-input

Without questions, an interactive terminal offers question entry. Empty entry selects source inspection. --no-input disables prompts; redirected input never blocks. --interactive offers output-format selection on a terminal. Explicit --format flags work without prompts.

Download the synthetic worked example

• Device manual
• Question file
• Reviewed original spans
• Actual generated comparison

Save manual.md inside docs/, with questions.txt and reviewed.json beside that folder. The reviewed file binds to the exact original text and its corpus hash. Keep the downloaded manual’s UTF-8 bytes unchanged.

ragvi compare-data ./docs --reviewed ./reviewed.json --techniques bm25,parent-child,compress --k 1 --chunk-size 100 --chunk-overlap 10 --format html --format json --format markdown