From 07925d4c016a86157336b5e0426f3d317c0682a7 Mon Sep 17 00:00:00 2001
From: Artem Darius Weber <mit.3tlasa@gmail.com>
Date: Sat, 7 Dec 2024 22:37:19 +0300
Subject: [PATCH] add README.md with classification service details and usage
 instructions

---
 README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a44d730
--- /dev/null
+++ b/README.md
@@ -0,0 +1,77 @@
+# Сервис классфикации обзращений пользователей в систему обработки заявок на следующие классы:
+
+
+```json
+{
+    [
+    "road_conditions",
+    "traffic_accidents",
+    "weather_conditions",
+    "parking_and_stopping",
+    "public_transport",
+    "fares_and_payments",
+    "traffic_violations_and_fines",
+    "routes_and_navigation",
+    "emergency_assistance",
+    "informational_requests",
+    "technical_issues",
+    "accessibility_for_disabled",
+    "environmental_issues",
+    "events_and_restrictions",
+    "complaints_and_suggestions",
+    "delays_and_holdups",
+    "tickets_and_reservations",
+    "road_safety",
+    "new_projects_information",
+    "special_services"
+    ]
+}
+```
+
+## Запуск приложения:
+
+Для запуска приложения необходимо установить все зависимости и запустить main.py с помощью Uvicorn:
+
+```bash
+uvicorn main:app --host 0.0.0.0 --port 8000
+```
+## Проверка статуса:
+
+```bash
+GET http://localhost:8000/status
+```
+
+Ответ:
+
+```json
+{
+  "status": "Модель обучается. Пожалуйста, попробуйте позже."
+}
+```
+
+## Предсказание:
+
+```bash
+POST http://localhost:8000/predict
+Content-Type: application/json
+
+{
+  "text": "Когда починят светофор на перекрестке?"
+}
+```
+
+**Ответ (если модель готова):**
+
+```json
+{
+  "predicted_class": "Класс_1"
+}
+```
+
+**Ответ (если модель обучается):**
+
+```json
+{
+  "detail": "Модель обучается. Пожалуйста, попробуйте позже."
+}
+```
\ No newline at end of file