Xceptor · Schema

ExtractedField

A single field extracted from a document with its value and metadata

API IntegrationData AutomationData ExtractionDocument ProcessingETLFinancial DataFinancial ServicesIntelligent Document ProcessingReconciliationsTrade Operations

Properties

Name Type Description
name string The name of the extracted field
value object The extracted value of the field
data_type string The data type of the extracted value
confidence number The confidence score for this extraction (0.0 to 1.0)
page_number integer The page number where the field was found
bounding_box object
requires_review boolean Whether this field requires manual review due to low confidence
View JSON Schema on GitHub

JSON Schema

xceptor-extractedfield-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExtractedField",
  "title": "ExtractedField",
  "type": "object",
  "description": "A single field extracted from a document with its value and metadata",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the extracted field"
    },
    "value": {
      "description": "The extracted value of the field"
    },
    "data_type": {
      "type": "string",
      "description": "The data type of the extracted value",
      "enum": [
        "string",
        "number",
        "date",
        "currency",
        "boolean"
      ]
    },
    "confidence": {
      "type": "number",
      "description": "The confidence score for this extraction (0.0 to 1.0)",
      "minimum": 0.0,
      "maximum": 1.0
    },
    "page_number": {
      "type": "integer",
      "description": "The page number where the field was found",
      "minimum": 1
    },
    "bounding_box": {
      "$ref": "#/components/schemas/BoundingBox"
    },
    "requires_review": {
      "type": "boolean",
      "description": "Whether this field requires manual review due to low confidence"
    }
  }
}