Update README.md
Browse files
README.md
CHANGED
|
@@ -1,27 +1,55 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
-
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
-
|
| 10 |
-
short_description: A FastAPI-based AI application for fire safety, general, and
|
| 11 |
---
|
| 12 |
|
| 13 |
-
# YourAI
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
|
| 15 |
-
|
| 16 |
|
| 17 |
-
|
|
|
|
| 18 |
|
| 19 |
-
|
| 20 |
-
- **Framework**: FastAPI
|
| 21 |
-
- **Port**: 7860
|
| 22 |
-
- **Command**: `uvicorn app:app --host 0.0.0.0 --port 7860`
|
| 23 |
|
| 24 |
-
|
| 25 |
-
Install dependencies from `requirements.txt`:
|
| 26 |
-
```bash
|
| 27 |
-
pip install -r requirements.txt
|
|
|
|
| 1 |
---
|
| 2 |
+
title: YourAI - LightRAG Powered
|
| 3 |
+
emoji: π₯
|
| 4 |
+
colorFrom: red
|
| 5 |
+
colorTo: yellow
|
| 6 |
+
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
+
app_port: 7860
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# YourAI - LightRAG Powered
|
| 13 |
+
|
| 14 |
+
A sophisticated AI assistant powered by LightRAG (Retrieval-Augmented Generation) with conversation memory and custom AI creation capabilities.
|
| 15 |
+
|
| 16 |
+
## Features
|
| 17 |
+
|
| 18 |
+
π₯ **Fire Safety AI** - Specialized AI for fire safety regulations and codes
|
| 19 |
+
π€ **General AI** - General-purpose conversational AI with memory
|
| 20 |
+
π οΈ **Custom AI Builder** - Create your own AI with uploaded knowledge
|
| 21 |
+
π¬ **Conversation Memory** - Maintains context within conversations
|
| 22 |
+
π **Knowledge Management** - Advanced GraphRAG for better information retrieval
|
| 23 |
+
|
| 24 |
+
## How to Use
|
| 25 |
+
|
| 26 |
+
1. **Chat with Fire Safety AI** - Ask questions about fire safety regulations
|
| 27 |
+
2. **General Chat** - Have conversations with context awareness
|
| 28 |
+
3. **Create Custom AI** - Upload documents to create specialized AI assistants
|
| 29 |
+
4. **Manage Conversations** - View and manage your chat history
|
| 30 |
+
|
| 31 |
+
## Technology Stack
|
| 32 |
+
|
| 33 |
+
- **LightRAG**: Advanced retrieval-augmented generation
|
| 34 |
+
- **Cloudflare Workers AI**: LLM and embedding models
|
| 35 |
+
- **FastAPI**: High-performance API framework
|
| 36 |
+
- **NetworkX**: Graph storage for knowledge relationships
|
| 37 |
+
- **NanoVectorDB**: Vector storage for embeddings
|
| 38 |
+
|
| 39 |
+
## API Endpoints
|
| 40 |
+
|
| 41 |
+
- `POST /chat/fire-safety` - Chat with fire safety AI
|
| 42 |
+
- `POST /chat/general` - General conversation
|
| 43 |
+
- `POST /chat/custom/{ai_id}` - Chat with custom AI
|
| 44 |
+
- `POST /create-custom-ai` - Create custom AI
|
| 45 |
+
- `POST /upload` - Upload knowledge files
|
| 46 |
+
- `GET /conversations` - Get user conversations
|
| 47 |
|
| 48 |
+
## Models Used
|
| 49 |
|
| 50 |
+
- **LLM**: `@cf/meta/llama-3.2-3b-instruct`
|
| 51 |
+
- **Embedding**: `@cf/baai/bge-m3`
|
| 52 |
|
| 53 |
+
## License
|
|
|
|
|
|
|
|
|
|
| 54 |
|
| 55 |
+
MIT License - Feel free to use and modify!
|
|
|
|
|
|
|
|
|