ED-Tech Company QA Assistent
Dieses Projekt ist eine QA-Assistentin (Frage-Answering) für ein ED-Tech-Unternehmen. Es nutzt Vektordatenbanken, hochmoderne Sprachmodelle und benutzerdefinierte Dokumenten-Einbettungen, um Benutzeranfragen auf der Grundlage einer vordefinierten Wissensbasis genaue Antworten zu geben.
Inhaltsverzeichnis
- Merkmale
- Installation
- Verwendung
- Projektstruktur
- Zukünftige Verbesserungen
- Beitragen
- Lizenz
Merkmale
- Vektordatenbank : Verwendet FAISS für die effiziente Ähnlichkeitssuche in der Wissensbasis.
- Benutzerdefinierte Einbettungen : Angetrieben, indem Sie Faceembeding mit dem Modell der Satztransformatoren/des All-Minilm-L6-V2-Modells verwenden.
- Großspracher Modell (LLM) : Integriert das LLAMA3-Modell von COQ (LLAMA3-8B-8192) zur Erzeugung von kontextbewussten Antworten.
- CSV Loader : Lädt FAQs oder andere strukturierte Daten aus CSV -Dateien, um die Wissensbasis zu füllen.
- Streamlit -Schnittstelle : Eine einfache und interaktive Benutzeroberfläche zum Stellen von Fragen und zum Empfangen von Antworten.
Installation
- Klonen Sie das Repository:
git clone https : // github . com / shaadclt / Ed - Tech - Company - QA - Assistant . git
cd Ed - Tech - Company - QA - Assistant
- Richten Sie eine virtuelle Umgebung ein:
python - m venv venv
source venv / bin / activate # On Windows, use `venvScriptsactivate`
- Abhängigkeiten installieren:
pip install - r requirements . txt
- Umgebungsvariablen: Erstellen Sie eine .env -Datei im Projektroot und fügen Sie Ihren COQ -API -Schlüssel hinzu:
GROQ_API_KEY = your_groq_api_key_here
Verwendung
- Führen Sie die Streamlit -App aus
Erstellen Sie die Wissensbasis: Um die Wissensbasis aus einer CSV -Datei zu erstellen, klicken Sie auf die Schaltfläche Erstellen Sie KnowledgeBase.
Stellen Sie eine Frage: Geben Sie eine Frage in die optimistische Schnittstelle ein, und der Assistent liefert eine kontextuell genaue Antwort basierend auf der geladenen Wissensbasis.
Projektstruktur
- Langchain_helper.py : Enthält die Logik zum Laden von Daten, zum Erstellen der Vektordatenbank und zum Generieren von Antworten.
- main.py : Die streamlit -Anwendungsdatei.
- FAQS.CSV : Eine Beispiel -CSV -Datei, mit der die Wissensbasis gefüllt ist.
- Anforderungen.txt : Listet alle erforderlichen Python -Pakete auf.
- .Env : Speichert Umgebungsvariablen wie API -Schlüssel (nicht aus Sicherheitsgründen im Repository enthalten).
Zukünftige Verbesserungen
- Wissensbasis erweitern: Fügen Sie weitere Dokumente oder Datenquellen hinzu.
- Fein-Tun-Modelle: Passen Sie die Einbettung oder LLM für genauere Antworten an.
- Erweiterte Benutzeroberfläche: Verbessern Sie die optimistische Schnittstelle mit zusätzlichen Funktionen wie der Antwortfilterung oder Feedback -Mechanismen.
Beitragen
Fühlen Sie sich frei, dieses Repository zu geben, eine Feature -Filiale zu erstellen und eine Pull -Anfrage für Verbesserungen oder Fehlerbehebungen einzureichen.
Lizenz
Dieses Projekt ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie in der Lizenzdatei.