
pdfmux
β 72from NameetP
Smart PDF-to-Markdown router that picks the best extractor per page, audits output quality, and re-extracts failures automatically. Confidence scoring, BYOK LLM support, RAG chunking.
pdfmux
Self-healing PDF extraction with per-page confidence scoring. Open-source LlamaParse alternative for RAG pipelines, MCP server for Claude Desktop, LangChain + LlamaIndex loaders. Ranked #2 on opendataloader-bench (0.900).
The only PDF extractor that audits its own output. Catches blank pages, scrambled columns, broken tables β re-extracts them with a stronger backend. So your LLM gets clean data, not silent garbage. Routes each page to the best of 5 rule-based backends + BYOK LLM fallback (Gemini / Claude / GPT-4o / Ollama). One CLI. One API. Zero config.
PDF ββ> pdfmux router ββ> best extractor per page ββ> audit ββ> re-extract failures ββ> Markdown / JSON / chunks
|
ββ PyMuPDF (digital text, 0.01s/page)
ββ OpenDataLoader (complex layouts, 0.05s/page)
ββ RapidOCR (scanned pages, CPU-only)
ββ Docling (tables, 97.9% TEDS)
ββ Surya (heavy OCR fallback)
ββ Marker (academic papers, neural)
ββ Mistral OCR ($0.002/page, 96.6% tables)
ββ YOUR LLM (Gemini / Gemma 4 / Claude / GPT-4o / Ollama / Mistral β BYOK via YAML)
Architecture
βββββββββββββββββββββββββββββββ
β Segment Detector β
β text / tables / images / β
β formulas / headers per page β
βββββββββββββββ¬ββββββββββββββββ
β
ββββββββββββββββββββββββββββββββββββββββββ
β Router Engine β
β β
β economy ββ balanced ββ premium β
β (minimize $) (default) (max quality)β
β budget caps: --budget 0.50 β
ββββββββββββββββββββββ¬ββββββββββββββββββββ
β
ββββββββββββ¬βββββββββββ¬βββββββββ΄βββββββββ¬βββββββββββ
β β β β β
PyMuPDF OpenData RapidOCR Docling LLM
digital Loader scanned tables (BYOK)
0.01s/pg complex CPU-only 97.9% any provider
layouts TEDS
β β β β β
ββββββββββββ΄βββββββββββ΄βββββββββ¬βββββββββ΄βββββββββββ
β
ββββββββββββββββββββββββββββββββββββββββββ
β Quality Auditor β
β β
β 4-signal dynamic confidence scoring β
β per-page: good / bad / empty β
β if bad -> re-extract with next backendβ
ββββββββββββββββββββββ¬ββββββββββββββββββββ
β
ββββββββββββββββββββββββββββββββββββββββββ
β Output Pipeline β
β β
β heading injection (font-size analysis)β
β table extraction + normalization β
β text cleanup + merge β
β confidence score (honest, not inflated)β
ββββββββββββββββββββββββββββββββββββββββββ
Key design decisions
-
Router, not extractor. pdfmux does not compete with PyMuPDF or Docling. It picks the best one per page.
-
Agentic multi-pass. Extract, audit confidence, re-extract failures with a stronger backend. Bad pages get retried automatically.
-
Segment-level detection. Each page is classified by content type (text, tables, images, formulas, headers) before routing.
-
4-signal confidence. Dynamic quality scoring from character density, OCR noise ratio, table integrity, and heading structure. Not hardcoded thresholds.
-
Document cache. Each PDF is opened once, not once per extractor. Shared across the full pipeline.
-
Data flywheel. Local telemetry tracks which extractors win per document type. Routing improves with usage.
Features
Feature What it does Command
Zero-config extraction Routes to best backend automatically pdfmux convert file.pdf
RAG chunking Section-aware chunks with token estimates pdfmux convert file.pdf --chunk --max-tokens 500
Cost modes economy / balanced / premium with budget caps pdfmux convert file.pdf --mode economy --budget 0.50
Schema extraction 5 built-in presets (invoice, receipt, contract, resume, paper) pdfmux convert file.pdf --schema invoice
Profiles Save and re-use config; built-ins for invoices/receipts/papers/contracts/bulk-rag pdfmux convert file.pdf --profile invoices
BYOK LLM Gemini, Gemma 4, Claude, GPT-4o, Ollama, Mistral, any OpenAI-compatible API pdfmux convert file.pdf --llm-provider claude
Cost estimate Predict spend before running pdfmux estimate file.pdf --llm-provider gemini
Streaming output NDJSON events page-by-page for long docs pdfmux stream file.pdf
Smart cache Hash-keyed result cache, 30-day TTL, 1 GB LRU pdfmux convert file.pdf (auto), --no-cache to bypass
Watch mode Auto-convert any PDF added to a folder pdfmux watch ./inbox/
Diff Compare two extractions pdfmux diff a.pdf b.pdf
Benchmark Eval all installed extractors against ground truth pdfmux benchmark
Doctor Show installed backends, coverage gaps, recommendations pdfmux doctor
MCP server AI agents read PDFs via stdio or HTTP pdfmux serve
Batch processing Convert entire directories pdfmux convert ./docs/
Page-level streaming API Bounded-memory page iteration for large files for page in ext.extract("500pg.pdf")
Retry with backoff Every LLM provider auto-retries with exponential backoff + Retry-After (built-in)
CLI Reference
pdfmux convert
pdfmux convert [options]
Options:
-o, --output PATH Output file or directory
-f, --format FORMAT markdown | json | csv | llm (default: markdown)
-q, --quality QUALITY fast | standard | high (default: standard)
-s, --schema SCHEMA JSON schema file or preset (invoice, receipt, contract, resume, paper)
--chunk Output RAG-ready chunks
--max-tokens N Max tokens per chunk (default: 500)
--mode MODE economy | balanced | premium (default: balanced)
--budget AMOUNT Max spend per document in USD
--llm-provider PROVIDER LLM backend: gemini | claude | openai | ollama
--confidence Include confidence score in output
--stdout Print to stdout instead of file
pdfmux serve
Start the MCP server for AI agent integration.
pdfmux serve # stdio mode (Claude Desktop, Cursor)
pdfmux serve --http 8080 # HTTP mode
pdfmux doctor
pdfmux doctor
# ββββββββββββββββββββ¬ββββββββββββββ¬ββββββββββ¬βββββββββββββββββββββββββββββββββββ
# β Extractor β Status β Version β Install β
# ββββββββββββββββββββΌββββββββββββββΌββββββββββΌβββββββββββββββββββββββββββββββββββ€
# β PyMuPDF β installed β 1.25.3 β β
# β OpenDataLoader β installed β 0.3.1 β β
# β RapidOCR β installed β 3.0.6 β β
# β Docling β missing β -- β pip install pdfmux[tables] β
# β Surya β missing β -- β pip install pdfmux[ocr-heavy] β
# β LLM (Gemini) β configured β -- β GEMINI_API_KEY set β
# ββββββββββββββββββββ΄ββββββββββββββ΄ββββββββββ΄βββββββββββββββββββββββββββββββββββ
pdfmux benchmark
pdfmux benchmark report.pdf
# ββββββββββββββββββββ¬βββββββββ¬βββββββββββββ¬ββββββββββββββ¬βββββββββββββββββββββββ
# β Extractor β Time β Confidence β Output β Status β
# ββββββββββββββββββββΌβββββββββΌβββββββββββββΌββββββββββββββΌβββββββββββββββββββββββ€
# β PyMuPDF β 0.02s β 95% β 3,241 chars β all pages good β
# β Multi-pass β 0.03s β 95% β 3,241 chars β all pages good β
# β RapidOCR β 4.20s β 88% β 2,891 chars β ok β
# β OpenDataLoader β 0.12s β 97% β 3,310 chars β best β
# ββββββββββββββββββββ΄βββββββββ΄βββββββββββββ΄ββββββββββββββ΄βββββββββββββββββββββββ
pdfmux estimate
Predict spend (and which backends will run) before processing.
pdfmux estimate report.pdf --quality high --llm-provider gemini
# Pages : 47
# Extractors : pymupdf4llm + gemini-2.5-flash on 9 pages
# Estimated : $0.0234
# Cache hit? : no (first run for this file)
pdfmux stream
Emit NDJSON events as pages complete β useful for very long PDFs and live UIs.
pdfmux stream long.pdf --quality high
# {"event":"classified","page_count":312,"plan":"pymupdf+gemini-fallback"}
# {"event":"page","page_num":0,"confidence":0.97,"chars":1842}
# {"event":"page","page_num":1,"confidence":0.92,"chars":1611,"ocr":true}
# ...
# {"event":"complete","confidence":0.94,"cost_usd":0.0712}
pdfmux watch
Auto-convert any PDFs that land in a directory. Survives until Ctrl+C.
pdfmux watch ./inbox/ -o ./output/ --profile bulk-rag
pdfmux diff
Side-by-side extraction comparison (quality, content, cost).
pdfmux diff a.pdf b.pdf --quality standard
pdfmux profiles
Saved configs at ~/.config/pdfmux/profiles.yaml. Built-ins ship for the
common shapes; save your own for project defaults.
pdfmux profiles list
# invoices quality=standard, schema=invoice, format=json
# receipts quality=fast, schema=receipt, format=json
# papers quality=high, chunk=true, max_tokens=500
# contracts quality=high, schema=contract
# bulk-rag quality=standard, format=llm, chunk=true
pdfmux profiles show invoices
pdfmux profiles save my-default --quality high --format llm --chunk
pdfmux profiles delete my-default
# use a profile when converting
pdfmux convert file.pdf --profile invoices
Python API
Text extraction
import pdfmux
text = pdfmux.extract_text("report.pdf") # -> str (markdown)
text = pdfmux.extract_text("report.pdf", quality="fast") # PyMuPDF only, instant
text = pdfmux.extract_text("report.pdf", quality="high") # LLM-assisted
Structured extraction
data = pdfmux.extract_json("report.pdf")
# data["page_count"] -> 12
# data["confidence"] -> 0.91
# data["ocr_pages"] -> [2, 5, 8]
# data["pages"][0]["key_values"] -> [{"key": "Date", "value": "2026-02-28"}]
# data["pages"][0]["tables"] -> [{"headers": [...], "rows": [...]}]
RAG chunking
chunks = pdfmux.chunk("report.pdf", max_tokens=500)
for c in chunks:
print(f"{c['title']}: {c['tokens']} tokens (pages {c['page_start']}-{c['page_end']})")
Schema-guided extraction
data = pdfmux.extract_json("invoice.pdf", schema="invoice")
# Uses built-in invoice preset: extracts date, vendor, line items, totals
# Also accepts a path to a custom JSON Schema file
Streaming (bounded memory)
from pdfmux.extractors import get_extractor
ext = get_extractor("fast")
for page in ext.extract("large-500-pages.pdf"): # Iterator[PageResult]
process(page.text) # constant memory, even on 500-page PDFs
Types and errors
from pdfmux import (
# Enums
Quality, # FAST, STANDARD, HIGH
OutputFormat, # MARKDOWN, JSON, CSV, LLM
PageQuality, # GOOD, BAD, EMPTY
# Data objects (frozen dataclasses)
PageResult, # page: text, page_num, confidence, quality, extractor
DocumentResult, # document: pages, source, confidence, extractor_used
Chunk, # chunk: title, text, page_start, page_end, tokens
# Errors
PdfmuxError, # base -- catch this for all pdfmux errors
FileError, # file not found, unreadable, not a PDF
ExtractionError, # extraction failed
ExtractorNotAvailable,# requested backend not installed
FormatError, # invalid output format
AuditError, # audit could not complete
)
Framework Integrations
LangChain
pip install langchain-pdfmux
from langchain_pdfmux import PDFMuxLoader
loader = PDFMuxLoader("report.pdf", quality="standard")
docs = loader.load() # -> list[Document] with confidence metadata
LlamaIndex
pip install llama-index-readers-pdfmux
from llama_index.readers.pdfmux import PDFMuxReader
reader = PDFMuxReader(quality="standard")
docs = reader.load_data("report.pdf") # -> list[Document]
MCP Server (AI Agents)
Listed on mcpservers.org. One-line setup:
{
"mcpServers": {
"pdfmux": {
"command": "npx",
"args": ["-y", "pdfmux-mcp"]
}
}
}
Or via Claude Code:
claude mcp add pdfmux -- npx -y pdfmux-mcp
Tools exposed: convert_pdf, analyze_pdf, extract_structured,
extract_streaming, get_pdf_metadata, batch_convert.
Arabic & RTL Support
pdfmux ships first-class support for Arabic, Persian, Urdu, and Hebrew. Out of the box, RTL detection runs on every PDF and PyMuPDF-extracted pages are passed through the Unicode Bidirectional Algorithm so glyphs that were stored in left-to-right order render in correct reading order.
# Default install β already includes python-bidi for RTL reordering
pip install pdfmux
# Recommended for Arabic-heavy docs β adds Gemma 4 vision OCR
pip install "pdfmux[arabic,llm-gemma]"
# One credential covers Gemma + Gemini (same Google endpoint)
export GEMINI_API_KEY=...
What happens automatically:
-
pdfmux convertdetects Arabic content and routes pages with >5% Arabic characters through the Arabic-aware extractor chain. -
PyMuPDF, RapidOCR, and Docling outputs are post-processed with the Bidi algorithm β markdown headings (
#) and pipe-table rows preserve structure, only inner text is reordered. -
DocumentResult.has_arabicis set toTruewhenever any page contains Arabic script.
What requires opt-in:
-
Vision LLM extraction. Set
--llm-provider gemma(or any vision provider) to route Arabic pages through Gemma 4 instead of PyMuPDF. -
Aggressive normalization (Tatweel removal, Alef/Yeh unification, Tashkeel stripping) β call
pdfmux.arabic.normalize_arabic(text)on extracted strings if you need canonicalized output for search or embedding.
from pdfmux.arabic import (
is_arabic_text,
is_rtl_dominant,
fix_bidi_order,
normalize_arabic,
)
text = "Ω
Ψ±ΨΨ¨Ψ§ Ψ¨Ψ§ΩΨΉΨ§ΩΩ
"
assert is_arabic_text(text)
assert is_rtl_dominant(text)
# Fix glyph order from PyMuPDF / OCR engines
visual = fix_bidi_order(text)
# Canonicalize for indexing β strip Tatweel, unify Alef variants, drop diacritics
indexable = normalize_arabic("Ψ£ΩΨΩΩ
ΩΨ―Ω") # β "Ψ§ΨΩ
Ψ―"
Benchmark
Tested on opendataloader-bench -- 200 real-world PDFs across financial reports, legal filings, academic papers, and scanned documents.
Engine Overall Reading Order Tables (TEDS) Headings Requires opendataloader hybrid 0.909 0.935 0.928 0.828 API calls ($) pdfmux 0.905 0.920 0.911 0.852 CPU only, $0 docling 0.877 0.900 0.887 0.802 ~500MB models marker 0.861 0.890 0.808 0.796 GPU recommended opendataloader local 0.844 0.913 0.494 0.761 CPU only mineru 0.831 0.857 0.873 0.743 GPU + ~2GB models
#2 overall, #1 among free tools. 99.5% of the paid #1 score at zero cost per page. Best heading detection of any engine tested. Image table OCR extracts tables embedded as images.
Smart Result Cache
Re-running the same extraction is instant. pdfmux hashes every input PDF
(SHA-256) and keys results on (file_hash, quality, format, schema). Cache
files live under ~/.cache/pdfmux/results/, expire after 30 days, and are
LRU-evicted at 1 GB.
pdfmux convert big-report.pdf # first run: 14.2s
pdfmux convert big-report.pdf # cache hit: 0.05s
pdfmux convert big-report.pdf --no-cache # bypass cache (still writes back)
pdfmux convert big-report.pdf --clear-cache # purge and re-run
The cache also speeds up --profile, --schema, and --format switches β
each combination is keyed independently, so you can flip between Markdown
and JSON for the same document for free after the first extraction.
Confidence Scoring
Every result includes a 4-signal confidence score:
-
95-100% -- clean digital text, fully extractable
-
80-95% -- good extraction, minor OCR noise on some pages
-
50-80% -- partial extraction, some pages unrecoverable
-
<50% -- significant content missing, warnings included
When confidence drops below 80%, pdfmux tells you exactly what went wrong and how to fix it:
Page 4: 32% confidence. 0 chars extracted from image-heavy page.
-> Install pdfmux[ocr] for RapidOCR support on 6 image-heavy pages.
Cost Modes
Mode Behavior Typical cost economy Rule-based backends only. No LLM calls. $0/page balanced LLM only for pages that fail rule-based extraction. ~$0.002/page avg premium LLM on every page for maximum quality. ~$0.01/page
Set a hard budget cap: --budget 0.50 stops LLM calls when spend reaches $0.50 per document.
Why pdfmux?
pdfmux is not another PDF extractor. It is the orchestration layer that picks the right extractor per page, verifies the result, and retries failures.
Tool Good at Limitation PyMuPDF Fast digital text Cannot handle scans or image layouts Docling Tables (97.9% accuracy) Slow on non-table documents Marker Neural extraction for academic papers Needs GPU for speed; overkill for digital PDFs Mistral OCR Tables (96.6% TEDS), $0.002/page Cloud-only API Unstructured Enterprise platform Complex setup, paid tiers LlamaParse Cloud-native Requires API keys, not local Reducto High accuracy $0.015/page, closed source pdfmux Orchestrates all of the above Routes per page, audits, re-extracts
Open source Reducto alternative: what costs $0.015/page elsewhere is free with pdfmux's rule-based backends, or ~$0.002/page average with BYOK LLM fallback.
Development
git clone https://github.com/NameetP/pdfmux.git
cd pdfmux
python3.12 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest # 659 tests
ruff check src/ tests/
ruff format src/ tests/
Contributing
-
Fork the repo
-
Create a branch (
git checkout -b feature/your-feature) -
Write tests for new functionality
-
Ensure
pytestandruff checkpass -
Open a PR
License
pip install pdfmuxInstall
pip install pdfmux
That handles digital PDFs. For any real-world batch, install pdfmux[ocr] too β almost every directory of PDFs has at least one scan, and without OCR those pages return empty text:
pip install "pdfmux[ocr]" # β recommended β RapidOCR for scanned pages (~200MB, CPU)
Other backends, by document type:
pip install "pdfmux[tables]" # Docling β table-heavy docs (~500MB)
pip install "pdfmux[opendataloader]" # OpenDataLoader β complex layouts (Java 11+)
pip install "pdfmux[marker]" # Marker β neural extraction for academic papers
pip install "pdfmux[llm]" # Gemini fallback (default LLM)
pip install "pdfmux[llm-claude]" # Claude (Sonnet / Opus)
pip install "pdfmux[llm-openai]" # GPT-4o family
pip install "pdfmux[llm-ollama]" # Ollama (any local model)
pip install "pdfmux[llm-mistral]" # Mistral OCR API ($0.002/page)
pip install "pdfmux[llm-all]" # all LLM providers (incl. Gemma 4 via Gemini key)
pip install "pdfmux[watch]" # `pdfmux watch ` auto-convert on change
pip install "pdfmux[all]" # everything
Requires Python 3.11+.
Quick Start
CLI
# zero config β just works
pdfmux convert invoice.pdf
# invoice.pdf -> invoice.md (2 pages, 95% confidence, via pymupdf4llm)
# RAG-ready chunks with token limits
pdfmux convert report.pdf --chunk --max-tokens 500
# cost-aware extraction with budget cap
pdfmux convert report.pdf --mode economy --budget 0.50
# schema-guided structured extraction (5 built-in presets)
pdfmux convert invoice.pdf --schema invoice
# BYOK any LLM for hardest pages
pdfmux convert scan.pdf --llm-provider claude
# use a built-in or saved profile (invoices, receipts, papers, contracts, bulk-rag)
pdfmux convert invoice.pdf --profile invoices
# predict cost before running anything
pdfmux estimate big-report.pdf --llm-provider gemini
# stream pages as NDJSON as they finish (great for long documents)
pdfmux stream report.pdf --quality high
# auto-convert any new PDFs that land in a folder
pdfmux watch ./inbox/ -o ./output/
# diff two extractions side-by-side
pdfmux diff old.pdf new.pdf
# batch a directory β writes manifest.json with per-doc confidence
pdfmux convert ./docs/ -o ./output/
# CI mode: fail the run if any document is below 0.20 confidence
pdfmux convert ./docs/ -o ./output/ --strict --min-confidence 0.20
# pre-flight a directory: which extras do you actually need for THIS batch?
pdfmux doctor --check ./docs/
# results are cached by file hash β re-runs are instant; bypass with --no-cache
pdfmux convert report.pdf --no-cache
pdfmux convert report.pdf --clear-cache
Python
For batch processing, use batch_extract() β not a subprocess.run(['pdfmux', ...]) loop. Same pipeline, no per-file process spawn, handles non-ASCII filenames:
import pdfmux
from pathlib import Path
# Batch extract β yields (path, result) tuples as each PDF completes.
pdfs = list(Path("./inbox").glob("*.pdf"))
for path, result in pdfmux.batch_extract(pdfs, quality="standard"):
if isinstance(result, Exception):
print(f"FAILED {path.name}: {result}")
continue
if result.confidence
**Don't wrap pdfmux with your own pypdf/pdfplumber fallback.** pdfmux already routes per page through PyMuPDF β RapidOCR β vision LLM. PyMuPDF tolerates malformed PDFs that pypdf rejects ("Stream has ended unexpectedly"), so a downstream pypdf fallback turns recoverable PDFs into failures. Trust the router; check the confidence score on the result.
## BYOK LLM Configuration
pdfmux supports any LLM via 5 lines of YAML. Bring your own keys -- nothing leaves your machine unless you configure it to.
~/.pdfmux/llm.yaml
provider: claude # gemini | claude | openai | ollama | any OpenAI-compatible model: claude-sonnet-4-20250514 api_key: ${ANTHROPIC_API_KEY} base_url: https://api.anthropic.com # optional, for custom endpoints max_cost_per_page: 0.02 # budget cap
Supported providers:
Provider Models Local? Cost
Gemini 2.5 Flash, 2.5 Pro No ~$0.01/page
Gemma 4 27B IT, 12B IT (great for Arabic) No (via Gemini key) ~$0.005/page
Claude Sonnet, Opus No ~$0.015/page
GPT-4o GPT-4o, GPT-4o-mini No ~$0.01/page
Mistral `mistral-ocr-latest` No $0.002/page
Ollama Any local model Yes Free
Custom Any OpenAI-compatible API Configurable Varies
Every provider's `extract_page()` is wrapped in `@with_retry(max_attempts=3, backoff_base=2.0)`, which honors `Retry-After` headers on 429s and skips
retries on auth failures so a bad key fails fast.No common issues documented yet. If you hit a problem, the repository's GitHub Issues page is the best place to look.