An open API service indexing awesome lists of open source software.

https://github.com/jiteshshelke/skincare-chatbot


https://github.com/jiteshshelke/skincare-chatbot

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README

        

# 🌿 SkinCare-Chatbot

![License](https://img.shields.io/github/license/JiteshShelke/SkinCare-Chatbot?color=blue)
![Stars](https://img.shields.io/github/stars/JiteshShelke/SkinCare-Chatbot?style=social)
![Issues](https://img.shields.io/github/issues/JiteshShelke/SkinCare-Chatbot)
![Forks](https://img.shields.io/github/forks/JiteshShelke/SkinCare-Chatbot?style=social)

## πŸ₯ About the Project
**SkinCare-Chatbot** is an AI-powered chatbot that provides solutions to skin-related problems using **NLP & Machine Learning**. The chatbot uses **BERT-based sentence transformers** to understand user queries and return the most relevant answers. It also leverages **Named Entity Recognition (NER)** to extract important terms and expand queries for better accuracy. πŸš€

## ✨ Features
- πŸ€– **AI-Powered Query Matching** (Using `Sentence Transformers`)
- πŸ” **Named Entity Recognition (NER)** for extracting skin-related terms
- πŸ“š **Synonym Expansion** using `WordNet`
- πŸ“Š **Semantic Similarity Matching**
- πŸ₯ **Accurate Responses** for common skincare queries
- πŸ“Œ **Related Questions Suggestion**
- 🌍 **Web Interface using Flask**

## πŸš€ Tech Stack
- **Flask** πŸ—οΈ (Backend Web Framework)
- **Pandas** 🐼 (Data Processing)
- **NLP Libraries** 🧠
- `spaCy` (Named Entity Recognition)
- `Sentence Transformers` (BERT-based Model)
- `WordNet` (Synonyms Expansion)
- **HTML + CSS** 🎨 (Frontend UI)
- **JavaScript** πŸ“ (Client-side Interactions)

## πŸ›  Installation & Setup
### 1️⃣ Clone the Repository
```sh
git clone https://github.com/yourusername/SkinCare-Chatbot.git
cd SkinCare-Chatbot
```

### 2️⃣ Create a Virtual Environment (Optional but Recommended)
```sh
python -m venv venv
source venv/bin/activate # For macOS/Linux
venv\Scripts\activate # For Windows
```

### 3️⃣ Install Dependencies
```sh
pip install -r requirements.txt
```

### 4️⃣ Download Required NLP Models
```sh
python -m spacy download en_core_web_sm
```

### 5️⃣ Run the Flask Application
```sh
python app.py
```

The chatbot will be available at: [http://127.0.0.1:5000](http://127.0.0.1:5000) πŸš€

## πŸ–Ό UI Preview
![Chatbot UI](./images/2.png)

## πŸ“Œ API Usage
### Endpoint: `/ask`
**Method:** `GET`
```sh
http://127.0.0.1:5000/ask?question=What+are+the+causes+of+acne?
```
**Response:**
```json
{
"answer": "Acne is caused by excess oil production, bacteria, and clogged hair follicles.",
"related_questions": [
"How can I prevent acne?",
"What are the treatments for acne?"
]
}
```

## 🀝 Contribution Guidelines
Contributions are always welcome! Here’s how you can help:
1. Fork the repository 🍴
2. Create a new branch πŸ”€ (`git checkout -b feature-branch`)
3. Commit your changes πŸ’Ύ (`git commit -m 'Added a new feature'`)
4. Push to your branch πŸš€ (`git push origin feature-branch`)
5. Submit a pull request πŸ“Œ

## πŸ“œ License
This project is licensed under the **MIT License** πŸ“œ. See the [LICENSE](LICENSE) file for more details.

## πŸ“¬ Contact
πŸ“© **Your Name**
πŸ”— [GitHub](https://github.com/JiteshShelke/Jtxmaster)
πŸ”— [LinkedIn](https://www.linkedin.com/in/jitesh-shelke-702745286/)

---
🌟 **Star this repo** if you like it! πŸš€