Instrument the five-document café FAQ retriever

Instrumentation should explain behavior without collecting the raw material unnecessarily. For this artifact, record enough to calculate retrieval hit rate on a labeled question set, answer support rate, abstention accuracy, and citation correctness. Include version or configuration identifiers so two runs can be compared. A log line is useful only if it answers a debugging question; dumping entire inputs creates noise and may create a privacy problem.

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. The sample emits a compact metric record that a test or dashboard could aggregate.

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

tests=[{'q':'open weekdays','want':'hours'},{'q':'wifi card','want':'wifi'},{'q':'parking','want':None}]
print({'cases':len(tests),'required_hit_rate':1.0,'required_abstention':1.0})

Expected output: three declared evaluation cases. 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.

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 testing and observability 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.

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 testing and observability 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.