综合介绍
Paperless-AI 是一个创新的文档自动化分析工具,专门为 Paperless-ngx 文档管理系统设计。它巧妙地结合了 OpenAI API 和 Ollama 等多种先进的人工智能模型(包括 Mistral、LLaMA、PHI-3 和 Gemma 2),以实现文档的智能分析和自动标记功能。该项目采用 MIT 许可证开源,支持多种运行模式,既可以使用 OpenAI 的云服务,也可以通过 Ollama 实现本地化部署,充分保障了用户数据的隐私安全。系统配备了现代化的直观Web界面,不仅支持自动化处理模式,还提供了手动分析选项,让用户可以根据具体需求灵活选择。特别值得一提的是,它还内置了智能文档问答功能,用户可以直接与文档进行AI对话,显著提升了文档管理和信息获取的效率。
功能列表
- 自动模式:AI自动分析和标记新上传的文档
- 手动模式:允许用户手动选择需要AI分析的文档
- 双引擎支持:可选择使用OpenAI API或Ollama本地模型
- 智能文档问答:支持与文档内容进行AI对话交互
- 多模型支持:兼容Mistral、LLaMA、PHI-3、Gemma 2等AI模型
- 现代化Web界面:直观易用的用户操作界面
- 自动标签系统:智能生成文档相关标签
- 文档内容分析:自动提取和理解文档关键信息
- 灵活的配置选项:支持自定义API设置和模型参数
- 实时处理状态:提供文档处理进度的实时反馈
使用帮助
1. 安装配置
1.1 前置要求:
- 已安装并配置好Paperless-ngx系统
- Node.js环境(推荐v18或更高版本)
- 可选:OpenAI API密钥或Ollama本地部署
1.2 基础安装步骤:
# 克隆仓库
git clone https://github.com/clusterzx/paperless-ai
cd paperless-ai
# 安装依赖
npm install
# 配置环境变量
cp .env.example .env
1.3 环境变量配置:
编辑.env文件,设置必要的配置项:
- PAPERLESS_URL:您的Paperless-ngx实例URL
- PAPERLESS_TOKEN:Paperless-ngx API令牌
- OPENAI_API_KEY:如果使用OpenAI,填入API密钥
- OLLAMA_URL:如果使用Ollama,填入本地服务URL
2. 运行使用
2.1 启动服务:
npm start
启动后访问 http://localhost:3000 进入Web界面
2.2 功能操作指南:
- 自动模式:
- 在Web界面中启用自动模式
- 系统会自动检测新上传的文档
- AI自动分析文档内容并生成标签
- 手动模式:
- 在文档列表中选择需要分析的文档
- 点击"分析"按钮启动处理
- 等待AI完成分析并查看结果
- AI对话功能:
- 选择任意已处理的文档
- 点击"开始对话"按钮
- 在对话框中输入问题
- AI会基于文档内容提供答案
3. 高级配置
3.1 模型选择:
- OpenAI模式:适合需要高精度结果的场景
- Ollama本地模式:适合注重隐私或需要离线处理的场景
3.2 自定义设置:
- 可调整处理队列大小
- 配置AI模型参数
- 设置标签生成规则
- 自定义文档分析深度
4. 故障排除
- 检查网络连接和API密钥配置
- 确认Paperless-ngx服务状态
- 查看日志文件排查问题
- 确保系统资源充足