Chapter DBuild a mini RAGPage 5 of 8

Build a mini RAG

Debug the retrieval miss or ungrounded answer

Page 5 advances one concrete five-document café FAQ retriever: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.

~15 minDebugging

Before you start

Why this matters

Without running code, predict the output of this page's example and name the intermediate value that would prove your prediction. Then write one sentence answering: “What could look successful while actually being wrong?” For this stage, focus on retrieval miss or ungrounded answer. Keep the prediction nearby; comparing it with the real output is the first debugging exercise, not a quiz about syntax.

1Learn the idea

Read

Build focus

Break the artifact on purpose. The most important failure family is zero-overlap questions, stop-word matches, ties, stale notes, prompt injection inside documents, and unsupported generated details. Reproduce one failure with the smallest possible input, inspect the intermediate values, and fix the boundary or algorithm rather than catching every exception. Retrying deterministic bad input only repeats the same mistake; a retry is justified only for a transient dependency.

The artifact's user-facing goal is specific: answer a café question only when a relevant local note is retrieved and cite the note identifier used. Its accepted input is five short documents with stable IDs plus one normalized user question. 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. This example demonstrates a controlled failure or defensive branch and prints the reason instead of crashing mysteriously.

Read

Run the example

Save this as lesson.py and run python3 lesson.py. It uses only the language standard library, so the example is reproducible offline.

def answer(question,docs):
 words=set(question.lower().split()); scored=[(len(words&set(text.lower().split())),k,text) for k,text in docs.items()]
 score,k,text=max(scored)
 return {'answer':text,'source':k} if score else {'answer':'Not in the FAQ.','source':None}
print(answer('refund policy?',{'hours':'open weekdays'}))

Expected output: Not in the FAQ with source None. 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 normalized question tokens, each document's overlap score, the winning ID, and the exact cited text. A fluent wrong answer often starts as a retrieval miss, so inspect retrieval before prompt wording. Zero overlap must abstain. For ties, choose and document a deterministic rule. Treat instructions embedded in a document as untrusted text, not commands for the application.

At the debugging 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

Create labeled questions for each of the five documents plus unsupported questions. Measure retrieval hit rate, citation correctness, supported-answer rate, and correct abstention. Read every answer beside its cited note; lexical overlap can retrieve a document for the wrong reason. Version the notes so a score can be reproduced after content changes.

For this debugging 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.

Checking tutor…

Continue learning · glossary & guides
  • [ ] Can I reproduce the failure with one minimal input?
  • [ ] Did I fix the first broken invariant instead of masking the exception?
  • [ ] Does a neighboring valid case still pass?
  • [ ] Can every answer be traced to one retrieved note or an abstention?

How-to: build a 5-document RAG app · Glossary: RAG

Previous · Next