{"id":22706163,"url":"https://github.com/clusterzx/paperless-ai","last_synced_at":"2025-05-14T03:11:16.530Z","repository":{"id":265941504,"uuid":"896927006","full_name":"clusterzx/paperless-ai","owner":"clusterzx","description":"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.","archived":false,"fork":false,"pushed_at":"2025-04-29T15:59:02.000Z","size":14673,"stargazers_count":3081,"open_issues_count":17,"forks_count":112,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-08T20:54:54.256Z","etag":null,"topics":["ai","automation","gemma","gemma2","llama","mistral","ollama","paperless","paperless-ng","paperless-ngx","phi"],"latest_commit_sha":null,"homepage":"https://clusterzx.github.io/paperless-ai/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clusterzx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["clusterzx"]}},"created_at":"2024-12-01T16:41:07.000Z","updated_at":"2025-05-08T18:56:21.000Z","dependencies_parsed_at":"2024-12-17T21:22:57.108Z","dependency_job_id":"bc022b52-a449-4e65-9341-2c2e8cd1df81","html_url":"https://github.com/clusterzx/paperless-ai","commit_stats":null,"previous_names":["clusterzx/paperless-ai"],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clusterzx%2Fpaperless-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clusterzx%2Fpaperless-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clusterzx%2Fpaperless-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clusterzx%2Fpaperless-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clusterzx","download_url":"https://codeload.github.com/clusterzx/paperless-ai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254059517,"owners_count":22007770,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","automation","gemma","gemma2","llama","mistral","ollama","paperless","paperless-ng","paperless-ngx","phi"],"created_at":"2024-12-10T10:07:39.189Z","updated_at":"2025-05-14T03:11:11.520Z","avatar_url":"https://github.com/clusterzx.png","language":"JavaScript","funding_links":["https://github.com/sponsors/clusterzx"],"categories":["JavaScript","Langchain","A01_文本生成_文本对话","5. Retrieval-Augmented Generation (RAG) \u0026 Knowledge"],"sub_categories":["大语言对话模型及数据"],"readme":"![GitHub commit activity](https://img.shields.io/github/commit-activity/t/clusterzx/paperless-ai) ![Docker Pulls](https://img.shields.io/docker/pulls/clusterzx/paperless-ai) ![GitHub User's stars](https://img.shields.io/github/stars/clusterzx) ![GitHub License](https://img.shields.io/github/license/clusterzx/paperless-ai?cacheSeconds=1)\n\n# Paperless-AI\n\nAn automated document analyzer for Paperless-ngx using OpenAI API, Ollama and all OpenAI API compatible Services to automatically analyze and tag your documents. \\\nIt features: Automode, Manual Mode, Ollama and OpenAI, a Chat function to query your documents with AI, a modern and intuitive Webinterface. \\\n\\\n**Following Services and OpenAI API compatible services have been successfully tested:**\n- Ollama\n- OpenAI\n- DeepSeek.ai\n- OpenRouter.ai\n- Perplexity.ai\n- Together.ai\n- VLLM\n- LiteLLM\n- Fastchat\n- Gemini (Google)\n- ... and there are possibly many more\n\n![PPAI_SHOWCASE3](https://github.com/user-attachments/assets/1fc9f470-6e45-43e0-a212-b8fa6225e8dd)\n\n\n## Features\n\n### Automated Document Management\n- **Automatic Scanning**: Identifies and processes new documents within Paperless-ngx.\n- **AI-Powered Analysis**: Leverages OpenAI API and Ollama (Mistral, Llama, Phi 3, Gemma 2) for precise document analysis.\n- **Metadata Assignment**: Automatically assigns titles, tags, document_type and correspondent details.\n\n### Advanced Customization Options\n- **Predefined Processing Rules**: Specify which documents to process based on existing tags. *(Optional)* 🆕\n- **Selective Tag Assignment**: Use only selected tags for processing. *(Disables the prompt dialog)* 🆕\n- **Custom Tagging**: Assign a specific tag (of your choice) to AI-processed documents for easy identification. 🆕\n\n### Manual Mode\n- **AI-Assisted Analysis**: Manually analyze documents with AI support in a modern web interface. *(Accessible via the `/manual` endpoint)* 🆕\n\n### Interactive Chat Functionality\n- **Document Querying**: Ask questions about your documents and receive accurate, AI-generated answers. 🆕\n\n## Installation\n\nVisit the Wiki for installation:\\\n[Click here for Installation](https://github.com/clusterzx/paperless-ai/wiki/2.-Installation)\n-------------------------------------------\n\n\n## Docker Support\n\nThe application comes with full Docker support:\n\n- Automatic container restart on failure\n- Health monitoring\n- Volume persistence for database\n- Resource management\n- Graceful shutdown handling\n\n## Development\n\nTo run the application locally without Docker:\n\n1. Install dependencies:\n```bash\nnpm install\n```\n\n2. Start the development server:\n```bash\nnpm run test\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) for the amazing document management system\n- OpenAI API\n- The Express.js and Node.js communities for their excellent tools\n\n## Support\n\nIf you encounter any issues or have questions:\n\n1. Check the [Issues](https://github.com/clusterzx/paperless-ai/issues) section\n2. Create a new issue if yours isn't already listed\n3. Provide detailed information about your setup and the problem\n\n## Roadmap (DONE)\n\n- [x] Support for custom AI models\n- [x] Support for multiple language analysis\n- [x] Advanced tag matching algorithms\n- [x] Custom rules for document processing\n- [x] Enhanced web interface with statistics\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclusterzx%2Fpaperless-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclusterzx%2Fpaperless-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclusterzx%2Fpaperless-ai/lists"}