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

Introducción general

SmartRead es una herramienta de código abierto basada en IA y diseñada para documentos técnicos. Analiza automáticamente archivos PDF y anota contenidos clave, como términos importantes, títulos o ideas centrales, para ayudar a los usuarios a comprender rápidamente documentos complejos. Al mismo tiempo, también puede proporcionar artículos y enlaces a vídeos relacionados con el tema del documento, para que el aprendizaje sea más completo. Este proyecto fue publicado por el desarrollador Dev-Khant en GitHub, el código es completamente público y de uso gratuito. smartRead es adecuado para técnicos, estudiantes o investigadores, especialmente útil para personas que necesitan leer PDF técnicos de manera eficiente.

Lista de funciones

• Añada automáticamente anotaciones a los PDF técnicos para resaltar el contenido clave, como términos, títulos o pasajes resaltados.
• Recomendar artículos y vídeos pertinentes basados en el contenido del documento para profundizar en su comprensión.
• Admite el procesamiento de una amplia gama de archivos PDF técnicos, lo que facilita la lectura de documentos complejos.
• Permite descargar archivos PDF anotados conservando todos los resaltados y anotaciones.
• El diseño de código abierto permite a los usuarios ver el código, modificar funciones o enviar sugerencias de mejora.

Utilizar la ayuda

SmartRead es un proyecto de código abierto alojado en GitHub que los usuarios deben instalar y configurar para poder utilizarlo. A continuación se detallan los pasos que le ayudarán a pasar de la descarga a la puesta en marcha.

Proceso de instalación

SmartRead se ejecuta en dos partes, front-end y back-end, y requiere la preparación de un entorno de desarrollo. A continuación se indican los pasos específicos de instalación:

Preparar el entorno

1. Instalación de herramientas básicas
   • Descargar Git (git-scm.com) para clonar código.
   • Instala Node.js (versión 18+.nodejs.org) para la parte delantera.
   • Instale Python (versión 3.12.python.org) para el desarrollo local de back-end.
   • Instalar Docker (docker.com) para las ejecuciones en contenedores de back-end.
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/.envRellene lo siguiente (deberá obtener la clave usted mismo):

     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
     

Instalar y ejecutar el front-end

1. Vaya al directorio del front-end:

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.

Instalar y ejecutar el backend

• Uso de Docker (recomendado)

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

• Desarrollo local (sin 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

Una vez instalado, la funcionalidad principal de SmartRead gira en torno al procesamiento de PDF y las recomendaciones de recursos.

Función 1: tecnología de anotación automática PDF

• procedimiento

1. Prepare un archivo PDF técnico (por ejemplo, un documento o un manual).
2. Cargar archivos en la interfaz del front-end (http://localhost:3000), o en el backend/input Carpeta.
3. Haga clic en "Cargar y etiquetar" en el front end, o ejecútelo en el back end:

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

4. Una vez finalizado el procesamiento, el PDF anotado aparece en la carpeta backend/output Carpeta.

• Descripción funcional
  Uso de SmartRead Mistral AI responder cantando Groq El modelo analiza el documento, identifica los contenidos clave y añade resaltados o anotaciones. Los resultados de las anotaciones se muestran en el PDF para facilitar su lectura.

Función 2: Acceso a los recursos pertinentes

• procedimiento

1. Después de cargar el PDF en la interfaz del front-end, marque la casilla "Obtener recursos relacionados".
2. o ejecutar en el extremo posterior:

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

3. Una vez finalizado el procesamiento, la interfaz o el terminal muestran enlaces a artículos y vídeos.

• Descripción funcional
  El sistema busca en la web basándose en el contenido del PDF y recomienda artículos técnicos o vídeos relevantes, con enlaces almacenados en MongoDB y gestionados por Cloudinary.

Función 3: Descargar PDF anotado

• procedimiento

1. Haga clic en "Descargar" en la interfaz del front-end, o vaya a backend/output Carpeta.
2. localice 你的文件名_annotated.pdfGuárdelo directamente.

• Descripción funcional
  El PDF anotado conserva el texto original con nuevos resaltados y anotaciones para compartirlo o archivarlo fácilmente.

Función destacada Operación

contribución al código abierto

• procedimiento

1. Modifica el código y envíalo a GitHub:

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

2. Cree una Pull Request en GitHub.

• Descripción funcional
  SmartRead utiliza la licencia MIT y anima a los usuarios a participar en el desarrollo para mejorar los modelos o interfaces de IA.

advertencia

• Asegúrese de que las claves para MongoDB, Mistral AI, Groq y Cloudinary están configuradas correctamente o la funcionalidad se verá limitada.
• La versión actual es más adecuada para la documentación técnica en inglés, puede que haya que optimizar el soporte en chino.
• Docker es más estable y se recomienda utilizarlo en primer lugar.

Con estos pasos, usted puede utilizar SmartRead Processing Technology PDF en su totalidad. fácil de usar, con resultados intuitivos, es perfecto para aquellos que necesitan una lectura en profundidad.

escenario de aplicación

1. investigación académica
   Mientras los estudiantes trabajan en sus trabajos, SmartRead ahorra tiempo de búsqueda resaltando los puntos clave y sugiriendo los recursos pertinentes.
2. desarrollo tecnológico
   Los programadores lo utilizan para resaltar parámetros clave mientras leen la documentación de la API y para acceder a vídeos tutoriales.
3. Trabajo en equipo
   El equipo del proyecto organiza los manuales técnicos, que se etiquetan uniformemente y luego se comparten para mejorar la eficacia de la comunicación.

CONTROL DE CALIDAD

1. ¿Es SmartRead compatible con PDF en chino?
   Actualmente más adecuado para la documentación técnica en inglés, se está optimizando el soporte en chino.
2. ¿Necesito trabajar en red?
   Sí, se necesita una conexión a la red para acceder a los recursos pertinentes y ejecutar los modelos de IA.
3. ¿Se puede utilizar sin conexión?
   La función de etiquetado funciona offline, pero las recomendaciones de recursos deben estar online.