Deploy a RAG app
Frame the production-shaped RAG deploy experiment
Page 1 advances one concrete production-shaped RAG deploy unit: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.
1Try it yourself
Playground
Deploy RAG checklist
Check each ship gate before sending customer traffic to your RAG app.
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 ready=true while index or model pin is incompatible. Keep the prediction nearby; comparing it with the real output is the first debugging exercise, not a quiz about syntax.
2Learn the idea
Read
Build focus
A lab needs a falsifiable claim before code. The claim here is that you can serve /ask only when dependencies and version pins match a tested release unit. Record the tiny dataset, expected behavior, and one reason the result could be misleading. The first artifact is an experiment brief, not a screenshot. It names the user decision, the baseline you must beat, and the non-goals you will not pretend to solve on this page.
Deploying RAG is not “docker run the demo.” The release unit includes application code, prompt/config version, model ID, and index version. If readiness ignores pins, users can hit a new app against an old embedding space.
The artifact's user-facing goal is specific: serve /ask only when dependencies and version pins match a tested release unit. Its accepted input is request question, tenant auth context, and pinned model/index/config versions. 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 stateless FastAPI service validates requests, queries a separately managed vector index, calls an answer model through an adapter, and emits citations; liveness checks the process while readiness checks dependencies and exact model/index pins. 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 experiment brief step: a lab needs a falsifiable claim before code. Setup baseline for the chapter (run once per machine, not secrets in git):
python -m venv .venv && source .venv/bin/activate
pip install fastapi uvicorn pydantic httpx
export MODEL_ID=answer-v3 INDEX_VERSION=mini-v1
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 ready=true while index or model pin is incompatible. 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 smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes and a rehearsed recovery path exist beside containerized FastAPI RAG service with /healthz, /ready, and canary switch.
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.
unit={"app":"rag-api@sha-1","model_id":"answer-v3","index_version":"mini-v1","smoke":["What does ERR-502 mean?"]}
print(unit)
Expected output: release unit dict with model and index pins. 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 the planned interfaces and the one fixture that would falsify the brief. If tenant, version, timeout, or refusal behavior is missing from the brief, stop before installing packages. At the experiment brief 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
Preserve the acceptance brief beside the fixture. Connecting tools is not the same as meeting smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes. For this experiment brief 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 smoke golden pass rate 100%, readiness true only when pins match, rollback under five minutes.
Continue learning · glossary & guides
- [ ] What exact claim can this tiny fixture disprove?
- [ ] Which baseline prevents a decorative success claim?
- [ ] What result would make me stop before implementation?
- [ ] Can I explain how serve /ask only when dependencies and version pins match a tested release unit?
How-to: deploy RAG checklist · Cheatsheet: production RAG ship · Snippet: RAG health route