Tutorial-first API docs · document extraction

Sift API

Documentation for an extraction API that returns confidence scores instead of certainties. Where the Ledger API is reference-first for a reader who knows what they want, this is tutorial-first for a reader who does not yet know what the system can and cannot promise.

What to look at
  • The quickstart's second example comes back wrong, on purpose, while the reader is still deciding how much to rely on the output.
  • Turns confidence scores into a routing decision, because a number the reader cannot act on is decoration.
  • Separates the three failure classes that look identical in the response body: the document was bad, the extraction was wrong, and the request was wrong.
  • One narrow reference page sits beside the tutorial, to show the register shift from teaching voice to contract voice inside one product.

Diátaxis · RFC 9457 · RFC 3339

The documents
Case studyRead how this sample was written
← Back to Portfolio