Skip to content

Module Output

This page explains the output of each module.

Document Analyzer

The Document Analyzer Module outputs the following variables as a tuple.

Variable Name Type Description
results DocumentAnalyzerSchema Module output results
ocr_vis np.ndarray | None Visualization of the output of the AI-OCR (Only when visualize=True)
layout_vis np.ndarray | None Visualization of the output of the Layout Analyzer (Only when visualize=True)

The specification for the DocumentAnalyzerSchema that the results variable conforms to is as follows:

DocumentAnalyzerSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
preprocess Preprocessing information of the document
RequiredanyOf
 #
DocumentAnalyzerSchema › preprocess
Preprocessing information of the document
Type
anyOf
Nested fields
Any of 1
No Additional Propsobject
#
Any of 2
null
#
paragraphs List of detected paragraphs
Requiredarray
 #
DocumentAnalyzerSchema › paragraphs
List of detected paragraphs
Type
array
Nested fields
ParagraphSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the paragraph in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › box
Bounding box of the paragraph in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
contents Text content of the paragraph
RequiredanyOf
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › contents
Text content of the paragraph
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
direction Text direction, e.g., ['horizontal' or 'vertical']
RequiredanyOf
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › direction
Text direction, e.g., ['horizontal' or 'vertical']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
order Order of the paragraph in the document
RequiredanyOf
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › order
Order of the paragraph in the document
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
role Role of the paragraph, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index',])
RequiredanyOf
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › role
Role of the paragraph, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index',])
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
indent_level Indentation level of the list_item
anyOf
 #
DocumentAnalyzerSchema › paragraphs › ParagraphSchema › indent_level
Indentation level of the list_item
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
integer
#
Any of 2
null
#
tables List of detected tables
Requiredarray
 #
DocumentAnalyzerSchema › tables
List of detected tables
Type
array
Nested fields
TableStructureRecognizerSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › box
Bounding box of the table in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
n_row Number of rows in the table
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › n_row
Number of rows in the table
Type
integer
n_col Number of columns in the table
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › n_col
Number of columns in the table
Type
integer
rows List of table lines representing rows
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › rows
List of table lines representing rows
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema › score
Confidence score of the table line detection
Type
number
cols List of table lines representing columns
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cols
List of table lines representing columns
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema › score
Confidence score of the table line detection
Type
number
spans List of table lines representing spans
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › spans
List of table lines representing spans
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema › score
Confidence score of the table line detection
Type
number
cells List of table cells
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells
List of table cells
Type
array
Nested fields
TableCellSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
col Column index of the cell
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › col
Column index of the cell
Type
integer
row Row index of the cell
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › row
Row index of the cell
Type
integer
col_span Number of columns spanned by the cell
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › col_span
Number of columns spanned by the cell
Type
integer
row_span Number of rows spanned by the cell
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › row_span
Number of rows spanned by the cell
Type
integer
box Bounding box of the cell in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › box
Bounding box of the cell in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
contents Text content of the cell
RequiredanyOf
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › contents
Text content of the cell
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
order Order of the table in the document
Requiredinteger
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › order
Order of the table in the document
Type
integer
caption Caption of the table
anyOf
 #
DocumentAnalyzerSchema › tables › TableStructureRecognizerSchema › caption
Caption of the table
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
No Additional Propsobject
#
Any of 2
null
#
words List of recognized words
Requiredarray
 #
DocumentAnalyzerSchema › words
List of recognized words
Type
array
Nested fields
WordPrediction
No Additional Propsobject
 #
DocumentAnalyzerSchema › words › WordPrediction
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
points Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Requiredarray
 #
DocumentAnalyzerSchema › words › WordPrediction › points
Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
ArrayItem
array
 #
DocumentAnalyzerSchema › words › WordPrediction › points › ArrayItem
Type
array
Constraints
  • Minimum items: 2
  • Maximum items: 2
Nested fields
Item
integer
#
content Text content of the word
Requiredstring
 #
DocumentAnalyzerSchema › words › WordPrediction › content
Text content of the word
Type
string
direction Text direction, e.g., 'horizontal' or 'vertical'
Requiredstring
 #
DocumentAnalyzerSchema › words › WordPrediction › direction
Text direction, e.g., 'horizontal' or 'vertical'
Type
string
rec_score Confidence score of the word recognition
Requirednumber
 #
DocumentAnalyzerSchema › words › WordPrediction › rec_score
Confidence score of the word recognition
Type
number
det_score Confidence score of the word detection
Requirednumber
 #
DocumentAnalyzerSchema › words › WordPrediction › det_score
Confidence score of the word detection
Type
number
figures List of detected figures
Requiredarray
 #
