doc2mark
Getting started
Installation
Quickstart
A minimal RAG pipeline
User guide
Loading documents
Supported formats
The result: ProcessedDocument
PDF text structure
Tables
Images
OCR
When pages and pictures are OCR’d
Contextual OCR strategy
Caching
Chunking and token usage
Optional judge (TypeSafe / Jev)
Command line
Troubleshooting
Reference
API reference
Development
doc2mark
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
AUTO (doc2mark.Task attribute)
AVIF (doc2mark.DocumentFormat attribute)
B
BaseOCR (class in doc2mark.ocr)
batch_convert_to_markdown() (in module doc2mark)
batch_process() (doc2mark.UnifiedDocumentLoader method)
batch_process_documents() (in module doc2mark)
batch_process_files() (doc2mark.UnifiedDocumentLoader method)
(in module doc2mark)
batch_process_images() (doc2mark.ocr.BaseOCR method)
(doc2mark.ocr.cache.CachedOCR method)
BMP (doc2mark.DocumentFormat attribute)
C
CachedOCR (class in doc2mark.ocr.cache)
Chunk (class in doc2mark)
chunk_content() (in module doc2mark)
ChunkingConfig (class in doc2mark)
cleanup() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
clear() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
close() (doc2mark.judge.TypeSafeJudge method)
CODE (doc2mark.Task attribute)
ConversionError
create() (doc2mark.OCRFactory class method)
create_ocr_cache() (in module doc2mark)
CSV (doc2mark.DocumentFormat attribute)
D
DataPoint (class in doc2mark.ocr.schema)
default() (doc2mark.TableStyle class method)
DiagramEdge (class in doc2mark.ocr.schema)
DiagramNode (class in doc2mark.ocr.schema)
DOC (doc2mark.DocumentFormat attribute)
DOCUMENT (doc2mark.Task attribute)
document_to_markdown() (in module doc2mark)
DocumentFormat (class in doc2mark)
DocumentMetadata (class in doc2mark)
DOCX (doc2mark.DocumentFormat attribute)
E
EML (doc2mark.DocumentFormat attribute)
Entity (class in doc2mark.ocr.schema)
F
Figure (class in doc2mark.ocr.schema)
FORM (doc2mark.Task attribute)
G
GEMINI (doc2mark.OCRProvider attribute)
get() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
get_chunks() (doc2mark.ProcessedDocument method)
get_ocr_configuration() (doc2mark.UnifiedDocumentLoader method)
GIF (doc2mark.DocumentFormat attribute)
H
HANDWRITING (doc2mark.Task attribute)
HEIC (doc2mark.DocumentFormat attribute)
HEIF (doc2mark.DocumentFormat attribute)
HTML (doc2mark.DocumentFormat attribute)
I
Interpretation (class in doc2mark.ocr.schema)
J
JPEG (doc2mark.DocumentFormat attribute)
JPG (doc2mark.DocumentFormat attribute)
JSON (doc2mark.DocumentFormat attribute)
(doc2mark.OutputFormat attribute)
JSONL (doc2mark.DocumentFormat attribute)
judge_hooks() (in module doc2mark.judge)
K
KeyValue (class in doc2mark.ocr.schema)
L
list_providers() (doc2mark.OCRFactory class method)
load() (doc2mark.UnifiedDocumentLoader method)
(in module doc2mark)
load_directory() (doc2mark.UnifiedDocumentLoader method)
M
MARKDOWN (doc2mark.DocumentFormat attribute)
(doc2mark.OutputFormat attribute)
markdown (doc2mark.ProcessedDocument property)
MARKDOWN_GRID (doc2mark.TableStyle attribute)
MemoryOCRCache (class in doc2mark)
Metric (class in doc2mark.ocr.schema)
MINIMAL_HTML (doc2mark.TableStyle attribute)
model_config (doc2mark.ocr.schema.DataPoint attribute)
(doc2mark.ocr.schema.DiagramEdge attribute)
(doc2mark.ocr.schema.DiagramNode attribute)
(doc2mark.ocr.schema.Entity attribute)
(doc2mark.ocr.schema.Figure attribute)
(doc2mark.ocr.schema.Interpretation attribute)
(doc2mark.ocr.schema.KeyValue attribute)
(doc2mark.ocr.schema.Metric attribute)
(doc2mark.ocr.schema.OCRPage attribute)
(doc2mark.ocr.schema.RawExtraction attribute)
(doc2mark.ocr.schema.Relation attribute)
(doc2mark.ocr.schema.Section attribute)
(doc2mark.ocr.schema.Table attribute)
N
NoOpOCRCache (class in doc2mark)
O
OCR (class in doc2mark)
OCRCache (class in doc2mark)
OCRConfig (class in doc2mark)
OCRError
OCRFactory (class in doc2mark)
OCRPage (class in doc2mark.ocr.schema)
OCRProvider (class in doc2mark)
OCRResult (class in doc2mark.ocr)
OPENAI (doc2mark.OCRProvider attribute)
OpenAIOCR (class in doc2mark.ocr.openai)
OutputFormat (class in doc2mark)
P
PDF (doc2mark.DocumentFormat attribute)
PNG (doc2mark.DocumentFormat attribute)
PPS (doc2mark.DocumentFormat attribute)
PPT (doc2mark.DocumentFormat attribute)
PPTX (doc2mark.DocumentFormat attribute)
probability() (doc2mark.judge.TypeSafeJudge method)
ProcessedDocument (class in doc2mark)
ProcessingError
R
RawExtraction (class in doc2mark.ocr.schema)
read() (doc2mark.OCR method)
read_one() (doc2mark.OCR method)
RECEIPT (doc2mark.Task attribute)
RedisOCRCache (class in doc2mark)
register_provider() (doc2mark.OCRFactory class method)
Relation (class in doc2mark.ocr.schema)
resolve_judge() (in module doc2mark.judge)
router_invariants() (in module doc2mark.ocr.schema)
RTF (doc2mark.DocumentFormat attribute)
S
sanitize_table_html() (in module doc2mark.ocr.schema)
Section (class in doc2mark.ocr.schema)
set() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
set_ocr_provider() (doc2mark.UnifiedDocumentLoader method)
stats() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
STYLED_HTML (doc2mark.TableStyle attribute)
supported_formats (doc2mark.UnifiedDocumentLoader property)
T
Table (class in doc2mark.ocr.schema)
TABLE (doc2mark.Task attribute)
TableStyle (class in doc2mark)
Task (class in doc2mark)
TESSERACT (doc2mark.OCRProvider attribute)
TesseractOCR (class in doc2mark.ocr.tesseract)
TEXT (doc2mark.OutputFormat attribute)
text (doc2mark.ProcessedDocument property)
TIF (doc2mark.DocumentFormat attribute)
TIFF (doc2mark.DocumentFormat attribute)
to_dict() (doc2mark.ProcessedDocument method)
to_markdown() (doc2mark.ocr.schema.OCRPage method)
TSV (doc2mark.DocumentFormat attribute)
TXT (doc2mark.DocumentFormat attribute)
TypeSafeJudge (class in doc2mark.judge)
U
UnifiedDocumentLoader (class in doc2mark)
UnsupportedFormatError
usage() (doc2mark.judge.TypeSafeJudge method)
V
validate_ocr_setup() (doc2mark.UnifiedDocumentLoader method)
verdict() (doc2mark.judge.TypeSafeJudge method)
VERTEX_AI (doc2mark.OCRProvider attribute)
VertexAIOCR (class in doc2mark.ocr.vertex_ai)
W
WEBP (doc2mark.DocumentFormat attribute)
withholding_violations() (in module doc2mark.ocr.schema)
X
XLS (doc2mark.DocumentFormat attribute)
XLSX (doc2mark.DocumentFormat attribute)
XML (doc2mark.DocumentFormat attribute)
