Обновил readme.md

This commit is contained in:
2023-12-09 17:23:31 +03:00
parent 0775d19938
commit efdfd875b4
+15 -2
View File
@@ -5,7 +5,7 @@
За координацию всего этого отвечает сервис Control. В его ответственность входит:
1. Получение запросов на обработку
2. Сообщение о результатах обработки
3. Управление конвейерами обработки данных[storage.sql](sql%2Fstorage.sql)
3. Управление конвейерами обработки данных
Конвейеры обработки данных (pipelines) состоят из более мелких частей -- пайп (pipes). Пайпы выстраиваются в цепочку, и образуется пайплан.
Например, конвейер сначала разбивает данные на токены, удаляет знаки препинания, приводит все символы к нижнему регистру, отправляет результат в модель для анализа, получает результат и возвращает его вызывающему коду (то есть сервису Control).
@@ -20,7 +20,20 @@
1. Создать базу данных "log_analysis"
2. В созданной базе данных создать таблицу "pipelines"
После этого можно запускать сервис Control. При запуске необходимо указать параметры. Список этих параметров можно посмотреть в коде либо запустить сервис без указания аргументов.
После этого можно запускать сервис Control. При запуске необходимо указать параметры. Список этих параметров можно посмотреть в коде, либо запустить сервис без указания аргументов.
Сервис готов к работе после вывода надписи "server is running"
К сервису можно подключиться с помощью ConsoleClient (директория services/console_client). При запуске также нужно указать параметры.
#### Команды
##### Получение пайп
Возвращает список доступных пайп. Этот список формируется при запуске сервиса и в дальнейшем не изменяется.
##### Получение пайплайнов
Возвращает список доступных пайплайнов. Список может быть дополнен пользовательскими пайпланами.
##### Создание пайплайна
Создаёт пайплайн из указанных пайп. Пайпы должны соответствовать друг другу (то есть выход предыдущего пайпа должен соответстовать входу следующего)
##### Запуск пайплайна
Запускает пайплайн для обработки указанной строки. Возвращает результат обработки