Recipe 08: FAQ selection #8

Recipe 08 of 60 · Level 1 (Beginner) · Search & retrieval · Choice

Use case

Select the best matching FAQ from a short candidate list, including a no-match outcome when none addresses the question.

What to build

The folder recipes/08-faq-selection/ with notebook.ipynb, README.md, and fixtures/, meeting the recipe contract. Start from python tools/new_recipe.py 08 and the template in recipes/_template/.

Build notes

• Options are FAQ identifiers from a short candidate list plus no_match.
• Python returns the stored FAQ answer by identifier. The model never writes the answer.
• Fixtures must include questions that no FAQ addresses and questions that two FAQs nearly address.

Decision design

• Choice. Options are a fixed set supplied by Python, including the fallback outcome this use case names. Show the choice, the per-option probabilities, and the confidence for individual examples before aggregating.

Level 1 scope

One bounded judgment over a short prepared input with direct inspection of typed results.

Acceptance criteria

• recipes/08-faq-selection/notebook.ipynb runs top to bottom offline, with no key and no network, and its outputs are committed
• Live mode is opt-in (JEV_COOKBOOK_LIVE=1 with TYPESAFE_API_KEY) and uses the same question definitions as the offline run
• Fixtures are synthetic, include the hard cases named in the build notes, carry gold labels, and pass the fixture validator
• Every response fixture records its provenance, and the notebook states which mode it ran in
• Evaluation: Top-1 accuracy, and precision and recall of the no_match outcome.
• A reader with basic Python can follow it end to end; every new term is explained where it first appears
• At least three individual typed answers are displayed and discussed before any aggregate metric
• No statement about Jev's quality, latency, or cost appears without recorded live inference; in a synthetic run, metrics are labelled as pipeline checks
• recipes/08-faq-selection/README.md says what the recipe teaches, how to run it, and what was and was not measured live
• The pull request changes only recipes/08-faq-selection/ and CI is green

Dependencies

• Blocked by Foundation: CI executes every notebook offline and validates fixtures #69 (CI executes every notebook offline and validates fixtures)
• Tracked in Epic: Level 1 · Beginner recipes #75

Sources

Read these before writing the questions.

• S02 · TypeSafe AI: Primitives (Questions): Choice, Noul, Score, independent questions, and dependent follow-up calls.
• S03 · TypeSafe AI: Confidence: Distribution-derived confidence and task-specific thresholds informed by observed outcomes.
• S04 · TypeSafe AI: How to build with TypeSafe: Narrow semantic judgments integrated with workflows, deterministic logic, and side effects controlled by code.
• S06 · TypeSafe AI: Cookbooks: Worked patterns for extraction, citation checking, skill selection, hierarchical classification, and feature discovery.

Out of scope

• Changes to shared code, the catalog, or the root README. If the shared package is missing something, open a foundation issue and link it here.
• Real side effects of any kind. Actions are simulated.