Spaces:
Sleeping
Sleeping
File size: 1,856 Bytes
4b4d390 |
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 87 88 89 90 |
---
title: Rawi Review API
emoji: 📝
colorFrom: indigo
colorTo: blue
sdk: docker
sdk_version: "3.10"
app_file: app.py
pinned: false
license: mit
---
# Rawi Review API
This API provides literary evaluation services for Arabic stories, offering detailed critiques based on essential literary criteria.
## API Endpoints
### GET /
Returns a welcome message.
### POST /review-story/
Accepts a PDF file containing a story and returns a detailed literary evaluation.
**Request:**
- `file`: PDF file (required)
**Response:**
```json
{
"evaluation": "Detailed evaluation in Arabic...",
"fixed_story": null
}
```
### POST /review-story-text/
Accepts story text directly and returns a detailed literary evaluation.
**Request:**
```json
{
"text": "Your story text here..."
}
```
**Response:**
```json
{
"evaluation": "Detailed evaluation in Arabic...",
"fixed_story": null
}
```
## Environment Variables
- `DEEPSEEK_API_KEY`: API key for DeepSeek AI (optional - will use mock responses if not provided)
- `PORT`: Port to run the service on (default: 7860)
## Evaluation Criteria
Stories are evaluated based on 8 literary criteria:
1. Unity of event
2. Limited and defined characters
3. Focus on a decisive moment
4. Conciseness and economy of language
5. Unity of time and place
6. Well-structured plot
7. Impactful ending
8. Clear message or theme
Each criterion is scored out of 10, with a final score out of 80.
## Deployment
This service is ready to be deployed on Hugging Face Spaces using the included Dockerfile.
### Running Locally
```bash
pip install -r requirements.txt
uvicorn app:app --reload
```
### Using Docker
```bash
docker build -t rawi-review-api .
docker run -p 7860:7860 -e DEEPSEEK_API_KEY=your_api_key rawi-review-api
``` |