DocumentAnalyzerSchema › figures
List of detected figures
Type
array
Nested fields
FigureSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › figures › FigureSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the figure in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › figures › FigureSchema › box
Bounding box of the figure in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
order Order of the figure in the document
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › order
Order of the figure in the document
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
paragraphs List of paragraphs associated with the figure
Requiredarray
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs
List of paragraphs associated with the figure
Type
array
Nested fields
ParagraphSchema
No Additional Propsobject
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the paragraph in the format [x1, y1, x2, y2]
Requiredarray
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › box
Bounding box of the paragraph in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
contents Text content of the paragraph
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › contents
Text content of the paragraph
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
direction Text direction, e.g., ['horizontal' or 'vertical']
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › direction
Text direction, e.g., ['horizontal' or 'vertical']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
order Order of the paragraph in the document
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › order
Order of the paragraph in the document
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
role Role of the paragraph, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index',])
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › role
Role of the paragraph, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index',])
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
indent_level Indentation level of the list_item
anyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › paragraphs › ParagraphSchema › indent_level
Indentation level of the list_item
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
integer
#
Any of 2
null
#
role Role of the figure, e.g., ['picture', 'logo', 'code', 'seal']
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › role
Role of the figure, e.g., ['picture', 'logo', 'code', 'seal']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
direction Text direction, e.g., ['horizontal' or 'vertical']
RequiredanyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › direction
Text direction, e.g., ['horizontal' or 'vertical']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
caption Caption of the figure
anyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › caption
Caption of the figure
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
No Additional Propsobject
#
Any of 2
null
#
decode Decoded contents of the code, if applicable
anyOf
 #
DocumentAnalyzerSchema › figures › FigureSchema › decode
Decoded contents of the code, if applicable
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
string
#
Any of 2
null
#

AI-OCR

The AI-OCR module outputs the following variables as a tuple.

Variable Name Type Description
results OCRSchema Module output results
ocr_vis np.ndarray | None Visualization of the output of the AI-OCR (Only when visualize=True)

The specification for the OCRSchema that the results variable conforms to is as follows:

OCRSchema
No Additional Propsobject
 #
OCRSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
words List of recognized words with their bounding boxes, content, direction, and scores
Requiredarray
 #
OCRSchema › words
List of recognized words with their bounding boxes, content, direction, and scores
Type
array
Nested fields
WordPrediction
No Additional Propsobject
 #
OCRSchema › words › WordPrediction
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
points Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Requiredarray
 #
OCRSchema › words › WordPrediction › points
Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
ArrayItem
array
 #
OCRSchema › words › WordPrediction › points › ArrayItem
Type
array
Constraints
  • Minimum items: 2
  • Maximum items: 2
Nested fields
Item
integer
#
content Text content of the word
Requiredstring
 #
OCRSchema › words › WordPrediction › content
Text content of the word
Type
string
direction Text direction, e.g., 'horizontal' or 'vertical'
Requiredstring
 #
OCRSchema › words › WordPrediction › direction
Text direction, e.g., 'horizontal' or 'vertical'
Type
string
rec_score Confidence score of the word recognition
Requirednumber
 #
OCRSchema › words › WordPrediction › rec_score
Confidence score of the word recognition
Type
number
det_score Confidence score of the word detection
Requirednumber
 #
OCRSchema › words › WordPrediction › det_score
Confidence score of the word detection
Type
number

Layout Analyzer

The Layout Analyzer module outputs the following variables as a tuple.

Variable Name Type Description
results LayoutAnalyzerSchema Module output results
layout_vis np.ndarray | None Visualization of the output of the Layout Analyzer (Only when visualize=True)

The specification for the LayoutAnalyzerSchema that the results variable conforms to is as follows:

LayoutAnalyzerSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
paragraphs List of detected paragraphs
Requiredarray
 #
LayoutAnalyzerSchema › paragraphs
List of detected paragraphs
Type
array
Nested fields
Element
No Additional Propsobject
 #
LayoutAnalyzerSchema › paragraphs › Element
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the layout element
RequiredanyOf
 #
LayoutAnalyzerSchema › paragraphs › Element › id
Unique identifier of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
box Bounding box of the layout element in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › paragraphs › Element › box
Bounding box of the layout element in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the layout element detection
Requirednumber
 #
LayoutAnalyzerSchema › paragraphs › Element › score
Confidence score of the layout element detection
Type
number
role Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
RequiredanyOf
 #
LayoutAnalyzerSchema › paragraphs › Element › role
Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
contents Text content of the layout element
RequiredanyOf
 #
LayoutAnalyzerSchema › paragraphs › Element › contents
Text content of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
tables List of detected tables
Requiredarray
 #
