Skip to main content

Quality Entries

List, add, import, or delete entries in a ground truth dataset. Entries represent individual verified data points used for benchmarking extraction accuracy.

Entries are the individual verified data points within a ground truth dataset. Add them manually, or import in bulk via CSV.

GET/v1/quality/ground-truth/:datasetId/entries

Response (List entries)

Response fields

dataarrayArray of entry objects.
data[].idstringEntry UUID.
data[].document_idstringDocument this entry corresponds to.
data[].expected_dataobjectKey-value map of verified field values.
data[].notesstring | nullOptional notes about this entry.
data[].created_atstringISO 8601 creation timestamp.

Response

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "document_id": "doc_abc123",
      "expected_data": {
        "vendor_name": "Acme Corp",
        "total_amount": 14250.00,
        "invoice_number": "INV-2024-0847"
      },
      "notes": null,
      "created_at": "2024-09-05T12:00:00.000Z"
    }
  ]
}
POST/v1/quality/ground-truth/:datasetId/entries

Response (Add entry)

Response fields (201 Created)

idstringEntry UUID.
document_idstringDocument ID.
expected_dataobjectSaved field values.
notesstring | nullOptional notes.
created_atstringISO 8601 creation timestamp.

Response (POST entry)

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "document_id": "doc_abc123",
  "expected_data": {
    "vendor_name": "Acme Corp",
    "total_amount": 14250.00,
    "invoice_number": "INV-2024-0847"
  },
  "notes": null,
  "created_at": "2024-09-05T12:00:00.000Z"
}
POST/v1/quality/ground-truth/:datasetId/entries/import-csv

Response (CSV import)

Response fields

importedintegerNumber of entries successfully imported.
skippedintegerNumber of rows skipped (e.g. missing document_id or duplicate).

Response (CSV import)

{ "imported": 25, "skipped": 2 }
DELETE/v1/quality/ground-truth/:datasetId/entries/:entryId

Response (Delete entry)

Response fields

deletedbooleanAlways true on success.

Response (DELETE entry)

{ "deleted": true }

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundDataset or entry not found for your workspace.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Get Dataset
Create Benchmark