SmartRead: Technische PDF-Dokumente automatisch mit Anmerkungen versehen und mit relevanten Zitaten versehen

Allgemeine Einführung

SmartRead ist ein KI-basiertes Open-Source-Tool, das für technische Dokumente entwickelt wurde. Es analysiert automatisch PDF-Dateien und kommentiert Schlüsselinhalte wie wichtige Begriffe, Überschriften oder Kernideen, um Nutzern zu helfen, komplexe Dokumente schnell zu verstehen. Gleichzeitig kann es auch Artikel und Videolinks zum Thema des Dokuments bereitstellen, so dass das Lernen noch umfassender wird. Dieses Projekt wurde von dem Entwickler Dev-Khant auf GitHub veröffentlicht, der Code ist vollständig öffentlich und kostenlos zu verwenden. smartRead ist für Techniker, Studenten oder Forscher geeignet, besonders nützlich für Menschen, die technische PDFs effizient lesen müssen.

Funktionsliste

• Fügen Sie automatisch Anmerkungen zu technischen PDF-Dateien hinzu, um wichtige Inhalte wie Begriffe, Überschriften oder hervorgehobene Passagen zu markieren.
• Empfehlen Sie relevante Artikel und Videos, die auf dem Inhalt des Dokuments basieren, um das Verständnis zu vertiefen.
• Unterstützung für die Verarbeitung einer Vielzahl von technischen PDF-Dateien, wodurch komplexe Dokumente leichter lesbar werden.
• Ermöglicht das Herunterladen von mit Anmerkungen versehenen PDF-Dateien, wobei alle Hervorhebungen und Anmerkungen erhalten bleiben.
• Das Open-Source-Design ermöglicht es den Benutzern, den Code einzusehen, Funktionen zu ändern oder Verbesserungsvorschläge zu machen.

Hilfe verwenden

SmartRead ist ein Open-Source-Projekt, das auf GitHub gehostet wird und das die Benutzer installieren und konfigurieren müssen, um es zu verwenden. Im Folgenden finden Sie detaillierte Schritte, die Sie vom Download bis zur Inbetriebnahme begleiten.

Ablauf der Installation

SmartRead besteht aus zwei Teilen, einem Front-End und einem Back-End, und erfordert die Vorbereitung einer Entwicklungsumgebung. Im Folgenden werden die einzelnen Installationsschritte beschrieben:

Vorbereiten der Umgebung

1. Installation von Basiswerkzeugen
   • Git herunterladen (git-scm.) zum Klonen von Code.
   • Installieren Sie Node.js (Version 18+.nodejs.org) für das vordere Ende.
   • Installieren Sie Python (Version 3.12.python.org) für die lokale Backend-Entwicklung.
   • Docker installieren (docker.de) für Backend-Container-Läufe.
2. Code herunterladen
   • Öffnen Sie ein Terminal und führen Sie es aus:

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

3. Umgebungsvariablen konfigurieren
   • Kopieren Sie die Beispieldatei:

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

   • Compiler backend/.envGeben Sie die folgenden Daten ein (den Schlüssel müssen Sie selbst besorgen):

     PORT=8000
     HOST=0.0.0.0
     ENVIRONMENT=Entwicklung
     MONGODB_URL=mongodb://Ihre MongoDB-Adresse
     MISTRAL_API_KEY=Ihr Mistral-Schlüssel
     GROQ_API_KEY=Ihr Groq-Schlüssel.
     CLOUDINARY_CLOUD_NAME=Ihr Cloudinary-Name
     CLOUDINARY_API_KEY=Ihr Cloudinary-Schlüssel
     CLOUDINARY_API_SECRET=Ihr geheimer Cloudinary-Schlüssel
     

   • Compiler web/.env.local::

     NEXT_PUBLIC_BACKEND_API_URL=http://localhost:8000
     

Installieren und Ausführen des Frontends

1. Wechseln Sie in das Front-End-Verzeichnis:

cd web

2. Installieren Sie die Abhängigkeit:

npm-Installation

3. Starten Sie das Frontend:

npm run dev

4. Öffnen Sie Ihren Browser und besuchen Sie http://localhost:3000Sie können die Front-End-Schnittstelle sehen.

Installieren und Ausführen des Backends

• Docker verwenden (empfohlen)

1. Wechseln Sie in das Backend-Verzeichnis:

cd backend

2. Bauen Sie das Spiegelbild:

docker build -t smartread-backend .

3. Starten Sie den Container:

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

• Lokale Entwicklung (kein Docker)

1. Wechseln Sie in das Backend-Verzeichnis:

cd backend

2. Erstellen Sie eine virtuelle Umgebung und aktivieren Sie sie:

python -m venv .venv
Quelle .venv/bin/activate # Windows mit .venv\Scripts\activate

3. Installieren Sie die Abhängigkeit:

pip install -r anforderungen.txt

