Multimodal API lab
Instrument image-token cost and error classes
Page 6 advances one concrete typed receipt-vision API: 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 which three fields must appear in one log or metric event to compare two versions of the typed receipt-vision API. What raw payload should never be logged at info level?
1Learn the idea
Read
Build focus
Instrumentation should explain behavior without collecting raw material unnecessarily. For this artifact, record enough to calculate or monitor field exact-match on clear fixtures, high abstention precision on blurred fixtures, schema validity 100%. Include version or configuration identifiers so two runs can be compared. A log line is useful only if it answers a debugging question.
Log request_id, mime, byte size, model, status, latency, and image-token estimates—not raw customer images.
The artifact's user-facing goal is specific: return a typed answer with confidence and evidence location, or abstain when pixels are unreadable. Its accepted input is authenticated upload bytes plus a question string, after MIME and size validation. 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 upload boundary checks authentication, MIME signature, dimensions, and byte limits; an image worker strips metadata and resizes safely; a provider adapter sends text and image parts; a schema validator rejects malformed or overconfident output. 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 testing and observability step: instrumentation should explain behavior without collecting raw material unnecessarily. 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 pillow pydantic httpx
export MAX_IMAGE_BYTES=5000000
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 overconfident misread of a blurred total. 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 field exact-match on clear fixtures, high abstention precision on blurred fixtures, schema validity 100% and a rehearsed recovery path exist beside FastAPI /analyze endpoint with normalization, schema validation, and model pin.
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.
event={"request_id":"v9","mime":"image/jpeg","bytes":180000,"model":"vision-v2","status":"ok","ms":1400,"image_tokens":1100}
print(event)
Expected output: event with image_tokens. 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
Compare two events from different versions on the same fixture. Divergent IDs or statuses need an eval note before traffic moves. At the testing and observability 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
Dashboards or reports should slice by version pins. Alerts should fire on safety failures immediately. For this testing and observability 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 field exact-match on clear fixtures, high abstention precision on blurred fixtures, schema validity 100%.
Continue learning · glossary & guides
- [ ] Can an event distinguish configuration, failure class, and duration?
- [ ] Did I avoid logging secrets or unnecessary raw input?
- [ ] Can two runs be compared with the recorded fields?
- [ ] Would these events diagnose overconfident misread of a blurred total?
Glossary: multimodal · Snippet: vision message · How-to: call a vision API · Cheatsheet: image prompt card