Skip to content

Documentation (1018168): Added JSON attribute details in both Smart Data Extractor and Smart Table Extractor. #2549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GowthamrajKumar25 merged 3 commits into from
Mar 31, 2026
+409 −1
Merged

Documentation (1018168): Added JSON attribute details in both Smart Data Extractor and Smart Table Extractor. #2549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
032df13
Added the JSON attributes in both data and table extractor
VenkateshwaranSF5013 Mar 31, 2026
9b4bdf6
Addressed the feedbacks
VenkateshwaranSF5013 Mar 31, 2026
b73a2d7
Merge branch 'development' of https://github.com/syncfusion-content/d…
VenkateshwaranSF5013 Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 225 additions & 0 deletions Document-Processing/Data-Extraction/Smart-Data-Extractor/NET/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,228 @@ The following list shows the key features available in the Essential<sup>&reg;</
* **Confidence thresholding:** Results are filtered based on a configurable confidence score (0.0–1.0).
* **Deterministic performance:** Designed for predictable, repeatable extraction across environments (Windows, Linux, Azure, Docker).

## JSON Output Structure and Attributes

The Smart Data Extractor library processes PDFs and scanned images to extract structured document data including tables, form fields, text elements, images, headers, and footers. The extracted output is returned as structured JSON that includes per-field confidence scores and a complete document hierarchy, making it ready for immediate review, export, or integration into downstream workflows.

### Root Structure

Below is the root structure of the JSON result:

{% tabs %}

{% highlight json tabtitle="JSON" %}

{
"Pages": [
{
"PageNumber": 1,
"Width": 0,
"Height": 0,
"PageObjects": [],
"FormObjects": []
}
]
}

{% endhighlight %}

{% endtabs %}

### JSON Attributes

#### Page Object

The Page Object represents the metadata of a page along with all the detected elements it contains.

<table>
<thead>
<tr>
<th><b>Attribute</b></th>
<th><b>Type</b></th>
<th><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>PageNumber</td>
<td>Integer</td>
<td>Sequential number of the page in the document.</td>
</tr>
<tr>
<td>Width</td>
<td>Float</td>
<td>Page width in points/pixels.</td>
</tr>
<tr>
<td>Height</td>
<td>Float</td>
<td>Page height in points/pixels.</td>
</tr>
<tr>
<td>PageObjects</td>
<td>Array</td>
<td>List of detected objects (table).</td>
</tr>
<tr>
<td>FormObjects</td>
<td>Array</td>
<td>List of detected form fields (checkboxes, text boxes, radio button, signature etc..)</td>
</tr>
</tbody>
</table>

#### PageObjects

PageObjects represent detected elements on a page such as text, headers, footers, tables, images, and numbers.

<table>
<thead>
<tr>
<th><b>Attribute</b></th>
<th><b>Type</b></th>
<th><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>Type</td>
<td>String</td>
<td>Defines the kind of object detected on the page (Table).</td>
</tr>
<tr>
<td>Bounds</td>
<td>Array of Floats</td>
<td>The bounding box coordinates [X, Y, Width, Height] representing the object's position and size on the page.</td>
</tr>
<tr>
<td>Content</td>
<td>String</td>
<td>Extracted text or value associated with the object (if applicable).</td>
</tr>
<tr>
<td>Confidence</td>
<td>Float</td>
<td>Confidence score (0–1) indicating the accuracy of detection.</td>
</tr>
<tr>
<td>TableFormat (only for tables)</td>
<td>Object</td>
<td>Metadata about table detection, including detection score and label.</td>
</tr>
<tr>
<td>Rows (only for tables)</td>
<td>Array</td>
<td>Collection of row objects that make up the table.</td>
</tr>
</tbody>
</table>

#### Row Object

The Row Object represents a single horizontal group of cells within a table, along with its bounding box.

<table>
<thead>
<tr>
<th><b>Attribute</b></th>
<th><b>Type</b></th>
<th><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>Type</td>
<td>String</td>
<td>Row type (e.g., tr).</td>
</tr>
<tr>
<td>Rect</td>
<td>Array</td>
<td>Bounding box coordinates for the row.</td>
</tr>
<tr>
<td>Cells</td>
<td>Array</td>
<td>Collection of cell objects contained in the row.</td>
</tr>
</tbody>
</table>

#### Cell Object

The Cell Object represents an individual table entry, containing text values, spanning details, and positional coordinates.

<table>
<thead>
<tr>
<th><b>Attribute</b></th>
<th><b>Type</b></th>
<th><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>Type</td>
<td>String</td>
<td>Cell type (e.g., td).</td>
</tr>
<tr>
<td>Rect</td>
<td>Array</td>
<td>Bounding box coordinates for the cell.</td>
</tr>
<tr>
<td>RowSpan / ColSpan</td>
<td>Integer</td>
<td>Number of rows or columns spanned by the cell.</td>
</tr>
<tr>
<td>RowStart / ColStart</td>
<td>Integer</td>
<td>Starting row and column index of the cell.</td>
</tr>
<tr>
<td>Content.Value</td>
<td>String</td>
<td>Text content inside the cell.</td>
</tr>
</tbody>
</table>

#### FormObjects

FormObjects represent interactive form fields detected on the page, such as text boxes, checkboxes, radio buttons, and signature regions. Each object includes positional data, field dimensions, field type, and a confidence score that reflects the reliability of the detection.

<table>
<thead>
<tr>
<th><b>Attribute</b></th>
<th><b>Type</b></th>
<th><b>Description</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>X / Y</td>
<td>Float</td>
<td>Coordinates of the form field on the page.</td>
</tr>
<tr>
<td>Width / Height</td>
<td>Float</td>
<td>Dimensions of the form field.</td>
</tr>
<tr>
<td>Type</td>
<td>Integer</td>
<td>Numeric identifier for the form field type (e.g., 0 = TextArea, 1 = Checkbox, 2 = Radio Button, 3 = Signature).</td>
</tr>
<tr>
<td>Confidence</td>
<td>Float</td>
<td>Confidence score (0–1) indicating detection accuracy.</td>
</tr>
</tbody>
</table>

Loading