key | value | description |
---|---|---|
id (required) | nlpTable | The Anchor parameter is optional for fields that use this method. If you specify an anchor: - Sensible ignores the anchor if it’s present in the document. - Sensible returns null for the field if the anchor isn’t present in the document. |
description | string | A prompt that describes the table’s subject matter as a whole. As part of finding the best-matching table, Sensible compares the table title, if present, to this description. For more details about how Sensible uses the description, see the Notes section. |
columns (required) | array | An array of objects with the following parameters: -id (required): A user-friendly ID for the column in the extraction output. -description (required): A prompt that describes the data you want to extract from the column. This prompt can include instructions to reformat or filter the column’s data. For example, provide prompts like ” transaction amount. return the absolute value” or “vehicle make (not model)”. -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. |
(Deprecated) promptIntroduction | string. | (Deprecated) overwrites the introductory text at the beginning of the full prompt that Sensible submits to the LLM for this field. |
rewriteTable | Boolean. default: true | If true, you can use the column descriptions to prompt the LLM to split or merge columns or otherwise restructure the table.Configure this to false to improve performance, to avoid LLM token overflow errors caused by tables that exceed 4,000 tokens, or to troubleshoot an incomplete table extraction.If false, skips the full table restructure described in the Notes section. As a result, Sensible returns the table body unchanged from the OCR extraction, and the only change you can make is to rename the column headings using the columns’ ID parameters. |
pageSpanThreshold | object | Configure the Page Span Threshold parameter to troubleshoot automatic multi-page table recognition. By default, Sensible detects multi-page tables by checking if the table is near the top or bottom of the page. If it is, Sensible searches previous and succeeding pages for continuations of the table. This default behavior fails when intervening, non-table text introduces a large vertical space between a multi-page table and the top or bottom of a page, bumping the table toward the center of the page. Examples of non-table text include footnotes and text box inserts. To allow for such large spaces, configure the following parameters: - top: number. default: 0.4. Sensible searches the previous page for a continuation of a multi-page table if the table starts in the top 40% of the page. Change the percent using this parameter. - bottom: number. default: 0.2. Sensible searches the next page for a continuation of a multi-page table if the table ends in the bottom 20% of the page. Change the percent using this parameter.Sensible continues merging the multi-page table until the Page Span Threshold conditions are no longer met, or until Sensible encounters LLM token limits. |
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. |
contextDescription | For information about this parameter, see Advanced prompt configuration. | |
pageHinting | For information about this parameter, see Advanced prompt configuration. | |
chunkCount | default: 5 | For information about this parameter, see Advanced prompt configuration. |
chunkSize | default: 0.5 | For information about this parameter, see Advanced prompt configuration. |
chunkOverlapPercentage | default: 0.5 | For information about this parameter, see Advanced prompt configuration. |
pageRange | For information about this parameter, see Advanced prompt configuration. |
Example document | Download link |
---|