key | value | description |
---|---|---|
id (required) | fixedTable | When you specify this, you must also specify “type”: “table” in the field’s parameters. See the Stop parameter for details about how Sensible recognizes a table. |
columnCount (required) | integer | The number of columns the tables must have. |
columns (required) | array | An array of objects with the following parameters: -id (required): The ID for the column in the extraction output - index (required): The zero-based column index -type : The table cell’s type. For more information, see Types -isRequired (default: false): If true, Sensible omits a row if its cell is empty in this column, or if the contents don’t match the value you specify in this column’s Type parameter. If false, Sensible returns nulls for empty cells in the row. Note that if you set this parameter to true for one column, Sensible omits the row for all columns, even if the row had content under other columns. |
stop | Match object or array of Match objects. default: none | (Recommended) Stops table recognition at the matched line. Otherwise, Sensible searches all pages for tables, which can impact performance.When you specify a stop, Sensible uses an Amazon Web Service provider to perform table recognition. When you omit a stop, Sensible uses a Microsoft OCR provider.When you specify a stop, Sensible supports: - merged cells in tables. Sensible populates “empty” spanned cells with the spanned value. For an example, see Merged cell example. - checkboxes in cells. Returns checkbox selection status as [true] or [false]. |
startOnRow | integer. default: 0 | Zero-indexed row number at which to start table extraction. For example, use this to exclude column headings from the output. As a stricter alternative, set the Is Required parameter on a column and set a type on the column (see example in Examples section). |
detectTableStructureOnly | boolean. default: false | Set this parameter to true to troubleshoot optional character recognition (OCR) in a table. If true, Sensible bypasses the text output by the table recognition OCR provider. Sensible instead recognizes the table’s text using the OCR engine specified by your document type, or by using text embedded in the document file if present. For an example, see Example: Troubleshoot Table OCR.If “detectTableStructureOnly”: true causes incorrect line sorting, set annotateSuperscriptAndSubscript”: true to correct the line sorting. |
annotateSuperscriptAndSubscript | boolean. default: false | Set to true only if the Detect Table Structure Only parameter is set to true. When true: - Sensible annotates subscript and superscript text in the table with [^…] and [_…], respectively. This parameter doesn’t support annotating text in multi-line cells. |
"type": "number"
and "isRequired": true
for the column col4_rank_last_month
. You can also use "startOnRow":1
to omit headings.Example document | Download link |
---|
Example document | Download link |
---|
Example document | Download link |
---|