Chapter DRAG quality auditPage 2 of 8

RAG quality audit

Define the JSONL case schema and scoring contract

Page 2 advances one concrete RAG golden-question release gate: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.

~14 minData contract

Before you start

Why this matters

Predict which field in the RAG golden-question release gate contract must reject a bad value before any model or database work runs. Name one wrong output that would still look fluent to a reviewer who only reads the final answer.

1Learn the idea

Read

Build focus

Make malformed input fail before it reaches the interesting algorithm. The accepted contract is JSONL rows with question, expected_chunk_ids, and optional forbidden claims. This boundary matters because retrieval miss mislabeled as model hallucination often begins as a value that should never have been accepted. Keep transformation functions separate from scoring, retrieval, training, or generation so a test can identify which boundary changed the data.

Each JSONL case needs a stable id, question, expected_chunk_ids, and optional forbidden claims. Schema validation belongs in CI. Without expected IDs you cannot separate “model worded it differently” from “wrong note retrieved.”

The artifact's user-facing goal is specific: block a release when expected evidence or citations regress on a fixed suite. Its accepted input is JSONL rows with question, expected_chunk_ids, and optional forbidden claims. Those statements are intentionally narrower than “build an AI system.” Narrow scope lets us inspect every input and expected result, and it prevents a toy result from being presented as a production claim. System shape for this chapter: a versioned JSONL dataset feeds the same retriever and answer service used in production; deterministic retrieval metrics run first, an evidence-support check runs second, and a report separates retrieval misses from generation failures. Keep model calls behind adapters, keep authorization and validation in deterministic code, and carry stable IDs and versions through every response. That separation lets you decide whether a bad result came from input handling, retrieval, inference, validation, or deployment. This page's job is the data contract step: make malformed input fail before it reaches the interesting algorithm. Setup baseline for the chapter (run once per machine, not secrets in git):

python -m venv .venv && source .venv/bin/activate
pip install pytest
mkdir -p evals/gold reports

If hardware or a hosted provider differs, preserve the interface and expected behavior. Do not present provider syntax as universal—when a vendor adapter is unavoidable, keep it behind a thin boundary and test with a fake first. The deliverable is not “it ran once”; it is a reproducible artifact another developer can inspect, including expected output and one deliberate failure related to retrieval miss mislabeled as model hallucination. Operationally, write down the owner of this stage, the command you ran, the observed output, and the next page's dependency on that output. If you cannot point to a file, fixture, metric, or config key, the stage is not done. Prefer small, reviewable increments: one contract, one path, one metric, one failure, one gate. When tradeoffs appear—latency versus quality, hit rate versus false hits, local privacy versus cloud quality—record both numbers instead of moving the threshold until the report looks green. The chapter ships only when evidence for recall@5, citation validity, and faithfulness above agreed thresholds on the suite and a rehearsed recovery path exist beside CI eval gate with versioned dataset and HTML/JSON report artifacts.

Read

Run the example

Save this as lesson.py and run python3 lesson.py. Prefer the standard library or the pinned packages from the setup block so the example stays reproducible.

import json
case={"id":"q1","question":"What does ERR-502 mean?","expected_chunk_ids":["runbook-7"],"forbid":["delete production"]}
print(json.dumps(case, sort_keys=True))

Expected output: canonical JSON case with expected_chunk_ids. Exact floating-point formatting may vary slightly, but the asserted behavior must not. Read the output as evidence about this stage, not merely proof that the interpreter started.

Read

Debug the stage

Print rejected inputs with the violated field names. Silent coercion is how retrieval miss mislabeled as model hallucination later looks like a model problem. At the data contract stage, save the smallest failing fixture beside the expected result. Change one cause at a time and rerun the exact command printed above; that makes the repair reviewable and keeps this chapter's progressive artifact reproducible.

Read

Evaluate before continuing

Contract tests must run offline without credentials when possible. Quality claims wait for labeled sets. For this data contract page, preserve the fixture and result as evidence for the next page. Label observations separately from conclusions: a passing assertion establishes the behavior it names, while broader usefulness requires the chapter's full evaluation set and stated operating limits. Primary metrics for the chapter remain recall@5, citation validity, and faithfulness above agreed thresholds on the suite.

Checking tutor…

Continue learning · glossary & guides
  • [ ] Which malformed values are rejected before the algorithm?
  • [ ] Can transformation and core logic be tested separately?
  • [ ] Does the error identify the violated field or shape?
  • [ ] Is JSONL rows with question, expected_chunk_ids, and optional forbidden claims enforced in code?

Glossary: faithfulness · Glossary: recall@k · Cheatsheet: RAG quality · How-to: evaluate RAG quality

Previous · Next