File size: 2,094 Bytes
a45ad9d b491a40 55ad495 a45ad9d 06ccc5a b491a40 06ccc5a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | ---
title: dots.ocr Parser
emoji: 📄
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: 4.44.0
app_file: app.py
pinned: false
license: apache-2.0
---
# DotsOCR Document Parser API
Multilingual document parsing powered by dots.ocr - 1.7B parameter Vision-Language Model for Document Understanding.
**Live API**: https://isseygino911-dots-ocr-parser.hf.space
## 🚀 Quick Links
- **[API Usage Guide](./API_USAGE_GUIDE.md)** - Complete examples for Python, JavaScript, React
- **[Interactive API Docs](https://isseygino911-dots-ocr-parser.hf.space/docs)** - Test endpoints
- **[Quick Start](./QUICKSTART.md)** - 5-minute setup guide
- **[Deployment](./DEPLOYMENT.md)** - Production deployment guide
## ⚡ Quick Test
```bash
# Test with Python
python test_upload.py your_document.pdf
# Or use cURL
curl -X POST https://isseygino911-dots-ocr-parser.hf.space/api/parse/image \
-F "file=@image.jpg" \
-F "prompt_mode=prompt_layout_all_en"
```
## 📖 What It Does
- **Extract text** from images and PDFs with high accuracy
- **Detect layout** - identifies titles, paragraphs, tables, figures, etc.
- **Generate structured output** - Markdown + JSON with bounding boxes
- **Process PDFs** - Handles multi-page documents automatically
- **Real-time progress** - WebSocket and HTTP polling support
## 🛠️ Features
- FastAPI backend with automatic OpenAPI documentation
- GPU-accelerated processing on HuggingFace Spaces
- RESTful API with WebSocket support for real-time updates
- Comprehensive examples for Python, JavaScript, and React
- Download results as ZIP with annotated images
## 📚 Documentation
See [API_USAGE_GUIDE.md](./API_USAGE_GUIDE.md) for:
- Complete API reference
- Python backend examples
- JavaScript/React frontend examples
- Error handling best practices
- WebSocket integration
## 🔧 Local Testing
```bash
# Clone the repo
git clone https://huggingface.co/spaces/isseygino911/dots-ocr-parser
cd dots-ocr-parser
# Test the API
python test_upload.py test.png
```
## 📄 License
Apache 2.0 - See dots.ocr repository for model license details |