https://github.com/hajaarh/smart_bot
Chatbot
https://github.com/hajaarh/smart_bot
mistralai python streamlit
Last synced: about 2 months ago
JSON representation
Chatbot
- Host: GitHub
- URL: https://github.com/hajaarh/smart_bot
- Owner: Hajaarh
- Created: 2024-10-15T07:24:28.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T22:39:57.000Z (2 months ago)
- Last Synced: 2025-02-24T23:29:14.550Z (2 months ago)
- Topics: mistralai, python, streamlit
- Language: PowerShell
- Homepage:
- Size: 3.83 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Développement d'un Chatbot IA interactif
### Projet Chatbot
Ce projet consiste en la création d'une application web interactive permettant une conversation naturelle avec les utilisateurs, utilisant Streamlit pour l'interface utilisateur et Mistral AI pour les capacités conversationnelles. L'application est conçue pour être intuitive, sécurisée et facilement extensible.
---
## Table des matières
- Structure de l'application
- Fonctionnalités principales
- Prérequis
- Étapes d'installation et de configuration
- Cloner le projet
- Configurer un environnement Python
- Configurer l'API Mistral AI
- Lancer le projet
- Structure du projet
- Dépendances
- Résumé des commandes
---
## Structure de l'application
### 1. Backend
- **Développé en Python.**
- Communique avec l'API de Mistral AI pour générer des réponses conversationnelles.
- Intègre la gestion sécurisée des clés API via la bibliothèque dotenv.
### 2. Frontend
- **Conçu avec Streamlit** pour une interface utilisateur simple et intuitive.
- Affiche l'historique des conversations et gère les interactions en temps réel.
---
## Fonctionnalités principales
1. **Conversation naturelle**
- Les utilisateurs posent des questions et reçoivent des réponses instantanées grâce à Mistral AI.
2. **Gestion de l'historique des conversations**
- Les échanges sont affichés dans un format clair et conservés pendant la session.
3. **Sécurité des clés API**
- Les informations sensibles, comme la clé API, sont gérées via des variables d'environnement.
4. **Interface web conviviale**
- Créée avec Streamlit, elle offre une interaction fluide et intuitive.
---
## Prérequis
Avant de commencer, assurez-vous d’avoir :
- Python 3.8+ installé.
- Une clé API Mistral AI (disponible après inscription sur leur plateforme).
- Une connexion internet pour installer les dépendances et accéder à l'API.
---
## Étapes d'installation et de configuration
### 1. Cloner le projet
Téléchargez le projet depuis GitHub :
```bash
git clone https://github.com/Hajaarh/smart_bot.git
cd smart_bot
```
### 2. Configurer un environnement Python
Créez un environnement virtuel :
```bash
python -m venv venv
```
Activez l’environnement virtuel :
- **Sur Windows** :
```bash
venv\Scripts\activate
```
- **Sur macOS/Linux** :
```bash
source venv/bin/activate
```
Installez les dépendances :
```bash
pip install -r requirements.txt
```
Cela installera toutes les bibliothèques nécessaires, comme Streamlit, Mistral AI SDK, et dotenv.
### 3. Configurer l'API Mistral AI
#### 3.1 Obtenir une clé API
- Créez un compte sur la plateforme Mistral AI.
- Récupérez votre clé API depuis votre tableau de bord utilisateur.
#### 3.2 Configurer les variables d’environnement
- À la racine du projet, créez un fichier `.env` contenant la clé API :
```plaintext
API_KEY=your_mistral_api_key_here
```
- L’application chargera automatiquement cette clé grâce à la bibliothèque `python-dotenv`.
### 4. Lancer le projet
#### 4.1 Exécuter l'application avec Streamlit
- Assurez-vous que l'environnement virtuel est activé.
- Lancez l'application avec la commande suivante :
```bash
streamlit run app.py
```
- Une fenêtre s’ouvrira automatiquement dans votre navigateur à l'adresse suivante :
[http://localhost:8501](http://localhost:8501).
---
## Structure du projet
- **`app.py`** : Code principal pour l'application Streamlit.
- **`requirements.txt`** : Liste des dépendances nécessaires pour exécuter le projet.
- **`.env`** : Fichier contenant la clé API (à configurer par l'utilisateur).
- **`data/`** (optionnel) : Dossier pour stocker d'éventuelles données additionnelles.
- **`README.md`** : Documentation détaillée du projet.
---
## Dépendances
Les principales dépendances utilisées dans ce projet sont :
- **Streamlit** : Pour créer une interface web interactive.
- **Mistral AI SDK** : Pour accéder aux capacités conversationnelles.
- **Python-dotenv** : Pour gérer les variables d'environnement.
- **Pandas** (optionnel) : Pour manipuler des données structurées.
Toutes les dépendances sont listées dans `requirements.txt`. Installez-les avec :
```bash
pip install -r requirements.txt
```
---
## Résumé des commandes
### Cloner le projet :
```bash
git clone https://github.com/Hajaarh/smart_bot.git
cd smart_bot
```
### Créer et activer un environnement virtuel :
```bash
python -m venv venv
source venv/bin/activate # Sur macOS/Linux
venv\Scripts\activate # Sur Windows
```
### Installer les dépendances :
```bash
pip install -r requirements.txt
```
### Configurer l'API Mistral AI :
- Créez un fichier `.env` avec votre clé API.
### Lancer l'application Streamlit :
```bash
streamlit run app.py
```
---
## Résultats obtenus
- Création d'une application web interactive pour une conversation fluide avec les utilisateurs.
- Intégration réussie des technologies **Streamlit** et **Mistral AI**.
- Gestion sécurisée des clés API via dotenv.
- Amélioration des compétences en développement backend et en intégration IA.