Skip to content

RAGVIDENCE / Documentation

CLI v0.2.1
Browse documentation
Docs/Start here

Read your first report

Read status, context, evidence and limitations before drawing a conclusion.

v0.2.1Local CLI · Offline reports
Download .md

Check status and configuration

StateMeaning
ingestion_onlyNo questions; retrieval was not executed.
retrieval_inspectionActual retrieval; relevance and quality are unscored.
reviewed_evaluationReviewed original-span evidence was validated and scored.

Confirm loaded/skipped files, failed extraction, question counts, k, chunking, models and context budgets. Low lexical scores are observations, not probabilities or command failures.

Prioritize changed questions

ClassInterpretation
fail → passAll required evidence became available.
pass → failRequired evidence was lost: investigate the regression.
pass → passBoth contexts are sufficient; ranks/resources may differ.
fail → failThe gap remains; inspect partial gains and missing spans.

Inspect the actual context

Read original source locations, exact returned text and stage traces. A parent can restore missing qualifications while increasing context size. Compression can drop a necessary condition. A valid model output can still be unhelpful.

Treat diagnosis as a hypothesis

An observed change does not prove a universal cause. Use a relevant next experiment and reserve separate heldout data before making a decision.

Was something unclear? Send documentation feedback.