lauzcom assistant

lauzcom assistant

lauzcom assistant est une solution interactive et conviviale conçue pour fournir un accès transparent aux données critiques de Swisscom. En intégrant de puissants modèles GPT , les clients peuvent facilement poser des questions sur les données publiques de Swisscom et recevoir rapidement des réponses précises.

Dites adieu aux recherches manuelles fastidieuses et laissez lauzcom assistant révolutionner vos interactions clients.

Auteurs

Le projet lauzcom assistant est créé par :

• Carmen Marcos
• Daan Rosendal

Table des matières

• Démo
• Architecture
• Démarrage rapide
• Environnement de développement
  • Exécutez Mongo et Redis
  • Exécutez le back-end
  • Exécutez le front-end
• Licence

Démo

Vidéo de démonstration

Architecture

Démarrage rapide

Note

Assurez-vous que Docker est installé

Sous macOS ou Linux, exécutez :

./setup.sh

Il installe toutes les dépendances et permet de télécharger un modèle localement ou d'utiliser OpenAI. LauzHack Assistant s'exécute désormais sur http://localhost:5173.

Sinon, suivez ces étapes :

1. Téléchargez et ouvrez ce référentiel avec git clone [email protected]:cern-lauzhack-2023/Lauzcom-Assistant.git .

2. Créez un fichier .env dans votre répertoire racine et définissez la variable d'environnement API_KEY avec votre clé API OpenAI et VITE_API_STREAMING sur true ou false, selon que vous souhaitez ou non diffuser des réponses.

   API_KEY= < YourOpenAIKey >
   VITE_API_STREAMING=true

   Voir les variables d'environnement facultatives dans les fichiers /.env-template et /application/.env_sample.

3. Exécutez ./run-with-docker-compose.sh.

4. LauzHack Assistant s'exécute désormais sur http://localhost:5173.

Pour arrêter, appuyez sur Ctrl + C .

Environnement de développement

Exécutez Mongo et Redis

Pour le développement, seuls deux conteneurs sont utilisés à partir de docker-compose.yaml (en supprimant tous les services sauf Redis et Mongo). Voir le fichier docker-compose-dev.yaml.

Courir:

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

Exécutez le back-end

Note

Assurez-vous que Python 3.10 ou 3.11 est installé.

1. Exportez les variables d'environnement requises ou préparez un fichier .env dans le dossier /application .
   • Copiez .env_sample et créez .env avec votre jeton API OpenAI pour les champs API_KEY et EMBEDDINGS_KEY .

(consultez application/core/settings.py si vous souhaitez voir plus d'options de configuration.)

2. (facultatif) Créez un environnement virtuel Python : suivez la documentation officielle Python pour les environnements virtuels.

   a) Sous Linux et macOS :

   python -m venv venv
   . venv/bin/activate

   b) Sous Windows :

   python -m venv venv
   venv/Scripts/activate

3. Installez les dépendances pour le backend :

pip install -r application/requirements.txt

4. Exécutez l'application en utilisant :

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

L'API backend s'exécute désormais sur http://localhost:7091.

5. Commencez le travailleur avec :

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

Exécutez le front-end

Note

Assurez-vous que vous disposez de la version 16 ou supérieure de Node.

1. Accédez au dossier /frontend.
2. Installez les packages requis husky et vite (ignorez s'ils sont déjà installés).

npm install husky -g
npm install vite -g

3. Installez les dépendances en exécutant :

npm install --include=dev

4. Exécutez l'application en utilisant :

npm run dev

Le frontend s'exécute désormais sur http://localhost:5173.

Licence

La licence du code source est MIT, comme décrit dans le fichier LICENSE.

Construit avec ? ? LangChaîne