Chapter DDeploy a RAG appPage 2 of 8

Deploy a RAG app

Define config pins and health-contract fields

Page 2 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.

~15 minData contract

Before you start

Why this matters

Predict which field in the production-shaped RAG deploy unit contract must reject a bad value before any model or database work runs. Name one wrong output that would still look fluent to a reviewer who only reads the final answer.

1Learn the idea

Read

Build focus

Make malformed input fail before it reaches the interesting algorithm. The accepted contract is request question, tenant auth context, and pinned model/index/config versions. This boundary matters because ready=true while index or model pin is incompatible often begins as a value that should never have been accepted. Keep transformation functions separate from scoring, retrieval, training, or generation so a test can identify which boundary changed the data.

Configuration must fail fast when pins are missing. Separate liveness (process up) from readiness (DB reachable, index version present, model adapter configured). Document the fields /ready returns.

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 data contract step: make malformed input fail before it reaches the interesting algorithm. 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.

from typing import Optional
cfg={"MODEL_ID":"answer-v3","INDEX_VERSION":"mini-v1","READY_REQUIRE_INDEX":True}
def missing(cfg): return [k for k,v in cfg.items() if v in (None,"")] 
print(missing(cfg))

Expected output: empty missing-config list. 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 rejected inputs with the violated field names. Silent coercion is how ready=true while index or model pin is incompatible later looks like a model problem. At the data contract 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

Contract tests must run offline without credentials when possible. Quality claims wait for labeled sets. For this data contract 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.

Checking tutor…

Continue learning · glossary & guides
  • [ ] Which malformed values are rejected before the algorithm?
  • [ ] Can transformation and core logic be tested separately?
  • [ ] Does the error identify the violated field or shape?
  • [ ] Is request question, tenant auth context, and pinned model/index/config versions enforced in code?

How-to: deploy RAG checklist · Cheatsheet: production RAG ship · Snippet: RAG health route

Previous · Next