LayoutAnalyzerSchema › tables
List of detected tables
Type
array
Nested fields
TableStructureRecognizerSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › box
Bounding box of the table in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
n_row Number of rows in the table
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › n_row
Number of rows in the table
Type
integer
n_col Number of columns in the table
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › n_col
Number of columns in the table
Type
integer
rows List of table lines representing rows
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › rows
List of table lines representing rows
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › rows › TableLineSchema › score
Confidence score of the table line detection
Type
number
cols List of table lines representing columns
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cols
List of table lines representing columns
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cols › TableLineSchema › score
Confidence score of the table line detection
Type
number
spans List of table lines representing spans
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › spans
List of table lines representing spans
Type
array
Nested fields
TableLineSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
box Bounding box of the table line in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema › box
Bounding box of the table line in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the table line detection
Requirednumber
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › spans › TableLineSchema › score
Confidence score of the table line detection
Type
number
cells List of table cells
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells
List of table cells
Type
array
Nested fields
TableCellSchema
No Additional Propsobject
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
col Column index of the cell
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › col
Column index of the cell
Type
integer
row Row index of the cell
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › row
Row index of the cell
Type
integer
col_span Number of columns spanned by the cell
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › col_span
Number of columns spanned by the cell
Type
integer
row_span Number of rows spanned by the cell
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › row_span
Number of rows spanned by the cell
Type
integer
box Bounding box of the cell in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › box
Bounding box of the cell in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
contents Text content of the cell
RequiredanyOf
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › cells › TableCellSchema › contents
Text content of the cell
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
order Order of the table in the document
Requiredinteger
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › order
Order of the table in the document
Type
integer
caption Caption of the table
anyOf
 #
LayoutAnalyzerSchema › tables › TableStructureRecognizerSchema › caption
Caption of the table
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
No Additional Propsobject
#
Any of 2
null
#
figures List of detected figures
Requiredarray
 #
LayoutAnalyzerSchema › figures
List of detected figures
Type
array
Nested fields
Element
No Additional Propsobject
 #
LayoutAnalyzerSchema › figures › Element
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the layout element
RequiredanyOf
 #
LayoutAnalyzerSchema › figures › Element › id
Unique identifier of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
box Bounding box of the layout element in the format [x1, y1, x2, y2]
Requiredarray
 #
LayoutAnalyzerSchema › figures › Element › box
Bounding box of the layout element in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the layout element detection
Requirednumber
 #
LayoutAnalyzerSchema › figures › Element › score
Confidence score of the layout element detection
Type
number
role Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
RequiredanyOf
 #
LayoutAnalyzerSchema › figures › Element › role
Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
contents Text content of the layout element
RequiredanyOf
 #
LayoutAnalyzerSchema › figures › Element › contents
Text content of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#

Table Semantic Parser

The Table Semantic Parser module outputs the following variables as a tuple.

Variable Name Type Description
results TableSemanticParserSchema Module output results
vis_layout np.ndarray | None Visualization of the output of the TableSemanticParser (Only when visualize=True)
vis_ocr np.ndarray | None Visualization of the output of the AI-OCR (Only when visualize=True)

The specification for the TableSemanticParserSchema that the results variable conforms to is as follows:

TableSemanticParserSchema
No Additional Propsobject
 #
TableSemanticParserSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
tables List of tables with semantic information
Requiredarray
 #
