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
    • Convenience Functions
    • UnifiedDocumentLoader
    • OCR
    • Structured OCR Schema
    • OCR Caching
    • Chunking
    • Core Types & Exceptions
  • Development
doc2mark
  • API Reference
  • View page source

API Reference

Complete reference for the public doc2mark API. For task-oriented guides, see Quickstart, OCR, and OCR Result Caching.

  • Convenience Functions
    • Single-document helpers
    • Batch helpers
  • UnifiedDocumentLoader
    • Constructor
    • load()
    • batch_process()
    • batch_process_files()
    • API
  • OCR
    • The OCR facade
    • Tasks
    • Configuration
    • Results
    • Provider registry
    • Providers
  • Structured OCR Schema
    • The verbatim / interpretation boundary
    • OCRPage — the top-level result
    • RawExtraction — verbatim page content
    • Table — a transcribed table
    • KeyValue — a label/value pair
    • Metric — a typed numeric assertion
    • The nested interpretation models
    • Interpretation — the model’s reading
    • A complete filled OCRPage (receipt)
  • OCR Caching
    • Cache backends
    • Factory function
    • Wiring caching into the pipeline
  • Chunking
    • ChunkingConfig
    • Chunk
    • chunk_content
  • Core Types & Exceptions
    • Enumerations
    • Result Objects
    • Exceptions
Previous Next

© Copyright 2026, Hao Liang Wen.

Built with Sphinx using a theme provided by Read the Docs.