Affinda · Schema

Affinda Annotation

A field-level annotation on a parsed Affinda document.

AIArtificial IntelligenceDocument ProcessingIntelligent Document ProcessingIDPOCRResume ParsingInvoice ParsingReceipt ParsingDocument ExtractionDocument ClassificationDocument SplittingRecruitmentBankingInsuranceLogisticsHealthcareGovernment

Properties

Name Type Description
id integer Annotation identifier.
rectangle object
rectangles array
pageIndex integernull
raw stringnull Raw OCR text for this annotation.
confidence numbernull
classificationConfidence numbernull
textExtractionConfidence numbernull
isVerified boolean
isClientVerified boolean
isAutoVerified boolean
dataPoint stringnull Data point identifier.
contentType string
parsed object Parsed normalized value (may be string, number, object, or array).
parent integernull Parent annotation id (for table cells).
View JSON Schema on GitHub

JSON Schema

affinda-annotation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/affinda/json-schema/affinda-annotation-schema.json",
  "title": "Affinda Annotation",
  "description": "A field-level annotation on a parsed Affinda document.",
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": { "type": "integer", "description": "Annotation identifier." },
    "rectangle": { "$ref": "#/$defs/Rectangle" },
    "rectangles": { "type": "array", "items": { "$ref": "#/$defs/Rectangle" } },
    "pageIndex": { "type": ["integer", "null"] },
    "raw": { "type": ["string", "null"], "description": "Raw OCR text for this annotation." },
    "confidence": { "type": ["number", "null"], "minimum": 0, "maximum": 1 },
    "classificationConfidence": { "type": ["number", "null"], "minimum": 0, "maximum": 1 },
    "textExtractionConfidence": { "type": ["number", "null"], "minimum": 0, "maximum": 1 },
    "isVerified": { "type": "boolean" },
    "isClientVerified": { "type": "boolean" },
    "isAutoVerified": { "type": "boolean" },
    "dataPoint": { "type": ["string", "null"], "description": "Data point identifier." },
    "contentType": { "type": "string" },
    "parsed": { "description": "Parsed normalized value (may be string, number, object, or array)." },
    "parent": { "type": ["integer", "null"], "description": "Parent annotation id (for table cells)." }
  },
  "$defs": {
    "Rectangle": {
      "type": "object",
      "properties": {
        "x0": { "type": "number" },
        "y0": { "type": "number" },
        "x1": { "type": "number" },
        "y1": { "type": "number" },
        "pageIndex": { "type": "integer" }
      }
    }
  }
}