{
 "schema_version": 1,
 "generated": "2026-11-09",
 "id": "hkuds-deeptutor--score-your-knowledge-base-retrieval",
 "repo": "HKUDS/DeepTutor",
 "repo_url": "https://github.com/HKUDS/DeepTutor",
 "repo_slug": "hkuds-deeptutor",
 "title": "Score which retrieval setup works best on your knowledge base",
 "page_title": "How to score which retrieval setup works best on your knowledge base with Deep Tutor",
 "summary": "Write a small QA set and run deeptutor kb eval to get Recall, Precision, nDCG and MRR.",
 "who": "A teacher or researcher deciding how to index course material in Deep Tutor.",
 "problem": "It is unclear which retrieval engine or mode actually finds the right passages for your documents.",
 "outcome": "Saved metric reports you can compare per metric and per case.",
 "steps": [
  "Write a QA set as JSON lines, each with a query and the gold passages an ideal retrieval should return",
  "Run `deeptutor kb eval <name> --dataset qa.jsonl --top-k 5 [--mode hybrid] [--save baseline.json]`",
  "Change the engine or mode and save a second report",
  "Compare them with `deeptutor kb eval-diff baseline.json candidate.json`"
 ],
 "agent_prompt": "For my DeepTutor knowledge base <name>, write 10 QA cases from these documents as qa.jsonl, run `deeptutor kb eval` with --top-k 5 and --save baseline.json, and summarize Recall@k and MRR.",
 "agents": [
  "claude-code",
  "codex"
 ],
 "difficulty": "Advanced",
 "time": "45 minutes",
 "basis": "readme",
 "caveat": "Matching uses exact text or lexical overlap; semantic equivalence is not assessed, and PageIndex is excluded.",
 "category": "Research",
 "tags": [
  "Research"
 ],
 "lang": "python",
 "requirements": [
  "Docker, or Python 3.11 to 3.14 with Node.js 20.9+ for the PyPI web app",
  "An LLM provider and model configured in Settings, Providers",
  "Optional embedding and search providers for knowledge bases"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": false,
 "score": 0.8,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/hkuds-deeptutor/score-your-knowledge-base-retrieval/",
 "md": "https://dedupedai.com/use-cases/hkuds-deeptutor/score-your-knowledge-base-retrieval/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/hkuds-deeptutor--score-your-knowledge-base-retrieval.json",
 "api_version": "v1"
}
