diff --git a/README.md b/README.md index b2bdd55..c18ad27 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,26 @@ # FileAudioAPI +## Назначение и роль в экосистеме + +**FileAudioAPI** — сервис **учёта аудио и результатов распознавания** между диском, GPU-распознаванием и веб-клиентом. На **FastAPI**: хранит метаданные и статусы в БД, складывает файлы в общий каталог **`AUDIOFILES_PATH`** (тот же volume `audiofiles`, что у **GigaAM_API** и **Calls_WEB_Client_main**), инициирует ASR в **GigaAM_API**, принимает обратно текст/заключение, при необходимости дергает webhook в **Calls_WEB_Client_main**. + +| Направление | Роль | +|-------------|------| +| **Внутренние файлы** | Регистрация, очереди `process-all`, статусы `recognition_*`, связь с `AiConclusion`. | +| **Внешние файлы** | Загрузка с опциональным `callback_url`, сохранение под UUID-именем в общей папке, **всегда** постановка на распознавание в GigaAM. | +| **Интеграция** | `GIGAAM_API_URL`, `CALLS_WEB_CLIENT_URL` / `WEBHOOK_API_KEY` для доставки результатов в основное приложение. | + +Swagger: **`/api/v1/docs`** (см. ниже). + +--- + Сервис для хранения аудиофайлов, индексации файлов, записи и выдачи результатов распознавания, реализованный на **FastAPI**. ## 🚀 Быстрый старт ```bash -# Клонировать и перейти в директорию -cd /Users/petr/SpeechAnalytics/FileAudioAPI +# Перейти в директорию сервиса (от корня репозитория SpeechAnalytics) +cd FileAudioAPI # Запуск с Docker (рекомендуется) docker-compose up -d