UiPath · Schema

ExtractedField

A single extracted field with its value and confidence metadata

AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

Properties

Name Type Description
FieldId string Identifier of the extracted field as defined in the extractor schema
FieldName string Display name of the extracted field
IsMissing boolean Whether the field was not found in the document
Value object
View JSON Schema on GitHub

JSON Schema

document-understanding-extracted-field-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-schema/document-understanding-extracted-field-schema.json",
  "title": "ExtractedField",
  "description": "A single extracted field with its value and confidence metadata",
  "type": "object",
  "properties": {
    "FieldId": {
      "type": "string",
      "description": "Identifier of the extracted field as defined in the extractor schema",
      "example": "abc123"
    },
    "FieldName": {
      "type": "string",
      "description": "Display name of the extracted field",
      "example": "Example Name"
    },
    "IsMissing": {
      "type": "boolean",
      "description": "Whether the field was not found in the document",
      "example": true
    },
    "Value": {
      "$ref": "#/components/schemas/FieldValue"
    }
  }
}