base on An automated document analyzer for Paperless-ngx using OpenAI API, Ollama, Deepseek-r1, Azure and all OpenAI API compatible Services to automatically analyze and tag your documents. # 📄 Paperless-AI [](https://github.com/clusterzx/paperless-ai/commits/main) [](https://hub.docker.com/r/clusterzx/paperless-ai) [](https://github.com/clusterzx) [](LICENSE) --- **Paperless-AI** is an AI-powered extension for [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) that brings automatic document classification, smart tagging, and semantic search using OpenAI-compatible APIs and Ollama. It enables **fully automated document workflows**, **contextual chat**, and **powerful customization** — all via an intuitive web interface. > 💡 Just ask: > “When did I sign my rental agreement?” > “What was the amount of the last electricity bill?” > “Which documents mention my health insurance?” Powered by **Retrieval-Augmented Generation (RAG)**, you can now search semantically across your full archive and get precise, natural language answers. --- ## ✨ Features ### 🔄 Automated Document Processing - Detects new documents in Paperless-ngx automatically - Analyzes content using OpenAI API, Ollama, and other compatible backends - Assigns title, tags, document type, and correspondent - Built-in support for: - Ollama (Mistral, Llama, Phi-3, Gemma-2) - OpenAI - DeepSeek.ai - OpenRouter.ai - Perplexity.ai - Together.ai - LiteLLM - VLLM - Fastchat - Gemini (Google) - ...and more! ### 🧠 RAG-Based AI Chat - Natural language document search and Q&A - Understands full document context (not just keywords) - Semantic memory powered by your own data - Fast, intelligent, privacy-friendly document queries  ### ⚙️ Manual Processing - Web interface for manual AI tagging - Useful when reviewing sensitive documents - Accessible via `/manual` ### 🧩 Smart Tagging & Rules - Define rules to limit which documents are processed - Disable prompts and apply tags automatically - Set custom output tags for tracked classification  --- ## 🚀 Installation > ⚠️ **First-time install:** Restart the container **after completing setup** (API keys, preferences) to build RAG index. > 🔁 Not required for updates. 📘 [Installation Wiki](https://github.com/clusterzx/paperless-ai/wiki/2.-Installation) --- ## 🐳 Docker Support - Health monitoring and auto-restart - Persistent volumes and graceful shutdown - Works out of the box with minimal setup --- ## 🔧 Local Development ```bash # Install dependencies npm install # Start development/test mode npm run test ``` --- ## 🧭 Roadmap Highlights - ✅ Multi-AI model support - ✅ Multilingual document analysis - ✅ Tag rules and filters - ✅ Integrated document chat with RAG - ✅ Responsive web interface --- ## 🤝 Contributing We welcome PRs and contributions! ```bash # Fork, clone, then: git checkout -b feature/YourFeature # After changes: git commit -m "Add YourFeature" git push origin feature/YourFeature ``` Then open a Pull Request via GitHub. --- ## 🆘 Support & Community - [Issues](https://github.com/clusterzx/paperless-ai/issues) - [Discord](https://discord.gg/AvNekAfK38) --- ## 📄 License This project is licensed under the MIT License. See [LICENSE](LICENSE) for details. --- ## 🙏 Support Development [](https://www.patreon.com/c/clusterzx) [](https://www.paypal.com/paypalme/bech0r) [](https://www.buymeacoffee.com/clusterzx) [](https://ko-fi.com/clusterzx) ", Assign "at most 3 tags" to the expected json: {"id":"13137","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"