4. Starten Sie das hintere Ende:

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

Verwendung der wichtigsten Funktionen

Nach der Installation dreht sich die Kernfunktionalität von SmartRead um die PDF-Verarbeitung und Ressourcenempfehlungen.

Funktion 1: Automatische Beschriftungstechnologie PDF

• Verfahren

1. Bereiten Sie eine technische PDF-Datei vor (z. B. ein Papier oder ein Handbuch).
2. Hochladen von Dateien auf die Front-End-Schnittstelle (http://localhost:3000), oder in die Backend/Eingabe Mappe.
3. Klicken Sie auf "Hochladen und beschriften" am vorderen Ende, oder führen Sie es am hinteren Ende aus:

python main.py --file input/ihr Dateiname.pdf

4. Wenn die Verarbeitung abgeschlossen ist, erscheint die kommentierte PDF-Datei im Fenster backend/output Mappe.

• Funktionelle Beschreibung
  SmartRead-Verwendung Mistral AI im Gesang antworten Groq Das Modell analysiert das Dokument, identifiziert wichtige Inhalte und fügt Hervorhebungen oder Anmerkungen hinzu. Die Ergebnisse der Kommentierung werden in der PDF-Datei angezeigt, damit sie schnell und einfach gelesen werden können.

Funktion 2: Zugang zu relevanten Ressourcen

• Verfahren

1. Nach dem Hochladen der PDF-Datei im Front-End-Interface aktivieren Sie das Kästchen "Zugehörige Ressourcen abrufen".
2. oder auf dem Backend laufen:

python main.py --file input/ihr Dateiname.pdf --resources

3. Wenn die Verarbeitung abgeschlossen ist, werden auf der Schnittstelle oder dem Terminal Links zu Artikeln und Videos angezeigt.

• Funktionelle Beschreibung
  Das System durchsucht das Internet auf der Grundlage des PDF-Inhalts und empfiehlt relevante technische Artikel oder Videos, wobei die Links in MongoDB gespeichert und von Cloudinary verwaltet werden.

Funktion 3: Download der kommentierten PDF-Datei

• Verfahren

1. Klicken Sie auf "Download" in der Front-End-Oberfläche oder gehen Sie zu backend/output Mappe.
2. ausfindig machen. Ihr Dateiname_annotiert.pdfspeichern Sie es direkt.

• Funktionelle Beschreibung
  Die kommentierte PDF-Datei enthält den Originaltext mit neuen Hervorhebungen und Anmerkungen zur einfachen Weitergabe oder Archivierung.

Featured Function Bedienung

Open-Source-Beitrag

• Verfahren

1. Ändern Sie den Code und übertragen Sie ihn auf GitHub:

git add .
git commit -m "Ihre Änderungsnotizen"
git push origin main

2. Erstellen Sie einen Pull Request auf GitHub.

• Funktionelle Beschreibung
  SmartRead verwendet die MIT-Lizenz und ermutigt die Nutzer, sich an der Entwicklung zu beteiligen, um KI-Modelle oder Schnittstellen zu verbessern.

caveat

• Stellen Sie sicher, dass die Schlüssel für MongoDB, Mistral AI, Groq und Cloudinary korrekt konfiguriert sind, da sonst die Funktionalität eingeschränkt ist.
• Die aktuelle Version eignet sich eher für englischsprachige technische Dokumentation, der chinesische Support muss eventuell noch optimiert werden.
• Docker ist stabiler und sollte daher zuerst verwendet werden.

Mit diesen Schritten können Sie SmartRead Processing Technology PDF in vollem Umfang nutzen. Einfach zu bedienen, mit intuitiven Ergebnissen, ist es perfekt für diejenigen, die in die Tiefe lesen müssen.

Anwendungsszenario

1. akademische Forschung
   Während die Schüler an ihren Papieren arbeiten, spart SmartRead Zeit bei der Suche, indem es wichtige Punkte hervorhebt und relevante Ressourcen vorschlägt.
2. Technologieentwicklung
   Programmierer verwenden es, um beim Lesen der API-Dokumentation wichtige Parameter hervorzuheben und um auf Lernvideos zuzugreifen.
3. Teamarbeit
   Das Projektteam organisiert technische Handbücher, die einheitlich beschriftet sind und dann gemeinsam genutzt werden, um die Kommunikationseffizienz zu verbessern.

QA

1. Unterstützt SmartRead chinesische PDF-Dateien?
   Derzeit eher für englischsprachige technische Dokumentation geeignet, wird die chinesische Unterstützung optimiert.
2. Brauche ich ein Netzwerk?
   Ja, eine Netzverbindung ist erforderlich, um auf relevante Ressourcen zuzugreifen und KI-Modelle auszuführen.
3. Kann es offline verwendet werden?
   Die Beschriftungsfunktion funktioniert offline, aber die Ressourcenempfehlungen müssen online sein.