Per-field confidence
Every field in theextract object carries two signals:
| Field | Type | Description |
|---|---|---|
confidence | float 0–1 | Model’s confidence that the extracted value is correct. 1.0 = certain, 0.0 = no confidence. |
found | boolean | true if the field was located in the document; false if it was absent or not detectable. |
found is false, value is null and confidence is 0.0.
Human-review threshold
Thehuman_review_threshold parameter (0–1) sets the minimum per-field confidence required to pass without flagging for review. Any field whose confidence falls below this threshold causes the document’s review_status to be set to needs_review.
- Default server-side threshold:
0.85 - Per-request override: pass
human_review_thresholdas a form field inPOST /v1/documents.
1.0 forces every document into needs_review. A threshold of 0.0 disables per-field confidence gating (documents can still be flagged for other reasons).
review_status
| Value | Meaning |
|---|---|
auto | All fields met the confidence threshold; no human review required. |
needs_review | One or more fields fell below the threshold, or a validation flag was raised. A human should verify before acting on the result. |
review_status is set once when the document reaches a terminal state and does not change.
Flags
Theflags array lists all reasons that contributed to needs_review. Flags are strings:
| Flag | Trigger |
|---|---|
low_confidence_field:<name> | The named field’s confidence is below human_review_threshold. |
low_confidence_classification | The document-type classifier’s confidence (document_type_confidence) is low. |
missing_field:<key> | A field marked required in the extraction schema was not found. |
invalid_field:<key> | A field’s extracted value failed the pattern or type check in the schema. |
Routing needs_review documents
A typical HITL workflow:
Surface flagged fields to the reviewer
Parse the Use
flags array to highlight only the fields that need attention, rather than asking the reviewer to check everything.bbox coordinates to draw overlays on the document image so the reviewer can locate the field at a glance.document_type_confidence
In addition to per-field confidence, the result includes a top-level document_type_confidence (0–1) indicating how confident the classifier was about the detected document type. When this is low, the low_confidence_classification flag is raised, and review_status becomes needs_review even if all field confidences are high.