Doc OCR#

Use OCR to extract text from Word (.docx) files that contain scanned pages or image-embedded content, using MinerU.

Install#

bash

npm install -g mineru-open-api
# or via Go (macOS/Linux):
go install github.com/opendatalab/MinerU-Ecosystem/cli/mineru-open-api@latest

Quick Start#

bash

# OCR extraction from .docx (requires token)
mineru-open-api extract report.docx --ocr -o ./out/

# With VLM model for better accuracy on complex image layouts
mineru-open-api extract report.docx --ocr --model vlm -o ./out/

Authentication#

Token required:

bash

mineru-open-api auth             # Interactive token setup
export MINERU_TOKEN="your-token" # Or via environment variable

Create token at: https://mineru.net/apiManage/token

Capabilities#

• Supported input: .docx (local file or URL)
• OCR is only available via extract (requires token)
• Use --ocr flag to enable OCR on image-embedded content
• Use --model vlm for complex or mixed-content documents
• Language hint with --language (default: ch, use en for English)

Notes#

• OCR is NOT available in flash-extract — use extract with --ocr
• If the .docx has a normal text layer, OCR is not needed — use doc-extract instead
• Output goes to stdout by default; use -o <dir> to save to a file or directory
• All progress/status messages go to stderr; document content goes to stdout
• MinerU is open-source by OpenDataLab (Shanghai AI Lab): https://github.com/opendatalab/MinerU