sap-chatbot / README.md
github-actions[bot]
Deploy from GitHub Actions 2025-12-11_02:27:23
a308534
---
title: SAP Chatbot
emoji: πŸ€–
colorFrom: blue
colorTo: purple
sdk: streamlit
sdk_version: 1.28.0
app_file: app.py
pinned: false
---
# 🧩 SAP Intelligent Assistant
A free, open-source **RAG (Retrieval-Augmented Generation)** system for answering SAP-related questions using cloud LLMs and vector databases.
## ✨ Key Features
- βœ… 100% Free & Open Source
- βœ… Multi-source SAP data (Community, GitHub, StackOverflow, Dev.to, Medium)
- βœ… Production-ready: Supabase + pgvector vector database
- βœ… HuggingFace Inference API for fast responses
- βœ… Automatic data ingestion via GitHub Actions
- βœ… Beautiful Streamlit UI
- βœ… Multi-user cloud hosting
- βœ… Conversation history with source attribution
## πŸš€ How It Works
```
1. Data Collection β†’ 2. Embeddings β†’ 3. Vector Search β†’ 4. Answer Generation
(SAP sources) (sentence- (Supabase (HF Inference
transformers) pgvector) API)
```
**Supported Topics:**
- SAP Basis Administration
- SAP ABAP Development
- SAP HANA
- SAP Fiori & UI5
- SAP Security & Authorization
- SAP BTP (Business Technology Platform)
- SAP Integration Suite
- SAP Performance Tuning
- And more!
## πŸ”§ Setup
### 1. Local Development (with Ollama)
```bash
# Clone repo
git clone https://github.com/Akshay-S-PY/sap-chatboot
cd sap-chatboot
# Create virtual environment
python -m venv .venv
source .venv/bin/activate
# Install dependencies
pip install -r requirements.txt
# Build dataset
python tools/build_dataset.py
# Run locally
streamlit run app.py
```
### 2. Production (Supabase + HF Spaces)
See [SUPABASE_SETUP.md](./SUPABASE_SETUP.md) for step-by-step cloud deployment.
## πŸ“Š Architecture
```
GitHub Repository (sap-chatboot)
↓
GitHub Actions Workflows:
1. build_dataset.yml β†’ Dataset + Upload to HF Hub
2. ingest.yml β†’ Ingest to Supabase
3. deploy_spaces.yml β†’ Deploy to HF Spaces
↓
Supabase Database (pgvector + RLS)
↓
Streamlit App (HF Spaces)
↓
User Query β†’ Vector Search β†’ LLM Response + Sources
```
## πŸ“š Tech Stack
| Component | Technology | Cost |
|-----------|-----------|------|
| Vector Database | Supabase (pgvector) | Free |
| Embeddings | sentence-transformers | Free |
| LLM API | HuggingFace Inference | Free |
| App Hosting | HF Spaces | Free |
| Data Pipeline | GitHub Actions | Free |
## πŸ’‘ Use Cases
- **Quick SAP Questions**: Get instant answers about SAP config, ABAP, Basis
- **Learning**: Understand SAP concepts with cited sources
- **Team Knowledge Base**: Share with your entire team
- **Integration**: Use programmatically via Python API
## πŸ”— Resources
- πŸ“– [GitHub Repository](https://github.com/Akshay-S-PY/sap-chatboot)
- πŸ”— [Supabase](https://supabase.com)
- πŸ€— [HuggingFace](https://huggingface.co)
- πŸ’¬ [SAP Community](https://community.sap.com)
## ⚠️ Important Notes
- First run builds dataset (~5-10 min)
- Works 100% offline with Ollama
- All data sources are publicly available and respectfully scraped
- No personal data is stored
---
**Made with ❀️ for the SAP Community**
Have questions? Check the [documentation](./SUPABASE_SETUP.md) or create an [issue](https://github.com/Akshay-S-PY/sap-chatboot/issues).