These docs describe changes that aren’t released yet. For the newest release, see the released docs.
ExtractOptions
Options for Document.extract.
Type Parameters
Section titled “Type Parameters”F extends ExtractFormat = ExtractFormat
Properties
Section titled “Properties”chunk?
Section titled “chunk?”
readonlyoptionalchunk?:ChunkOptions
How chunks are cut ("chunks", and "json" to include them).
dehyphenate?
Section titled “dehyphenate?”
readonlyoptionaldehyphenate?:boolean
Join words hyphenated across lines; on by default.
readonlyoptionaldrop?:object
keepSpans keeps each dropped run’s text in its dropped entry (JSON), for auditing a file.
furniture (on by default) drops running headers, footers, page numbers and artifact-marked text too.
furniture?
Section titled “furniture?”
readonlyoptionalfurniture?:boolean
keepSpans?
Section titled “keepSpans?”
readonlyoptionalkeepSpans?:boolean
format
Section titled “format”
readonlyformat:F
What to return: Markdown or plain text as a string, the JSON as an Extraction, or Chunks.
pageMarkers?
Section titled “pageMarkers?”
readonlyoptionalpageMarkers?:boolean
Write <!-- page N --> before each page’s first block (Markdown, chunks and the JSON’s text ranges).
pages?
Section titled “pages?”
readonlyoptionalpages?: readonlynumber[]
The 0-based page indices to extract, in this order; every page by default.
readingOrder?
Section titled “readingOrder?”
readonlyoptionalreadingOrder?:any
Where the reading order comes from; "auto" by default.
tables?
Section titled “tables?”
readonlyoptionaltables?:any
Which table detectors run; "lattice" by default.