Page 2 of 8~112 min topic

Re-ranking lab

Define candidate fusion and score contracts

Types and env contracts make **hybrid BM25+vector retrieve then cross-encoder rerank for error-code FAQs** fail closed before any provider or cluster call.

~14 min this pageData contract

1Learn the idea

Read

Define trusted borders

Implement types or schemas around POST /v1/search/rerank so illegal states are unrepresentable at the boundary. For hybrid BM25+vector retrieve then cross-encoder rerank for error-code FAQs, trusted inputs come from sessions, signatures, pinned digests, or workload identity — not from free-form model text. support agent asking about E_CONN_RESET wording variants 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: top-1 after rerank must beat BM25-only nDCG@5 on gold; latency budget ≤ 120ms for rerank. If a config number lacks units, fix the name (timeout_ms, rpm_hard) before writing logic.

Read

Implementation artifact

class Candidate(BaseModel):
    doc_id: str
    text: str
    retrieve_score: float

Read

Fixture kit

Create fixtures for the golden path and for RERANK-FLAT-55. 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 hybrid BM25+vector retrieve then cross-encoder rerank for error-code FAQs. 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 RERANK-FLAT-55 named in a comment on the adversarial fixture.

Read

Field notes for `re-ranking-lab` / `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 hybrid BM25+vector retrieve then cross-encoder rerank for error-code FAQs, the human stakeholder is support agent asking about E_CONN_RESET wording variants, and the incident id you design against is RERANK-FLAT-55. Re-state the oracle in your notes — query 'connection reset while uploading' ranks doc:e-conn-reset #1 after rerank — and keep the invariant visible: top-1 after rerank must beat BM25-only nDCG@5 on gold; latency budget ≤ 120ms for rerank. Track nDCG@5 and rerank_ms p95 as the scoreboard. Surface under change control: POST /v1/search/rerank. If you only have forty minutes, finish the fixture for reranker scores all candidates near 0.5 — order equals retrieve order 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 Re-ranking lab, sketch the request and response shapes that cross POST /v1/search/rerank 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 hybrid BM25+vector retrieve then cross-encoder rerank for error-code FAQs.

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 RERANK-FLAT-55-class failures?

All responses are required.