File size: 3,213 Bytes
c59d808 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# Documentation Index
## 🚨 Troubleshooting (Start Here)
### Quick Fixes
- **[Embedding Troubleshooting](./embedding-troubleshooting.md)** - Fix dimension mismatch errors in 5 minutes
- **[Logging Guide](./logging_guide.md)** - Understanding error messages and logs
### Common Error Messages
| Error | Quick Fix |
|-------|-----------|
| `shapes (768,) and (384,) not aligned` | [Embedding dimension mismatch](./embedding-troubleshooting.md#shapes-768-and-384-not-aligned) |
| `MongoDB connection failed` | Check `MONGODB_URI` in `.env` |
| `ChromaDB not available` | `pip install langchain_chroma` |
| `OpenAI API key invalid` | Update `OPENAI_API_KEY` in `.env` |
## 📖 Comprehensive Guides
### Setup & Configuration
- **[Embedding Compatibility Guide](./embedding-compatibility-guide.md)** - Complete guide to embedding models and dimensions
- **[Model Configuration Guide](./model-configuration-guide.md)** - Provider-specific settings, temperature limitations, and best practices
- **[Architecture Documentation](../docs/architecture.md)** - System overview and design patterns
- **[Deployment Guide](./deployment.md)** - Production deployment instructions
### API & Development
- **[API Documentation](./api-documentation.md)** - Detailed API reference
- **[ChromaDB Refresh Guide](./chromadb_refresh.md)** - Database management and refresh procedures
## 🔧 Developer Resources
### Configuration Examples
```bash
# Most reliable setup (384D embeddings)
EMBEDDING_PROVIDER=huggingface
HUGGINGFACE_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2
# Local inference setup (768D embeddings)
EMBEDDING_PROVIDER=ollama
OLLAMA_EMBEDDING_MODEL=nomic-embed-text:v1.5
# Premium quality setup (1536D embeddings)
EMBEDDING_PROVIDER=openai
OPENAI_EMBEDDING_MODEL=text-embedding-3-small
```
### Quick Commands
```bash
# Check current embedding configuration
grep EMBEDDING .env
# Test API health
curl http://localhost:8080/health
# Clear conversation memory
curl -X POST http://localhost:8080/clear-memory
# View recent logs
tail -f ./logs/recipe_bot.log
```
## 📋 File Organization
```
docs/
├── README.md # This file
├── embedding-troubleshooting.md # 🚨 Quick fixes
├── embedding-compatibility-guide.md # 📖 Complete embedding guide
├── model-configuration-guide.md # ⚙️ LLM provider configurations
├── logging_guide.md # 🔍 Log analysis
├── chromadb_refresh.md # 🔄 Database management
├── api-documentation.md # 📡 API reference
├── architecture.md # 🏗️ System design
└── deployment.md # 🚀 Production setup
```
## 🆘 Getting Help
1. **Check error logs**: `tail -f ./logs/recipe_bot.log`
2. **Common issues**: Start with [Embedding Troubleshooting](./embedding-troubleshooting.md)
3. **API problems**: See [API Documentation](./api-documentation.md)
4. **Setup issues**: Review [Embedding Compatibility Guide](./embedding-compatibility-guide.md)
---
💡 **Tip**: Bookmark the [Embedding Troubleshooting](./embedding-troubleshooting.md) page - it solves 80% of common issues!
|