SmartRead: anota automáticamente documentos técnicos en PDF y proporciona citas relevantes

Introducción general

SmartRead 是一个基于 AI 的开源工具，专为技术文档设计。它能自动分析 PDF 文件，标注关键内容，比如重要术语、标题或核心观点，帮助用户快速理解复杂文档。同时，它还能提供与文档主题相关的文章和视频链接，让学习更全面。这个项目由开发者 Dev-Khant 在 GitHub 上发布，代码完全公开，免费使用。SmartRead 适合技术人员、学生或研究者，尤其对需要高效阅读技术类 PDF 的人非常实用。

Lista de funciones

• 自动为技术 PDF 添加标注，突出关键内容，比如术语、标题或重点段落。
• 根据文档内容推荐相关文章和视频，提升理解深度。
• 支持处理各种技术类 PDF 文件，让复杂文档更易读。
• 允许下载标注后的 PDF 文件，保留所有高亮和注释。
• 开源设计，用户可查看代码、修改功能或提交改进建议。

Utilizar la ayuda

SmartRead 是一个托管在 GitHub 上的开源项目，用户需要通过安装和配置来使用。以下是详细步骤，帮助你从下载到上手操作。

Proceso de instalación

SmartRead 分前端和后端两部分运行，需要准备开发环境。以下是具体安装步骤：

Preparar el entorno

1. 安装基础工具
   • 下载 Git（git-scm.com），用于克隆代码。
   • 安装 Node.js（版本 18+，nodejs.org），用于前端。
   • 安装 Python（版本 3.12，python.org），用于后端本地开发。
   • 安装 Docker（docker.com），用于后端容器化运行。
2. Descargar código
   • Abre un terminal y ejecútalo:

     git clone https://github.com/Dev-Khant/smartread.git
     cd smartread
     

3. Configuración de variables de entorno
   • Copie el archivo de ejemplo:

     cp backend/.env.example backend/.env
     cp web/.env.example web/.env.local
     

   • compilador backend/.env，填入以下内容（需自行获取密钥）：

     PORT=8000
     HOST=0.0.0.0
     ENVIRONMENT=development
     MONGODB_URL=mongodb://你的MongoDB地址
     MISTRAL_API_KEY=你的Mistral密钥
     GROQ_API_KEY=你的Groq密钥
     CLOUDINARY_CLOUD_NAME=你的Cloudinary名称
     CLOUDINARY_API_KEY=你的Cloudinary密钥
     CLOUDINARY_API_SECRET=你的Cloudinary秘钥
     

   • compilador web/.env.local::

     NEXT_PUBLIC_BACKEND_API_URL=http://localhost:8000
     

安装并运行前端

1. 进入前端目录：

cd web

2. Instale la dependencia:

npm install

3. Comienza la parte delantera:

npm run dev

4. Abra su navegador y visite http://localhost:3000Puedes ver la interfaz del front-end.

安装并运行后端

• 使用 Docker（推荐）

1. Vaya al directorio back-end:

cd backend

2. Construye la imagen del espejo:

docker build -t smartread-backend .

3. Ejecuta el contenedor:

docker run -p 8000:8000 --env-file .env smartread-backend

• 本地开发（无 Docker）

1. Vaya al directorio back-end:

cd backend

2. Crea un entorno virtual y actívalo:

python -m venv .venv
source .venv/bin/activate  # Windows 用 .venv\Scripts\activate

3. Instale la dependencia:

pip install -r requirements.txt

4. Empieza la parte de atrás:

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Cómo utilizar las principales funciones

安装完成后，SmartRead 的核心功能围绕 PDF 处理和资源推荐展开。

功能 1：自动标注技术 PDF

• procedimiento

1. 准备一个技术 PDF 文件（如论文或手册）。
2. 将文件上传到前端界面（http://localhost:3000），或放入 backend/input Carpeta.
3. 在前端点击“上传并标注”，或在后端运行：

python main.py --file input/你的文件名.pdf

4. 处理完成后，标注后的 PDF 会出现在 backend/output Carpeta.

• Descripción funcional
  SmartRead 使用 Mistral AI responder cantando Groq 模型分析文档，识别关键内容并添加高亮或注释。标注结果会显示在 PDF 上，方便快速阅读。

功能 2：获取相关资源

• procedimiento

1. 在前端界面上传 PDF 后，勾选“获取相关资源”。
2. 或在后端运行：

python main.py --file input/你的文件名.pdf --resources

3. 处理完成后，界面或终端会显示文章和视频链接。

• Descripción funcional
  系统会根据 PDF 内容搜索网络，推荐相关技术文章或视频，链接存储在 MongoDB 中，由 Cloudinary 管理。

功能 3：下载标注后的 PDF

• procedimiento

1. 在前端界面点击“下载”，或进入 backend/output Carpeta.
2. localice 你的文件名_annotated.pdf，直接保存。

• Descripción funcional
  标注后的 PDF 保留原文，新增高亮和注释，便于分享或存档。

Función destacada Operación

contribución al código abierto

• procedimiento

1. 修改代码后，提交到 GitHub：

git add .
git commit -m "你的修改说明"
git push origin main

2. 在 GitHub 上创建 Pull Request。

• Descripción funcional
  SmartRead 使用 MIT 许可证，鼓励用户参与开发，改进 AI 模型或界面。

advertencia

• 确保 MongoDB、Mistral AI、Groq 和 Cloudinary 的密钥正确配置，否则功能会受限。
• 当前版本更适合英文技术文档，中文支持可能需要优化。
• Docker 运行更稳定，建议优先使用。

通过这些步骤，你可以完整使用 SmartRead 处理技术 PDF。操作简单，结果直观，非常适合需要深入阅读的人。

escenario de aplicación

1. investigación académica
   学生处理论文时，SmartRead 标注重点并推荐相关资源，节省查找时间。
2. desarrollo tecnológico
   程序员阅读 API 文档时，用它高亮关键参数，同时获取教程视频。
3. Trabajo en equipo
   项目组整理技术手册，统一标注后分享，提升沟通效率。

CONTROL DE CALIDAD

1. SmartRead 支持中文 PDF 吗？
   当前更适合英文技术文档，中文支持正在优化中。
2. ¿Necesito trabajar en red?
   是的，获取相关资源和运行 AI 模型需要网络连接。
3. ¿Se puede utilizar sin conexión?
   标注功能可离线运行，但资源推荐需要在线。