clusterzx/paperless-ai

📄 Paperless‑AI – Paperless‑ngx 用的 AI 增強文件管理

是什麼 – 一個開源外掛，可接入自架設文件歸檔系統 Paperless‑ngx。它會監控新上傳的檔案，將文字送至 LLM（OpenAI 相容服務、Ollama、Gemini 等），並自動執行：

• 生成標題並選擇標籤／文件類型
• 將 LLM 產生的元資料存回 Paperless‑ngx
• 建立向量索引，讓您能對整個檔案庫提出自然語言問題（RAG 聊天）

為何重要 – 無需手動標記，即可將靜態 PDF 庫轉變為可搜尋的知識庫。所有繁重任務（嵌入、分類、聊天）均由您指定的相容 LLM 完成，因此您可將資料保留在本地（如 Ollama）或使用雲端 API。

---

核心功能

功能	你能獲得
自動處理	檢測新文件，提取文字，呼叫選定的 LLM，寫回標題、標籤、聯絡人等資訊
多模型支援	支援 Ollama（Mistral、Llama、Phi‑3、Gemma‑2 …）、OpenAI、DeepSeek、OpenRouter、Perplexity、Together、LiteLLM、VLLM、FastChat、Gemini 及任何 OpenAI 相容端點
基於 RAG 的聊天	從您的文件建構語意向量儲存；可提問如 「我何時簽了租屋合約？」 並獲得帶來源引用的自然語言回答
手動 UI	/manual 頁面可對單一文件執行 AI，適用於您希望在儲存元資料前審查的敏感文件
智慧標籤與規則	可定義過濾器限制處理文件範圍，開啟／關閉提示，將 LLM 輸出映射為自訂標籤
Docker 就緒	官方鏡像包含健康檢查、持久化卷和自動重啟；支援一鍵部署
Web 界面	與 Paperless‑ngx 集成的響應式 UI，用於設定模型、API 金鑰和檢視 RAG 聊天

---

快速開始（Docker）

1. 建立容器 – 拉取 clusterzx/paperless-ai 並掛載與 Paperless‑ngx 相同的卷，以便插件讀取 PDF 檔案。
2. 設定 – 開啟 UI，新增您的 LLM API 金鑰（OpenAI、Ollama 端點等）並設定所需的標籤規則。
3. 首次執行 – 儲存設定後重啟容器；它將掃描現有文件，產生嵌入向量並建構 RAG 索引。
4. 使用 – 新文件將自動處理。造訪聊天頁面，對整個檔案庫提出自然語言查詢。

詳細步驟請參閱 安裝 Wiki。

---

開發與貢獻

• 克隆倉儲，執行 npm install 然後 npm run test 啟動本地開發伺服器。
• 歡迎提交 PR；README 中列出了常見的 fork-branch-PR 工作流程。
• 社群支援位於 GitHub Issues 和 Discord 伺服器中。

---

許可與支援

• MIT 許可證 – 可自由使用、修改和分發。
• 作者正在尋找貢獻者；可透過 Patreon/PayPal/Ko‑fi 頁面進行可選捐款。

---

總結 – Paperless‑AI 為自架設文件檔案庫新增了 LLM 驅動的分類、標籤與語意搜尋功能，讓您僅用自然語言提問即可從 PDF 中檢索資訊，同時確保資料完全由您掌控。