TableSemanticParserSchema › tables
List of tables with semantic information
Type
array
Nested fields
TableSemanticContentsSchema
No Additional Propsobject
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the table
anyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › id
Unique identifier of the table
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
string
#
Any of 2
null
#
style Border style of the table, e.g., ['border', 'borderless']
Requiredstring
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › style
Border style of the table, e.g., ['border', 'borderless']
Type
string
box Bounding box [x1, y1, x2, y2]
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › box
Bounding box [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
cells Cells keyed by cell_id
Requiredobject
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells
Cells keyed by cell_id
Type
object
Constraints
  • Additional properties must match the nested schema
Nested fields
Additional property
No Additional Propsobject
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
meta Additional metadata for template/semantics
object
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › meta
Additional metadata for template/semantics
Type
object
contents Text content of the cell
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › contents
Text content of the cell
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
role Role of the cell, e.g., ['cell', 'header', 'empty', 'group']
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › role
Role of the cell, e.g., ['cell', 'header', 'empty', 'group']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
id Unique identifier of the cell
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › id
Unique identifier of the cell
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
box Bounding box of the cell in the format [x1, y1, x2, y2]
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › box
Bounding box of the cell in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
row Row index of the cell in the table
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › row
Row index of the cell in the table
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
col Column index of the cell in the table
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › col
Column index of the cell in the table
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
row_span Number of rows spanned by the cell
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › row_span
Number of rows spanned by the cell
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
col_span Number of columns spanned by the cell
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › cells › additional › col_span
Number of columns spanned by the cell
Type
anyOf
Nested fields
Any of 1
integer
#
Any of 2
null
#
kv_items Key-value items extracted from the table
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items
Key-value items extracted from the table
Type
array
Nested fields
KvItemSchema
No Additional Propsobject
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items › KvItemSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the key-value item
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items › KvItemSchema › id
Unique identifier of the key-value item
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
key Key cell id(s)
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items › KvItemSchema › key
Key cell id(s)
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
array
#
value Value cell id
Requiredstring
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items › KvItemSchema › value
Value cell id
Type
string
box Bounding box of the key-value item in the format [x1, y1, x2, y2]
anyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › kv_items › KvItemSchema › box
Bounding box of the key-value item in the format [x1, y1, x2, y2]
Type
anyOf
Constraints
  • Default: None
Nested fields
Any of 1
array
#
Any of 2
null
#
grids Grid representation of the table
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids
Grid representation of the table
Type
array
Nested fields
TableGridSchema
No Additional Propsobject
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the table grid
RequiredanyOf
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › id
Unique identifier of the table grid
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
box Bounding box of the table grid in the format [x1, y1, x2, y2]
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › box
Bounding box of the table grid in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
n_row Number of rows in the table grid
Requiredinteger
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › n_row
Number of rows in the table grid
Type
integer
n_col Number of columns in the table grid
Requiredinteger
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › n_col
Number of columns in the table grid
Type
integer
col_headers 2D array representing the column header cell ids
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › col_headers
2D array representing the column header cell ids
Type
array
Nested fields
ArrayItem
array
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › col_headers › ArrayItem
Type
array
Nested fields
Item
string
#
data 2D array representing the table grid data with cell ids
Requiredarray
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › data
2D array representing the table grid data with cell ids
Type
array
Nested fields
ArrayItem
array
 #
TableSemanticParserSchema › tables › TableSemanticContentsSchema › grids › TableGridSchema › data › ArrayItem
Type
array
Nested fields
Item
anyOf
#
paragraphs List of recognized paragraphs in the document
Requiredarray
 #
TableSemanticParserSchema › paragraphs
List of recognized paragraphs in the document
Type
array
Nested fields
Element
No Additional Propsobject
 #
TableSemanticParserSchema › paragraphs › Element
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
id Unique identifier of the layout element
RequiredanyOf
 #
TableSemanticParserSchema › paragraphs › Element › id
Unique identifier of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
box Bounding box of the layout element in the format [x1, y1, x2, y2]
Requiredarray
 #
TableSemanticParserSchema › paragraphs › Element › box
Bounding box of the layout element in the format [x1, y1, x2, y2]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
Item
integer
#
score Confidence score of the layout element detection
Requirednumber
 #
TableSemanticParserSchema › paragraphs › Element › score
Confidence score of the layout element detection
Type
number
role Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
RequiredanyOf
 #
TableSemanticParserSchema › paragraphs › Element › role
Role of the element, e.g., ['section_headings', 'page_header', 'page_footer', 'list_item', 'caption', 'inline_formula', 'display_formula', 'index']
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
contents Text content of the layout element
RequiredanyOf
 #
TableSemanticParserSchema › paragraphs › Element › contents
Text content of the layout element
Type
anyOf
Nested fields
Any of 1
string
#
Any of 2
null
#
words List of recognized words in the document
Requiredarray
 #
TableSemanticParserSchema › words
List of recognized words in the document
Type
array
Nested fields
WordPrediction
No Additional Propsobject
 #
TableSemanticParserSchema › words › WordPrediction
Type
object
Constraints
  • Additional properties are not allowed
Nested fields
points Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Requiredarray
 #
TableSemanticParserSchema › words › WordPrediction › points
Bounding box of the word in the format [[x1, y1], [x2, y2], [x3, y3], [x4, y4]]
Type
array
Constraints
  • Minimum items: 4
  • Maximum items: 4
Nested fields
ArrayItem
array
 #
TableSemanticParserSchema › words › WordPrediction › points › ArrayItem
Type
array
Constraints
  • Minimum items: 2
  • Maximum items: 2
Nested fields
Item
integer
#
content Text content of the word
Requiredstring
 #
TableSemanticParserSchema › words › WordPrediction › content
Text content of the word
Type
string
direction Text direction, e.g., 'horizontal' or 'vertical'
Requiredstring
 #
TableSemanticParserSchema › words › WordPrediction › direction
Text direction, e.g., 'horizontal' or 'vertical'
Type
string
rec_score Confidence score of the word recognition
Requirednumber
 #
TableSemanticParserSchema › words › WordPrediction › rec_score
Confidence score of the word recognition
Type
number
det_score Confidence score of the word detection
Requirednumber
 #
TableSemanticParserSchema › words › WordPrediction › det_score
Confidence score of the word detection
Type
number

Auto-generated from JSON Schema files.