Vector DB integration lab
Ship and explain the reversible vector index rollout
Page 8 advances one concrete versioned pgvector support-runbook index: explain the decision, run the code, inspect failure, measure evidence, and keep only what is ready to ship.
Before you start
Why this matters
Predict the rollback switch for the versioned pgvector support-runbook index and what would make that rollback incomplete even if the process restarts cleanly.
1Learn the idea
Read
Build focus
The final artifact is pgvector index mini-v1/mini-v2 with HNSW after bulk load and env-based version switch. A reviewer should be able to reproduce the demo from one command, see the expected result, run the checks, and find the known limitations. Shipping means the intended case is measurable, failures are legible, and the previous working artifact remains recoverable.
Ship as a unit: application commit, embedding model pin, and index_version. Build mini-v2 beside mini-v1, evaluate both, switch with RAG_INDEX_VERSION, and rehearse rollback. Readiness must fail if the active version is missing.
The artifact's user-facing goal is specific: return five tenant-scoped chunks for a support question without changing the answer API. Its accepted input is chunk IDs, tenant_id, body text, embedding model id, and index_version. 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: an ingestion worker chunks documents, an embedding adapter creates fixed-size vectors, PostgreSQL with pgvector stores vectors plus tenant metadata, and a query service embeds one question, applies an authorization filter, and returns five chunks to the answer layer. 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 mastery and shipping step: the final artifact is pgvector index mini-v1/mini-v2 with hnsw after bulk load and env-based version switch. Setup baseline for the chapter (run once per machine, not secrets in git):
docker run --name rag-pg -e POSTGRES_PASSWORD=rag -p 5432:5432 -d pgvector/pgvector:pg16
python -m venv .venv && source .venv/bin/activate
pip install psycopg[binary] pgvector sentence-transformers
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 dimension mismatch or cross-tenant retrieval. 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 recall@5 ≥ 0.90, zero cross-tenant hits, and p95 query latency under 150 ms and a rehearsed recovery path exist beside pgvector index mini-v1/mini-v2 with HNSW after bulk load and env-based version 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.
release={"active":"mini-v2","rollback":"export RAG_INDEX_VERSION=mini-v1","recall_at_5":0.92,"ready_checks":["db","index_version","embedding_model"]}
assert release["recall_at_5"]>=0.90
print(release)
Expected output: release record with rollback command. 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
Rehearse rollback and readiness. If app code rolls back but model/index/adapter pins do not, the release unit was incomplete. At the mastery and shipping 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
Ship only when checks, evidence, and rollback rehearsal are green on the same pins. For this mastery and shipping 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 recall@5 ≥ 0.90, zero cross-tenant hits, and p95 query latency under 150 ms.
Continue learning · glossary & guides
- [ ] Can a second person run the demo without coaching?
- [ ] Are expected output, evaluation evidence, and limitations visible?
- [ ] Has the failure and recovery path been rehearsed?
- [ ] Is the shipped unit exactly: pgvector index mini-v1/mini-v2 with HNSW after bulk load and env-based version switch?
Glossary: vector database · Glossary: vector index · Cheatsheet: RAG quality