Reference

Looked things up in, not read start to finish. Descriptive rather than instructive: what a setting does, what an error means, what a list contains. Nothing here explains why, and nothing instructs — see Explanation for why, and Guides for how.

• Supported sanctions lists — every list this gem reads, one uniform block each: jurisdiction, authority, endpoint, format, record count, known data limitations, licence and attribution.
• Configuration — every setting Configuration accepts, its type, its default, and one line on effect.
• Error hierarchy — every error class, its parent, when it is raised, whether it is retryable, and the structured attributes it carries.
• Accuracy — precision, recall and F1 against the labeled set, by threshold, by source, by variation.
• Performance characteristics — what determines index build time, screening latency, and rescreening cost, and what to run to measure your own.
• Bundle format — the container shape, the header fields, and the four failure modes, pointing to the full specification.
• Adapter contract — Sources::Base, the Definition DSL, and the registry: every declaration and hook, its signature and required return.
• Instrumentation events — the six events this library emits, every payload key on each, and what a subscriber is.

What ships with the code instead of living only here

Two documents stay inside the gem, under docs/, because they ship with the code and are read by people who cannot reach this site — an offline implementer, or a contributor mid-release:

• docs/bundle_format.md — the full, byte-level bundle specification. Bundle format is the field reference over it.
• docs/api_stability.md — the enumerated public API surface, versioning, and the deprecation path.

Generated from the source

Every class, method and attribute this library ships as public API is rendered from its own signatures and comments under /api/. The pages above link into it rather than restating a signature; /api/ is where the signature itself lives.

Nothing here is typed by hand

Every default on Configuration, every class on the error hierarchy, every figure on Accuracy, and every field on Supported sanctions lists is generated from the code or from a committed benchmark report, not retyped onto a page — see each page’s own note on where its numbers come from.