comment-guard-api / README.md
tejesh916K's picture
Add HF Spaces README with Docker SDK config
d82a2c9
---
title: Comment Guard API
emoji: πŸ›‘οΈ
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 8000
pinned: false
license: mit
short_description: AI-powered Telugu-English code-mixed comment moderation API
---
# πŸ›‘οΈ Comment Guard β€” AI Comment Moderation API
A real-time comment toxicity detection API for **Telugu-English code-mixed content**, powered by **MuRIL BERT** (Multilingual Representations for Indian Languages).
## πŸ”— API Endpoints
| Method | Endpoint | Description |
|--------|----------|-------------|
| `GET` | `/` | Health check |
| `POST` | `/analyze` | Analyze a comment for toxicity |
| `GET` | `/docs` | Interactive API documentation |
## πŸš€ Usage
```bash
curl -X POST "https://tejesh916k-comment-guard-api.hf.space/analyze" \
-H "Content-Type: application/json" \
-d '{"text": "your comment here", "strictness": "high"}'
```
## βš™οΈ Strictness Modes
| Mode | Threshold | Best For |
|------|-----------|----------|
| `high` | 0.4 | Public figures / celebrities |
| `low` | 0.7 | Friend groups / informal chats |