doc2mark
User Guide
Quickstart
Command Line
Supported formats & how each is handled
OCR
Content-aware OCR policy
Complex Table Preservation
Contextual OCR strategy
OCR Result Caching
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
AVIF (doc2mark.DocumentFormat attribute)
B
BaseOCR (class in doc2mark.ocr)
batch_process() (doc2mark.core.loader.UnifiedDocumentLoader method)
batch_process_files() (doc2mark.core.loader.UnifiedDocumentLoader method)
batch_process_images() (doc2mark.ocr.BaseOCR method)
(doc2mark.ocr.cache.CachedOCR method)
(doc2mark.ocr.openai.OpenAIOCR method)
(doc2mark.ocr.tesseract.TesseractOCR method)
(doc2mark.ocr.vertex_ai.VertexAIOCR 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)
ConversionError
create() (doc2mark.ocr.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)
deprecated_llm_overrides() (doc2mark.ocr.OCRConfig method)
DiagramEdge (class in doc2mark.ocr.schema)
DiagramNode (class in doc2mark.ocr.schema)
DOC (doc2mark.DocumentFormat attribute)
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)
G
get() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
get_available_prompt_templates() (doc2mark.core.loader.UnifiedDocumentLoader method)
get_available_prompts() (doc2mark.ocr.openai.OpenAIOCR method)
(doc2mark.ocr.vertex_ai.VertexAIOCR method)
get_chunks() (doc2mark.ProcessedDocument method)
get_configuration_summary() (doc2mark.ocr.openai.OpenAIOCR method)
(doc2mark.ocr.vertex_ai.VertexAIOCR method)
get_ocr_configuration() (doc2mark.core.loader.UnifiedDocumentLoader method)
GIF (doc2mark.DocumentFormat attribute)
H
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)
K
KeyValue (class in doc2mark.ocr.schema)
L
list_providers() (doc2mark.ocr.OCRFactory class method)
load() (doc2mark.core.loader.UnifiedDocumentLoader method)
load_directory() (doc2mark.core.loader.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.ocr)
OCRCache (class in doc2mark)
OCRConfig (class in doc2mark.ocr)
OCRError
OCRFactory (class in doc2mark.ocr)
OCRPage (class in doc2mark.ocr.schema)
OCRProvider (class in doc2mark.ocr)
OCRResult (class in doc2mark.ocr)
OpenAIOCR (class in doc2mark.ocr.openai)
OutputFormat (class in doc2mark)
P
PDF (doc2mark.DocumentFormat attribute)
pil (doc2mark.ocr.tesseract.TesseractOCR property)
PNG (doc2mark.DocumentFormat attribute)
PPS (doc2mark.DocumentFormat attribute)
PPT (doc2mark.DocumentFormat attribute)
PPTX (doc2mark.DocumentFormat attribute)
preprocess_image() (doc2mark.ocr.BaseOCR method)
(doc2mark.ocr.cache.CachedOCR method)
(doc2mark.ocr.tesseract.TesseractOCR method)
ProcessedDocument (class in doc2mark)
ProcessingError
provider_name (doc2mark.ocr.BaseOCR property)
(doc2mark.ocr.cache.CachedOCR property)
pytesseract (doc2mark.ocr.tesseract.TesseractOCR property)
R
RawExtraction (class in doc2mark.ocr.schema)
read() (doc2mark.ocr.OCR method)
read_one() (doc2mark.ocr.OCR method)
RedisOCRCache (class in doc2mark)
register_provider() (doc2mark.ocr.OCRFactory class method)
Relation (class in doc2mark.ocr.schema)
requires_api_key (doc2mark.ocr.BaseOCR property)
(doc2mark.ocr.cache.CachedOCR property)
(doc2mark.ocr.openai.OpenAIOCR property)
(doc2mark.ocr.tesseract.TesseractOCR property)
(doc2mark.ocr.vertex_ai.VertexAIOCR property)
RTF (doc2mark.DocumentFormat attribute)
S
Section (class in doc2mark.ocr.schema)
set() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
set_ocr_provider() (doc2mark.core.loader.UnifiedDocumentLoader method)
stats() (doc2mark.MemoryOCRCache method)
(doc2mark.NoOpOCRCache method)
(doc2mark.OCRCache method)
(doc2mark.RedisOCRCache method)
STYLED_HTML (doc2mark.TableStyle attribute)
supported_formats (doc2mark.core.loader.UnifiedDocumentLoader property)
T
Table (class in doc2mark.ocr.schema)
TableStyle (class in doc2mark)
Task (class in doc2mark.ocr)
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)
U
UnifiedDocumentLoader (class in doc2mark.core.loader)
UnsupportedFormatError
update_model_config() (doc2mark.ocr.openai.OpenAIOCR method)
update_ocr_configuration() (doc2mark.core.loader.UnifiedDocumentLoader method)
update_prompt_template() (doc2mark.ocr.openai.OpenAIOCR method)
(doc2mark.ocr.vertex_ai.VertexAIOCR method)
V
validate_api_key() (doc2mark.ocr.BaseOCR method)
(doc2mark.ocr.cache.CachedOCR method)
(doc2mark.ocr.openai.OpenAIOCR method)
(doc2mark.ocr.tesseract.TesseractOCR method)
(doc2mark.ocr.vertex_ai.VertexAIOCR method)
validate_ocr() (doc2mark.core.loader.UnifiedDocumentLoader method)
validate_ocr_setup() (doc2mark.core.loader.UnifiedDocumentLoader method)
VertexAIOCR (class in doc2mark.ocr.vertex_ai)
W
WEBP (doc2mark.DocumentFormat attribute)
X
XLS (doc2mark.DocumentFormat attribute)
XLSX (doc2mark.DocumentFormat attribute)
XML (doc2mark.DocumentFormat attribute)
