reportAI

ReportAI

reportAI ist ein Python-basiertes Tool, das mithilfe von KI umfassende PDF-Forschungsberichte generiert. Geben Sie einfach Gespräche mit einem KI-Modell in einem strukturierten Format ein, und reportAI erstellt einen detaillierten Bericht mit einer Zusammenfassung sowie ordnungsgemäß formatierten Abschnitten, Tabellen und Abbildungen. Mithilfe geschickt implementierter Techniken zur Deduplizierung wiederholter Inhalte im Bericht wird sichergestellt, dass alle Inhalte direkt auf den Punkt kommen und gleichzeitig beschreibend sind, ohne dass es zu Wiederholungen im Berichtsinhalt kommt. Die endgültige Ausgabe ist eine PDF-Datei mit etwa 9 bis 15 Seiten, abhängig von der Anzahl der zur Berichterstellung übergebenen Nachrichten.

Merkmale

• Erstellt detaillierte Forschungsberichte aus KI-generierten Gesprächen.
• Erstellt Abschnitte mit Überschriften, Tabellen und Abbildungen.
• Anpassbar über Umgebungsvariablen.
• Einfach zu bedienen mit minimalem Setup.

Installation

1. Klonen Sie das Repository:

git clone https://github.com/AdirthaBorgohain/reportAI.git
cd reportAI

2. Installieren Sie die erforderlichen Abhängigkeiten:

pip install -r requirements.txt

HINWEIS : Sie benötigen python>=3.10 um dieses Projekt auszuführen, ohne Änderungen an der Codebasis vornehmen zu müssen

3. Richten Sie Ihre .env-Datei (im Verzeichnis report_ai ) mit den erforderlichen API-Schlüsseln und Modellkonfigurationen ein:

 OPENAI_API_KEY ={YOUR OPENAI API KEY}

ANTHROPIC_API_KEY ={YOUR ANTHROPIC API KEY}

LLM ={CHOICE OF LLM TO USE. Valid values are 'gpt', 'claude'}

GPT_MODEL ={GPT MODEL TO USE IN CASE LLM IS SET TO 'gpt'. Valid values are 'gpt-3.5-turbo', 'gpt-4-turbo', 'gpt-4o'}

CLAUDE_MODEL ={CLAUDE MODEL TO USE IN CASE LLM IS SET TO 'claude'. Valid values are 'claude-3-haiku', 'claude-3-opus'}

Verwendung

Schauen Sie sich main.py an, um ein Beispiel für die Erstellung von Berichten mithilfe Ihrer Konversationen zu erhalten.

Beispielbericht

Ein Beispiel für einen generierten Bericht, der mithilfe der Nachrichten in main.py erstellt wurde, finden Sie in report_ai/reports/sample.pdf .

Hier sind einige Screenshots des Beispielberichts:

Mitwirken

1. Forken Sie das Repository.
2. Erstellen Sie einen neuen Feature-Zweig ( git checkout -b feature/new-feature ).
3. Übernehmen Sie Ihre Änderungen ( git commit -m 'Add some new feature' ).
4. Zum Zweig pushen ( git push origin feature/new-feature ).
5. Öffnen Sie eine Pull-Anfrage.

Lizenz

Dieses Projekt ist unter der Apache 2.0-Lizenz lizenziert. Einzelheiten finden Sie in der LICENSE-Datei.

Dieses Projekt wird erstellt mit: