Page 2 of 8~112 min topic

Batch API lab

Set up interfaces and contracts

Types and env contracts make **overnight batch job that grades 50k support transcripts via provider Batch API** fail closed before any provider or cluster call.

~14 min this pageSetup

1Learn the idea

Read

Define trusted borders

Implement types or schemas around POST /v1/batches so illegal states are unrepresentable at the boundary. For overnight batch job that grades 50k support transcripts via provider Batch API, trusted inputs come from sessions, signatures, pinned digests, or workload identity — not from free-form model text. QA lead who needs cost-capped offline eval by 07:00 UTC 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: each input line has a stable custom_id; failed lines never poison the whole file. If a config number lacks units, fix the name (timeout_ms, rpm_hard) before writing logic.

Read

Implementation artifact

from pydantic import BaseModel, Field
class BatchLine(BaseModel):
    custom_id: str = Field(pattern=r"^[a-z0-9_\-]{3,64}$")
    method: str = "POST"
    url: str = "/v1/chat/completions"
    body: dict

Read

Fixture kit

Create fixtures for the golden path and for BATCH-DUP-8841. 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 overnight batch job that grades 50k support transcripts via provider Batch API. 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 BATCH-DUP-8841 named in a comment on the adversarial fixture.

Read

Field notes for `batch-api-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 overnight batch job that grades 50k support transcripts via provider Batch API, the human stakeholder is QA lead who needs cost-capped offline eval by 07:00 UTC, and the incident id you design against is BATCH-DUP-8841. Re-state the oracle in your notes — fixture of 20 lines yields 18 succeeded + 2 failed with error objects; cost ≤ $0.40 — and keep the invariant visible: each input line has a stable custom_id; failed lines never poison the whole file. Track batch_line_success_ratio ≥ 0.90 and dollars_per_1k_lines ≤ 8 as the scoreboard. Surface under change control: POST /v1/batches. If you only have forty minutes, finish the fixture for duplicate custom_id causes silent overwrite of the better grade 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 Batch API lab, sketch the request and response shapes that cross POST /v1/batches 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 overnight batch job that grades 50k support transcripts via provider Batch API.

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 BATCH-DUP-8841-class failures?

All responses are required.