Page 2 of 8~136 min topic

Capstone: research bot with citations

Define claim, evidence, and abstention schemas

Types and env contracts make **citation-first research assistant that maps every claim to evidence IDs** fail closed before any provider or cluster call.

~17 min this pageData contract

1Learn the idea

Read

Define trusted borders

Implement types or schemas around POST /v1/research/brief so illegal states are unrepresentable at the boundary. For citation-first research assistant that maps every claim to evidence IDs, trusted inputs come from sessions, signatures, pinned digests, or workload identity — not from free-form model text. analyst compiling a brief on bike-share policy from a fixed corpus should be able to read the contract and know which fields are optional, which are enumerated, and which abort the request. Constructors and boot paths must not perform provider side effects; injection points keep tests honest.

Read

Environment and secrets contract

Document required env vars in .env.example with placeholders only. Rotation story belongs later, but the contract already forbids printing secrets and forbids defaulting to fail-open when a dependency is missing. Invariant to encode in types/tests: claim without evidence → abstain or drop claim; no orphan sentences. If a config number lacks units, fix the name (timeout_ms, rpm_hard) before writing logic.

Read

Implementation artifact

class Claim(BaseModel):
    text: str
    evidence_ids: list[str]

Read

Fixture kit

Create fixtures for the golden path and for CAP-RESEARCH-FAKE-ID-3. Name files after the behavior (429-retry-after.json, cross-tenant.json, empty-citation.json) rather than test1. Each fixture carries expected status/code. This kit is the shared language for validation and failure pages.

Read

Stage depth

Compatibility promise: additive fields may appear only if readers ignore unknowns safely; breaking changes bump a version visible on the wire. For AI payloads, size limits arrive before JSON parse when hostile blobs are a risk. Document how clock skew, idempotency keys, and tracing headers travel through citation-first research assistant that maps every claim to evidence IDs. If you use feature flags later, the contract already states that flags are not authorization. Link each config knob to a unit and a failure mode (“0 means disabled” vs “0 means divide-by-zero”). A peer reviewing the PR should find CAP-RESEARCH-FAKE-ID-3 named in a comment on the adversarial fixture.

Read

Field notes for `capstone-research-bot` / `setup-and-contract`

Generate OpenAPI or a typed client only after the hand schema is stable for one fixture round-trip. Record how errors look on the wire — problem+json, envelope, or bare status — and stick to one. Clock sources must be injectable for skew tests. If webhooks appear later, document signature header names now even as TODOs. Keep sample payloads UTF-8 and free of real emails. Add a makefile or npm script that validates schemas without network. In this chapter the product is citation-first research assistant that maps every claim to evidence IDs, the human stakeholder is analyst compiling a brief on bike-share policy from a fixed corpus, and the incident id you design against is CAP-RESEARCH-FAKE-ID-3. Re-state the oracle in your notes — brief on fixture corpus: ≥ 0.95 claims cited; fabricated ID rate 0 — and keep the invariant visible: claim without evidence → abstain or drop claim; no orphan sentences. Track claim_citation_coverage and fabricated_id_rate as the scoreboard. Surface under change control: POST /v1/research/brief. If you only have forty minutes, finish the fixture for model invents kb://minutes-2099 citation before polishing UI. Promotion language stays ternary: promote, hold, or roll back based on evidence, not hope.

Go deeper

Before you start

Why this matters

For Capstone: research bot with citations, sketch the request and response shapes that cross POST /v1/research/brief without naming a framework. Mark which fields are trusted (session, signatures, digests) versus untrusted (user text, model JSON, webhook bodies). If a field can change authorization, it does not belong in model output. Predict one 422/401 you will assert before coding adapters for citation-first research assistant that maps every claim to evidence IDs.

Contracts you freeze now carry through the capstone demo of citation-first research assistant that maps every claim to evidence IDs.

In the wild

See how this idea shows up as a product and a company — then come back to the lesson. Skills transfer across vendors.

Check your understanding

Page assessment

Answer from memory. Completion is saved from this evidence, not from opening the next page.

1. Can a newcomer list trusted vs untrusted fields?
2. Does boot avoid external side effects?
3. Are fixtures named after CAP-RESEARCH-FAKE-ID-3-class failures?

All responses are required.