|
| 1 | +# SmartRAG Examples |
| 2 | + |
| 3 | +This directory contains example projects demonstrating how to use SmartRAG in different scenarios. |
| 4 | + |
| 5 | +## π Available Examples |
| 6 | + |
| 7 | +### **WebAPI** - ASP.NET Core Web API Example |
| 8 | +- **Location**: `WebAPI/` |
| 9 | +- **Description**: Complete web API implementation showing document upload, search, and RAG operations |
| 10 | +- **Features**: |
| 11 | + - Multi-document upload |
| 12 | + - AI-powered question answering |
| 13 | + - Smart query intent detection |
| 14 | + - Multiple storage providers |
| 15 | + - Comprehensive API documentation |
| 16 | + |
| 17 | +## π Running Examples |
| 18 | + |
| 19 | +### WebAPI Example |
| 20 | +```bash |
| 21 | +cd examples/WebAPI |
| 22 | +dotnet restore |
| 23 | +dotnet run |
| 24 | +``` |
| 25 | + |
| 26 | +Browse to `https://localhost:5001/scalar/v1` for interactive API documentation. |
| 27 | + |
| 28 | +## π§ Configuration |
| 29 | + |
| 30 | +Each example includes its own configuration files. Copy and modify the template files as needed: |
| 31 | + |
| 32 | +```bash |
| 33 | +# Copy development configuration template |
| 34 | +cp appsettings.Development.template.json appsettings.Development.json |
| 35 | + |
| 36 | +# Edit with your API keys and configuration |
| 37 | +``` |
| 38 | + |
| 39 | +## π Documentation |
| 40 | + |
| 41 | +- **Main Documentation**: [SmartRAG README](../../README.md) |
| 42 | +- **API Reference**: [API Documentation](../../docs/api-reference.md) |
| 43 | +- **Configuration Guide**: [Configuration Guide](../../docs/configuration.md) |
| 44 | + |
| 45 | +## π€ Contributing |
| 46 | + |
| 47 | +Want to add more examples? Create a new directory and submit a pull request! |
| 48 | + |
| 49 | +### Example Types to Consider: |
| 50 | +- **Console Application** - Command-line interface |
| 51 | +- **Blazor WebAssembly** - Client-side web app |
| 52 | +- **WPF Application** - Desktop application |
| 53 | +- **Azure Functions** - Serverless implementation |
| 54 | +- **Minimal API** - Lightweight web API |
0 commit comments