key | value | description |
---|---|---|
id (required) | documentRange | Optionally set “type”: “paragraph” in the Field object to include newlines (\n) in the output. |
stop | Match object or array of Match objects. default: none | Stops extraction at the top boundary of the matched line. The matched line isn’t included in the method output. If unspecified, matches to the end of the document. |
includeAnchor | boolean. default: false | Includes the anchor line in the method output. |
includeImages | boolean. default: false | Returns the zero-indexed page number and coordinates of regions containing images in the document range . Notes: If you set true, also set”type”: “images” in the field object (see Examples section for an example). Returns image region coordinates, not image bytes or text lines. To extract structured data from images, see the Query Group method and configure the Multimodal Engine parameter. |
offsetY | number in inches. | Specifies the number of inches to offset the start of the document range from the top boundary of the anchor line.Positive values offset down the page, negative values offset up the page.If the offset falls below all lines on the page containing the anchor, the offset starts at the top boundary of the first line on the next page that contains lines. For an example, see the Examples section. |
stopOffsetY | number in inches. | Specifies the number of inches to offset the end of the document range from the top boundary of the stop line.Positive values offset down the page, negative values offset up the page.If the offset falls below all lines on the page containing the anchor, the offset starts at the top boundary of the first line on the next page that contains lines. |
Example document | Download link |
---|
Example document | Download link |
---|
Example document | Download link |
---|
"includeImages":true
for the Document Range method. Sensible returns the image region coordinates rather than the actual encoded bytes of images. If you want to extract the images themselves, you can use a PDF library in your chosen programming language to follow these general steps: