key | value | description |
---|---|---|
type (required) | ocr | |
match (required unless you specify Page Lines Limit parameter) | Match object | The text relative to which you define the page number to OCR. For example, if you know that the page after the heading “Policy Addendums” is always a scanned image, then you specify: “type”: “ocr”, “match”: “policy addendums”, “pageOffset”: 1If there are multiple text matches in the document, matches the first. To specify a second or later match, use a Match array. To OCR a single page offset from the first page of the document, rather than offset from matched text, specify “match”: { “type”: “first” }. |
matchAll | boolean | If true, OCRs all pages containing the line specified by the Match parameter. |
pageLinesLimit | integer | Performs OCR on all pages containing the specified number of embedded text lines or fewer. Use this parameter to OCR pages for which no reliable text anchors exist. Sensible recommends specifying a small number relative to the typical number of page lines in the document type, since pages with a small number of embedded lines more likely contain text images. Sensible verifies the qualifying pages contain images before perform OCR, to avoid processing blank pages. If you specify this in combination with a Match parameter, Sensible OCR all pages that meets any of the match criteria or the number of page lines criteria. |
pageOffset | number. default: 0 | The zero-indexed number of the page to OCR, counting from the page number of the text matched by the Match parameter. |
engine | See OCR engine. |
"id": "all_lines_in_doc"
), to double check that OCR extracted the text on those pages.