lauzcom assistant

lauzcom assistant

lauzcom assistant ist eine interaktive und benutzerfreundliche Lösung für den nahtlosen Zugriff auf wichtige Swisscom-Daten. Durch die Integration leistungsstarker GPT- Modelle können Kunden ganz einfach Fragen zu öffentlichen Swisscom-Daten stellen und erhalten schnell präzise Antworten.

Verabschieden Sie sich von zeitraubenden manuellen Suchen und lassen Sie lauzcom assistant Ihre Kundeninteraktionen revolutionieren.

Autoren

Das lauzcom assistant -Projekt wird erstellt von:

• Carmen Marcos
• Daan Rosendal

Inhaltsverzeichnis

• Demo
• Architektur
• Schnellstart
• Entwicklungsumgebung
  • Führen Sie Mongo und Redis aus
  • Führen Sie das Backend aus
  • Führen Sie das Frontend aus
• Lizenz

Demo

Demovideo

Architektur

Schnellstart

Notiz

Stellen Sie sicher, dass Docker installiert ist

Führen Sie unter macOS oder Linux Folgendes aus:

./setup.sh

Es installiert alle Abhängigkeiten und ermöglicht Ihnen, ein Modell lokal herunterzuladen oder OpenAI zu verwenden. LauzHack Assistant läuft jetzt unter http://localhost:5173.

Andernfalls befolgen Sie diese Schritte:

1. Laden Sie dieses Repository herunter und öffnen Sie es mit git clone [email protected]:cern-lauzhack-2023/Lauzcom-Assistant.git .

2. Erstellen Sie eine .env Datei in Ihrem Stammverzeichnis und setzen Sie die env-Variable API_KEY mit Ihrem OpenAI-API-Schlüssel und VITE_API_STREAMING auf true oder false, je nachdem, ob Sie Streaming-Antworten wünschen oder nicht.

   API_KEY= < YourOpenAIKey >
   VITE_API_STREAMING=true

   Siehe optionale Umgebungsvariablen in den Dateien /.env-template und /application/.env_sample.

3. Führen Sie ./run-with-docker-compose.sh aus.

4. LauzHack Assistant läuft jetzt unter http://localhost:5173.

Zum Anhalten drücken Sie Ctrl + C

Entwicklungsumgebung

Führen Sie Mongo und Redis aus

Für die Entwicklung werden nur zwei Container aus docker-compose.yaml verwendet (durch Löschung aller Dienste außer Redis und Mongo). Siehe Datei docker-compose-dev.yaml.

Laufen:

docker compose -f docker-compose-dev.yaml build
docker compose -f docker-compose-dev.yaml up -d

Führen Sie das Backend aus

Notiz

Stellen Sie sicher, dass Python 3.10 oder 3.11 installiert ist.

1. Exportieren Sie die erforderlichen Umgebungsvariablen oder bereiten Sie eine .env Datei im Ordner /application vor.
   • Kopieren Sie .env_sample und erstellen Sie .env mit Ihrem OpenAI-API-Token für die Felder API_KEY und EMBEDDINGS_KEY .

(Schauen Sie sich application/core/settings.py an, wenn Sie weitere Konfigurationsoptionen sehen möchten.)

2. (optional) Erstellen Sie eine virtuelle Python-Umgebung: Befolgen Sie die offizielle Python-Dokumentation für virtuelle Umgebungen.

   a) Unter Linux und macOS:

   python -m venv venv
   . venv/bin/activate

   b) Unter Windows:

   python -m venv venv
   venv/Scripts/activate

3. Abhängigkeiten für das Backend installieren:

pip install -r application/requirements.txt

4. Führen Sie die App aus mit:

flask --app application/app.py run --host=0.0.0.0 --port=7091

Die Backend-API läuft jetzt unter http://localhost:7091.

5. Worker starten mit:

celery -A application.app.celery worker -l INFO

Führen Sie das Frontend aus

Notiz

Stellen Sie sicher, dass Sie über die Node-Version 16 oder höher verfügen.

1. Navigieren Sie zum Ordner /frontend.
2. Installieren Sie die erforderlichen Pakete husky und vite (ignorieren, falls bereits installiert).

npm install husky -g
npm install vite -g

3. Installieren Sie Abhängigkeiten, indem Sie Folgendes ausführen:

npm install --include=dev

4. Führen Sie die App aus mit:

npm run dev

Das Frontend läuft jetzt unter http://localhost:5173.

Lizenz

Die Quellcodelizenz ist MIT, wie in der LICENSE-Datei beschrieben.

Gebaut mit ? ? LangChain