Флора AI - Вклад [ru]

UPS. Руководство администратора

2026-02-12T07:24:06Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для управления базовыми сервисами ядра, а также в качестве прокси-сервера доступа к сервисам с функцией балансировки нагрузки.
===== '''Термины и определения''' =====
Universal Proxy Server (UPS) – сервис управления ядром с проксированием запросов.

===== '''Системные требования''' =====
Для нормальной работы сервиса требуется 4 Гб оперативной памяти, 1 CPU >= 2.20 GHz и 40 Гб дискового пространства.

===== '''Установка/обновление UPS''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/ups&fileid=482 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Для UPS необходимо [[PVE. Установка сервисного пакета окружения|устанавливать выделенное окружение]].

* Установка/обновление UPS осуществляется скриптом <code>chmod +x ./ups-<версия>-<релиз>.sh && ./ups-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./ups-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/ups/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/ups</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить UPS <code>/opt/ups/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/ups/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/ups/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/ups/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/ups/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/ups/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/ups/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/ups/.proxy (это файл конфигурации proxy, необходим для обновления при отсутствующем прямом подключении к интернету).

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable ups.service && sudo systemctl start ups.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status ups.service</code>

Разрешите доступ к порту 6182 на нужном интерфейсе по протоколу TCP.

Параметры авторизации по умолчанию: логин: admin, пароль: password

UPS может работать в составе кластера из двух и более серверов с UPS. Для этого необходимо создать кластер pacemaker/corosync с 2 ресурсами — ресурс systemd UPS и shared IP, и обеспечить их одновременную работу на одной ноде кластера. Синхронизацию изменений обеспечит сервис UPS с помощью lsyncd, для этого есть блок «cluster» в конфигурационном файле. Серверы кластера для этого должны иметь возможность соединения по SSH по ключу.

====='''Внутренняя база данных'''=====
В каталоге '''/opt/ups/data/db''' находятся папки служебной базы данных. Папки созданы по разделам администрирования UPS. Каждый файл любой папки описывает один объект администрирования, например один из файлов из каталога '''"/opt/ups/data/db/roles".'''
{
"id": "ee1b3b1edb8c4376486189d6540f5635",
"name": "Только просмотр",
"rights": [
"SERVICE:smc",
"SERVICE:see",
"GET:/spr/audio",
"GET:/spr/queue",
"GET:/spr/waveform",
"SERVICE:spr",
"GET:/sbs/speakers",
"SERVICE:sbs",
"GET:/tts/dictionary/get",
"SERVICE:tts",
"GET:/qas/doc",
"GET:/qas/list",
"SERVICE:qas",
"GET:/auth/datasets",
"GET:/auth/roles",
"GET:/auth/user/get",
"GET:/auth/user/list",
"SERVICE:auth",
"GET:/model/errors",
"GET:/model/handler",
"GET:/model/log",
"GET:/corpus/get",
"GET:/corpus/list",
"GET:/transcription/audio",
"GET:/transcription/get",
"GET:/transcription/list",
"GET:/transcription/waveform",
"GET:/server/get/addresses",
"GET:/server/get/models",
"GET:/lang/wallpaper"
]
}

описывает '''роль''' и ее параметры. В каждом файле обязательно есть уникальный '''id''' и хотя бы один параметр. В примере 2 параметра '''"name"''' и '''"rights"'''.

====='''Авторизация в UPS'''=====
UPS предполагает доступ по паролю к разделам интерфейса и информации от сервисов. Доступ осуществляется при помощи токена доступа. Токен запрашивается запросом, в котором передаются логин и пароль, а в ответ приходит токен авторизации и токен обновления авторизации.

Пример запроса:
curl -X POST "http://127.0.0.1:6182/auth/access?username=admin&password=password" -H "accept: application/json"
Пример ответа:

{
"x-access-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMCIsImNyZWF0ZWQiOjE3MTQ2NTk5MDIuOTk5MzQzNiwidHlwZSI6ImFjY2VzcyJ9.wrTRX2de5jhVFKRQ_Xt0fNXxHWN_yLiqZ6S_inix0Jg",
"x-refresh-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMCIsImNyZWF0ZWQiOjE3MTQ2NTk5MDIuOTk5NTk1NCwidHlwZSI6InJlZnJlc2gifQ.Y3DNfIpfqJffjrPaT4TQiiF22Huvx62rmB-b9Az6UAc"
}

Пример запроса с участием токена:
curl -X GET "http://127.0.0.1:6182/auth/version" -H "accept: application/json" -H "x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMCIsImNyZWF0ZWQiOjE3MTQ2NTk5MDIuOTk5MzQzNiwidHlwZSI6ImFjY2VzcyJ9.wrTRX2de5jhVFKRQ_Xt0fNXxHWN_yLiqZ6S_inix0Jg"
В случае если UPS работает в закрытом контуре и авторизация не требуется, методы API, которые используются, нужно добавить в раздел «nopassword» конфигурационного файла (см. ниже).

====='''Установка модулей для UPS'''=====
Есть возможность создать любой модуль, который будет эмулировать любой API-интерфейс любого стороннего сервиса через UPS. Для примера создан интерфейс Яндекс. Установка модулей возможна прямым копированием файлов модуля в директорию /opt/ups/modules/<название модуля>.

Чтобы убедиться, что модуль доступен и работает, выполните запрос:

<code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6182/tts/synthesize/yandex_tts_emulator?rate=100&pitch=100&volume=0</nowiki>" --H "accept: application/json" --data-urlencode "text=текст для синтеза" --output out.wav</code>

out.wav должен содержать синтезированный голос озвучивший текст из запроса.

Данный пример запроса говорит о том, что написан интерфейс Яндекса по синтезу. Соответственно, обращение к нему идет как к Яндексу и ответ как от Яндекса.

Пример структуры файла модуля (/opt/ups/modules/[имя модуля]/handler.py):

<code>import uuid, io, json</code>

<code>from app.modules import modulesns</code>

<code>from flask import send_file</code>

<code>from flask_restplus import Resource, reqparse</code>

<code>from app.ups import tools</code>

<code>config = json.load(open('/opt/ups/modules/yandex_tts_emulator/config.json'))</code>

<code>parser = reqparse.RequestParser()</code>

<code>parser.add_argument('voice',required=True)</code>

<code>parser.add_argument('text',required=True)</code>

<code>@modulesns.route("/speech/v1/tts:synthesize"</code>

<code>class YandexEmulator(Resource): # имя класса можно указать свое</code>

<code> def post(self): # обязательный метод post класса</code>

<code> args = parser.parse_args()</code>

<code> voice = args['voice']</code>

<code> voice = config['voices'].get(voice,None)</code>

<code> if not voice:</code>

<code> modulesns.abort(405, message = "Wrong voice", error = 1)</code>

<code> reply = tools.getData(servicetype="tts",method="GET",data={'text':args['text']},url="/tts/synthesize/"+voice)</code>

<code> if type(reply) is dict:</code>

<code> return reply</code>

<code># возвращаемым значение метода post должен быть правильный результат, в данном примере синтезированный аудиофайл</code>

<code> return send_file(</code>

<code> io.BytesIO(reply),</code>

<code> attachment_filename=str(uuid.uuid4())+'.wav',</code>

<code> as_attachment=True,</code>

<code> mimetype='audio/wav'</code>

<code> )</code>

Пример структуры файла конфигурации (/opt/ups/modules/[имя модуля]/config.json):

<code>{</code>

<code> "voices": {</code>

<code> "alena": "Alya_8kHz"</code>

<code> }</code>

<code>}</code>

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса ups производится в файле /opt/ups/params.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/ups/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|auth.accessLifeTime
|1800
|Время жизни access token.
|-
|auth.refreshLifeTime
|86400
|Время жизни refresh token.
|-
|servers.{service}.trainer
|<nowiki>http://127.0.0.1:PORT</nowiki>
|Ссылка на сервер для обучения моделей сервисов. Возможные варианты значения service (с портами по умолчанию) следующие: smc (6181), see (6184), spr (6183), qas (6187), res (6156), ses (6190).
|-
|servers.{service}.cluster
|<nowiki>[http://127.0.0.1:PORT]</nowiki>
|Список ссылок на рабочие серверы сервисов. Возможные варианты значения service (с портами по умолчанию) следующие: smc (6181), see (6184), spr (6183), qas (6187), tts (6186), sbs (6185), ses (6190).
|-
|servers.res.cluster
|"<nowiki>https://0.0.0.0:6157</nowiki>
|Ссылка на сервис kibana, подключенный через раверс-прокси на nginx (входит в состав res).
|-
|servers.{service}.timers.connect
|0.5
|Лимит времени на подключение к сервису, сек.
|-
|servers.{service}.timers.read
|300
|Лимит времени на получение данных от сервиса, сек.
|-
|servers.{service}.timers.failed
|600
|Длительность паузы обращений к сервису при сбое, сек.
|-
|servers.{service}.timers.install
|60
|Лимит времени на установку модели на сервис.
|-
|servers.{service}.timers.info
|3
|Лимит времени на получение информации о модели.
|-
|servers.ses.websockets
|"127.0.0.1:6191"
|Все адреса, в том числе и с SSL (wss), по которым доступен websocket-сервер ses.
|-
|servers.res.cluster
|"<nowiki>http://192.168.20.246:5601</nowiki>"
|[https://wiki.connect2ai.net/index.php/RES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_kibana_+_elasticsearch http адрес Kibana с отчетами.] Для доступа к отчетам по http адресу UPS, и для проксирования на порт 5602 кибаны для ssl UPS
|-
|servers.res.auth.username
servers.res.auth.password
|"reports"
"reports"
|Логин и пароль [https://wiki.connect2ai.net/index.php/RES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_kibana_+_elasticsearch пользователя kibana] с правами доступа на просмотр рабочих столов с отчетами
|-
|cluster.logfile
|logs/sync.log
|Расположение лога синхронизации для работы в кластере.
|-
|cluster.statusFile
|logs/sync.status
|Файл для периодической записи отчёта о состоянии синхронизации.
|-
|cluster.nodes
|[ ]
|Перечень нод кластера UPS, на которые будет отправляться содержимое папки «data».
|-
|userlog
|[ "POST:", "DELETE:" ]
|Типы действий пользователей, которые будут логироваться.
|-
|nouserlog
|[

"POST:/auth/userlog",

"POST:/ses/ask",

"POST/auth/user/password",

"POST/spr/stt",

"POST/sbs/analyze",

"POST/sbs/search",

"POST/sbs/verify",

"POST/tts/normalize",

"POST/tts/revoice",

"POST/tts/synthesize",

"POST/qas/summarize"

]
|Исключения из правила логирования действий пользователей.
|-
|nopassword
|[
"GET:/auth/refresh",

"GET:/auth/rights",

"POST:/auth/access",

"GET:/lang/",

"GET:/tts/synthesize",

"POST:/sbs/embedding",

"GET:/smc/classify",

"GET:/auth/version",

"GET:/smc/compress",

"GET:/smc/emotion",

"GET:/see/entities",

"POST:/sbs/analyze",

"POST:/sbs/verify",

"POST:/sbs/search",

"POST:/spr/stt",

"GET:/spr/result",

"GET:/auth/user/info",

"GET:/model/info",

"POST:/auth/user/password"

]
|Список методов, которые не требуют авторизации.
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/ups/logs/log.txt

===== '''Удаление UPS''' =====
Для удаления выполните команду: <code>/opt/ups/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SPR. Руководство пользователя

2026-01-29T07:57:36Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short phrase recognizer предназначен для преобразования речи в текст. Принимает на вход аудиофайл в формате wav и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — предварительно обученная специализированная нейронная сеть для распознавания естественной речи в аудиозаписях.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SPR в реальном времени.

===== '''Описание методов API SPR''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SPR. По умолчанию используется порт 6183/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6183 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+
|-
! style="color:blue;width: 15%"|'''GET:/spr/models'''
! colspan="3" |Вывод списка моделей.
|-
| colspan="3" |Без входных параметров.
|<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/audio/{taskID}'''
! colspan="3" |Получение файла аудиозаписи отложенного задания.
|-
| colspan="3" |taskID — идентификатор задания.
|Файл аудиозаписи или <code>{ error: INT , message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/export/{id}'''
! colspan="3" |Получение архива модели.
|-
| colspan="3" |id — идентификатор модели.
|ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/import/{id}'''
! colspan="3" |Добавление модели. Может быть добавлена как из файла архива, так и переименованием существующей модели.
|-
| colspan="3" |id — идентификатор модели, обязательный параметр.
zip-model — zip-архив с файлами модели.

Или

from-existing-model — название модели, которая должна перемещена на место id.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/delete/{id}'''
! colspan="3" |Удаление модели.
|-
| colspan="3" |id — идентификатор модели.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/queue'''
! colspan="3" |Получение очереди отложенных заданий на распознавание.
|-
| colspan="3" |Без входных параметров.
|<code>{</code>

<code>"id задания":</code>

<code>{</code>

<code> "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ",</code>

<code> "status": "waiting", # ready | waiting | failed</code>

<code> "filename": "wav"</code>

<code>}</code>

<code>}</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/queue/{taskID}'''
! colspan="3" |Удаление отложенных заданий на распознавание.
|-
| colspan="3" |taskID — идентификатор задания в очереди.
|<code>{</code>

<code>"error": 0,</code>

<code>"message": "success"</code>

<code>}</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/stt/{id}'''
! colspan="3" |Отправка файла на распознавание речи. Моно-файлы до 60 секунд распознаются без разбивки на фрагменты и определения спикеров. Многоканальные файлы и файлы длиннее 60 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в [[SPR. Руководство администратора.|руководстве администратора]].
|-
| colspan="3" style="width: 50%" |
* '''id''' — идентификатор модели
* '''wav''' — файл для распознавания
* '''speakers''' — опция поиска говорящих по базе SBS. Если 1, то дополнительно производится поиск говорящих и получение метаданных по каждому говорящему (используется сервис SBS с предварительно обученными слепками метаданных говорящих)
* '''punctuation''' — опция для расстановки знаков препинания. Если 1, то дополнительно вызывает метод punctuate в SMC и расставляет знаки препинания в распознанном тексте, значение по умолчанию берётся из файла конфигурации (для модели big пунктуация выполняется в любом случае).
* '''normalization''' — опция обратной нормализации текста, если 1, то выполняется обратная нормализация текста текста (для модели big выполняется в любом случае).
* '''vad''' — используемый VAD, по умолчанию webrtc
* '''toxicity''' — анализировать распознанный текст на токсичность через smc (GET/smc/toxicity).Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:"оскорбление": 0.13, "непристойность": 0, "угроза": 0, "вежливость": 0.53
* '''emotion''' — выявить эмоции из распознанного текста через smc (GET/smc/emotion). Возможные ответы: negative, neutral, positive.
* '''voice_analyzer''' — анализировать аудиофрагменты каждого из говорящих на эмоции, возраст и пол, запрашивается в sbs метод POST/sbs/analyze.Аудио говорящего анализируется на возраст (child, adult, old).Эмоции (ANGER, BORE, DISAPPOINTMENT, DISGUST, EXCITEMENT, FEAR, NEUTRAL, PAIN, PLEASURE, SADNESS, SUPRISE). Пол (male, female).
* '''speaker_counter''' — количество докладчиков, по умолчанию 0, автоматическое определение количества. При отправке значения -1 разделение на докладчиков будет отключено.
* '''async''' — отложенный запуск распознавания
* '''classifiers'''<nowiki> - дополнительно проанализировать все распознанные фразы через модели smc и/или see. отправляется в виде {"smс":"название модели":{ параметры запроса }}. Подробнее о параметрах запроса см. в документации по сервисам </nowiki>[[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
* '''webhook''' — внешний url для отправки результата распознавания в отложенном режиме запуска. Результат отправляется методом POST.

| style="width: 50%" |В случае '''async=1''' возвращается только '''taskID''', результат по taskID смотреть в методе /spr/result либо на внешнем сервисе, указанном в поле webhook.
'''Для коротких файлов''':

<code>{</code>

<code> "model": "call",</code>

<code> "text": "текст фрагмента",</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "words": [ </code>

<code>{ "word": "текст",</code>

<code> "start": 520,</code>

<code> "stop": 1240 },</code>

<code> { "word": "фрагмента",</code>

<code> "start": 1240,</code>

<code> "stop": 1920 }</code>

<code>]</code>

<code>}</code>

'''Для транскрибации больших файлов:'''

<code>{</code>

<code>"speakers": [</code>

<code> { </code>

<code>"id": null,</code>

<code> "duration": 18980,</code>

<code> "fragments": 3,</code>

<code> "age": "old", # только для voice_analyzer=1</code>

<code> "gender": "female" # только для voice_analyzer=1</code>

<code>}</code>

<code>],</code>

<code>"splitted": [</code>

<code> {</code>

<code>"start": "00:00:01.870",</code>

<code> "text": "текст.",</code>

<code> "words": [</code>

<code> { </code>

<code>"word": "текст.",</code>

<code> "start": 1870,</code>

<code> "stop": 2710,</code>

<code> "confidence": 0.95263671875</code>

<code>}</code>

<code>],</code>

<code> "stop": "00:00:05.510",</code>

<code> "channel": 0,</code>

<code> "duration": "00:00:03.640",</code>

<code> "start_ms": 1870,</code>

<code> "stop_ms": 5510,</code>

<code> "duration_ms": 3640,</code>

<code> "speaker": 4,</code>

<code> "speakerConfidence": 0.87,</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "toxicity": { # только для toxicity=1</code>

<code> "insult": 0,</code>

<code> "obscenity": 0,</code>

<code> "threat": 0,</code>

<code> "politeness": 0.99</code>

<code>},</code>

<code> "emotion": { "neutral": -0.3315 }, # только для emotion=1</code>

<code> "voice_analysis": { # только для voice_analyzer=1</code>

<code> "emotion": {</code>

<code> "class": "NEUTRAL",</code>

<code> "confidence": 0.7554781436920166 } </code>

<code>}</code>

<code>}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/result/{taskID}'''
! colspan="3" |Получение результата отложенного распознавания.
|-
| colspan="2" |taskID — идентификатор задания.
| colspan="2" |Вывод по окончанию распознавания аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи:ready — готово

waiting — ожидание

not found — не найдена

failed — сбой.
|-
! style="color:blue;width: 15%"|'''GET:/spr/waveform/{taskID}'''
! colspan="3" |Служебный метод для отображения аудио в графическом виде, содержит пики сигнала.
|-
| style="width: 50%" colspan="2" |taskID — идентификатор задания.
| colspan="2" |<code>{</code>

<code>"error": 0,</code>

<code>"waveform": [</code>

<code>0.016,</code>

<code> 0.015,</code>

<code> 0.01</code>

<code>]</code>

<code>}</code>
|}
</onlyinclude>

SMC. Руководство администратора

2026-01-29T07:41:00Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для анализа и классификации текстовой информации. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Message Classifier (SMC) – сервис анализа и классификации.

===== '''Системные требования для SMC''' =====
Для работы smc рекомендуется использовать видеокарту NVIDIA, поддерживающую технологию CUDA и имеющую в составе ядра CUDA.

В случае отсутствия видеокарты для нормальной работы сервиса необходимо обеспечить не менее 8 потоков CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее. В конфигурации 8 потоков Intel(R) Xeon(R) Gold 6148 2.40GHz 6Гб ОЗУ фраза из 10 слов классифицируется 0.2с, соответственно за секунду может быть распознано до 5 фраз, отправленных на распознавание последовательно или одновременно. Увеличение количества ядер/потоков дает прирост производительности, но не прямо пропорциональный.

Оперативной памяти необходимо не менее 4Gb.

Для обучения моделей рекомендуется использовать видеокарту. Обучение модели на корпусе размером 7500 строк занимает на ВМ с 16 ядрами, 16Гб ОЗУ и видеокартой А16 (одном из 4-х ее ядер) около 20 минут. Недостаточная мощность CPU может увеличить время обучения за счет подготовки данных.

===== '''Установка/обновление сервиса SMC''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/smc&fileid=560 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SMC осуществляется скриптом <code>chmod +x ./smc-<версия>-<релиз>.sh && ./smc-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./smc-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/smc</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SMC<code>/opt/smc/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/smc/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/smc/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/smc/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/smc/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/smc/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/smc/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable smc.service && sudo systemctl start smc.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status smc.service</code>

Разрешите доступ к порту 6181 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/smc/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "smc", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start smc</code> и извлечь UUID, указанный в файле <code>/opt/smc/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка сервисных моделей SMC''' =====
Установка сервисных моделей возможна только копированием файла(файлов) модели в каталог с названием модели. Названия моделей предопределены и соответствуют их назначению (compressor, correction, embeddings, emotions, normalization, punctuation, toxicity). Установка сервисных моделей невозможна через API, в отличие от моделей классификации.

Модели располагаются в каталоге /opt/smc/pretrained/. Для установки модели необходимо создать каталог /opt/smc/pretrained/<название модели>/ и распаковать в неё архив модели, после чего перезагрузить сервис командой systemctl restart smc.

Проверить корректность работы модели пунктуации можно запросом к API с отправкой текста на распознавание:

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate?text=</nowiki><текст>"</code>

Список всех моделей представлен в таблице:
{| class="wikitable"
|+
!'''Модель'''
!'''Описание'''
!'''Пример запроса к модели'''
!'''Пример ответа от модели'''
|-
|'''embeddings'''
|Языковая, отвечает за вычисление векторов при обучении модели.
|Проверить работу напрямую запросом к API не получится, метод не предусмотрен.
| -
|-
|'''compressor'''
|Модель сжатия фраз. Убирает из фразы слова, не влияющие на ее смысл.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/compress?threshold=30</nowiki>" --data-urlencode "text=как можно было бы получить выплату мне бы" -H "accept: application/json"|jq</code>
|<code>{ "text": "получить выплату мне бы" }</code>
|-
|'''emotions'''
|Анализ эмоций.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/emotion</nowiki>" --data-urlencode "text=спасибо все хорошо" -H "accept: application/json"|jq</code>
|''<code>{ "emotion": "positive", "score": 0.9601 }</code>''
|-
|'''punctuation'''
|Пунктуация.
|Проверить работу можно через API запросом:
''<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate</nowiki>?" --data-urlencode "text=я пришел как мне получить услугу" -H "accept: application/json"|jq</code>''
|<code>{ "text": "Я пришел. Как мне получить услугу?" }</code>
|-
|'''normalization'''
|Обратная нормализация, заменяет числа прописью на цифры. <blockquote>''Внимание! У модели есть дополнительные требования к модулям Python в файле requirements.txt!''</blockquote>
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/normalize</nowiki>?" --data-urlencode "text=запишите меня к тринадцати" -H "accept: application/json"|jq</code>
|<code>{"text": "запишите меня к 13-ти"}</code>
|-
|'''correction'''
|Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели).
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/correct</nowiki>?" --data-urlencode "text=халодная вода" -H "accept: application/json"|jq</code>
|<code>{"text": "холодная вода"}</code>
|-
|'''toxicity'''
|Анализ текста на невежливость, угрозы, брань.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/toxicity</nowiki>?" --data-urlencode "text=нехороший человек" -H "accept: application/json"|jq</code>
Подробнее см в [[SMC. Руководство пользователя|руководстве пользователя]].

| -
|}

'''ВНИМАНИЕ!''' Модели '''punctuation, embeddings, correction''' обязательны для установки, остальные - в зависимости от сценария использования.

===== '''Установка моделей классификации''' =====
Модель классификации — это модель, обученная на определенном наборе данных (корпусе) и предназначенная непосредственно для классификации. Установка модели возможна запросом с помощью методов API. Методы описаны в [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F руководстве пользователя]. Также модель может быть установлена копированием содержимого каталога /opt/smc/nnets/<имя модели> с одного сервера smc на другой. Внимание! При этом способе UPS, в конфигурационном файле которого указан новый smc, не увидит скопированную модель.

===== '''Конфигурирование параметров сервиса''' =====

Настройка параметров сервиса smc производится в файле /opt/smc/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/smc/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|noise.enabled
|true
|Детекция мусора при классификации (фраз, которые не относятся ни к одному классу)
|-
|noise.threshold
|0.7
|Порог отсева
|-
|cache.size.embedding
|262144
|Максимальный размер кэша векторов (количество записей)
|-
|cache.size.classify
|32768
|Максимальный размер кэша запросов классификации (количество записей)
|-
|cache.size.correction
|32768
|Максимальный размер кэша запросов коррекции (количество записей)
|-
|cache.size.punctuation
|32768
|Максимальный размер кэша запросов пунктуации (количество записей)
|-
|cache.size.similar
|32768
|Максимальный размер кэша запросов похожести фраз (количество записей)
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|devices.productionModel
|cuda:0
| rowspan="9" |Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей. productionModel подразумевает все рабочие модели классификации, которые создаются в системе. Остальные модели — сервисные: embeddingModel — языковая, punctuationModel — пунктуация, emotionsModel — анализ эмоций, compressorModel — модель сжатия фраз, toxicityModel — модель анализа фразы на токсичность. Можно отдельно по названию сервисной модели включать/выключать ее загрузку в GPU. Рабочие модели можно включить в память GPU только все вместе.
|-
|devices.normalizationModel
|cuda:0
|-
|devices.embeddingModel
|cuda:0
|-
|devices.punctuationModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.compressorModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.toxicityModel
|cuda:0
|-
|devices.correctionModel
|cuda:0
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

===== '''Работа сервиса через реверс-прокси''' =====
Сервис предполагает передачу больших объемов данных через HTTP. Рекомендуем соответствующим образом настроить конфигурацию сайта в реверс-прокси. Например, в nginx дополнительные параметры:
client_max_body_size 0;
proxy_read_timeout 3h;
large_client_header_buffers 8 256k;

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SMC для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SMC, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.smc.cluster.trainer указываем мастер-сервер, в servers.smc.cluster перечисляем все сервера кластера SMC, в том числе и мастер.

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/smc/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/smc/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

===== '''Практические рекомендации''' =====
Сервис SMC в работе использует большую языковую модель, которая формирует многомерное семантическое пространство. Смысл фразы для ее классификации вычисляется на основании вектора фразы в этом пространстве. Для производительности таких вычислений рекомендуется использовать GPU с 16 Гб видеопамяти. В случае отсутствия видеокарт рекомендуется использовать не менее 3 серверов по 8 ядер и 16 Гб оперативной памяти. При этом желательно в строке запуска gunicorn в файле сервиса добавить параметр '''«-w 2»'''. Это приведет к загрузке в память 2-х экземпляров приложения и моделей и позволит при высокой нагрузке полностью загрузить процессорные ядра.

В папке /opt/smc/cache/ находится кэш векторов фраз, которые были созданы моделью векторизации. При работе сервиса при наличии вектора в кэше, он берется из него, а не создается моделью заново. Причем остается в ОЗУ тоже, что значительно увеличивает производительность сервиса, однако при прохождении через сервис большого количества различных фраз может привести к потреблению нескольких гигабайт памяти. Необходимо либо увеличить количество ОЗУ, либо просто перезагружать сервис в нерабочее время. Папку cache при желании можно периодически чистить, но в данном случае кэш будет постепенно заполняться заново с использованием GPU.

SMC. Руководство администратора

2026-01-29T07:36:30Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для анализа и классификации текстовой информации. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Message Classifier (SMC) – сервис анализа и классификации.

===== '''Системные требования для SMC''' =====
Для работы smc рекомендуется использовать видеокарту NVIDIA, поддерживающую технологию CUDA и имеющую в составе ядра CUDA.

В случае отсутствия видеокарты для нормальной работы сервиса необходимо обеспечить не менее 8 потоков CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее. В конфигурации 8 потоков Intel(R) Xeon(R) Gold 6148 2.40GHz 6Гб ОЗУ фраза из 10 слов классифицируется 0.2с, соответственно за секунду может быть распознано до 5 фраз, отправленных на распознавание последовательно или одновременно. Увеличение количества ядер/потоков дает прирост производительности, но не прямо пропорциональный.

Оперативной памяти необходимо не менее 4Gb.

Для обучения моделей рекомендуется использовать видеокарту. Обучение модели на корпусе размером 7500 строк занимает на ВМ с 16 ядрами, 16Гб ОЗУ и видеокартой А16 (одном из 4-х ее ядер) около 20 минут. Недостаточная мощность CPU может увеличить время обучения за счет подготовки данных.

===== '''Установка/обновление сервиса SMC''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/smc&fileid=560 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SMC осуществляется скриптом <code>chmod +x ./smc-<версия>-<релиз>.sh && ./smc-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./smc-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/smc</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SMC<code>/opt/smc/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/smc/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/smc/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/smc/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/smc/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/smc/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/smc/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable smc.service && sudo systemctl start smc.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status smc.service</code>

Разрешите доступ к порту 6181 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/smc/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "smc", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start smc</code> и извлечь UUID, указанный в файле <code>/opt/smc/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка сервисных моделей SMC''' =====
Установка сервисных моделей возможна только копированием файла(файлов) модели в каталог с названием модели. Названия моделей предопределены и соответствуют их назначению (compressor, correction, embeddings, emotions, normalization, punctuation, toxicity). Установка сервисных моделей невозможна через API, в отличие от моделей классификации.

Модели располагаются в каталоге /opt/smc/pretrained/. Для установки модели необходимо создать каталог /opt/smc/pretrained/<название модели>/ и распаковать в неё архив модели, после чего перезагрузить сервис командой systemctl restart smc.

Проверить корректность работы модели пунктуации можно запросом к API с отправкой текста на распознавание:

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate?text=</nowiki><текст>"</code>

Список всех моделей представлен в таблице:
{| class="wikitable"
|+
!'''Модель'''
!'''Описание'''
!'''Пример запроса к модели'''
!'''Пример ответа от модели'''
|-
|'''embeddings'''
|Языковая, отвечает за вычисление векторов при обучении модели.
|Проверить работу напрямую запросом к API не получится, метод не предусмотрен.
| -
|-
|'''compressor'''
|Модель сжатия фраз. Убирает из фразы слова, не влияющие на ее смысл.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/compress?threshold=30</nowiki>" --data-urlencode "text=как можно было бы получить выплату мне бы" -H "accept: application/json"|jq</code>
|<code>{ "text": "получить выплату мне бы" }</code>
|-
|'''emotions'''
|Анализ эмоций.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/emotion</nowiki>" --data-urlencode "text=спасибо все хорошо" -H "accept: application/json"|jq</code>
|''<code>{ "emotion": "positive", "score": 0.9601 }</code>''
|-
|'''punctuation'''
|Пунктуация.
|Проверить работу можно через API запросом:
''<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate</nowiki>?" --data-urlencode "text=я пришел как мне получить услугу" -H "accept: application/json"|jq</code>''
|<code>{ "text": "Я пришел. Как мне получить услугу?" }</code>
|-
|'''normalization'''
|Обратная нормализация, заменяет числа прописью на цифры. <blockquote>''Внимание! У модели есть дополнительные требования к модулям Python в файле requirements.txt!''</blockquote>
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/normalize</nowiki>?" --data-urlencode "text=запишите меня к тринадцати" -H "accept: application/json"|jq</code>
|<code>{"text": "запишите меня к 13-ти"}</code>
|-
|'''correction'''
|Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели).
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/correct</nowiki>?" --data-urlencode "text=халодная вода" -H "accept: application/json"|jq</code>
|<code>{"text": "холодная вода"}</code>
|-
|'''toxicity'''
|Анализ текста на невежливость, угрозы, брань.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/toxicity</nowiki>?" --data-urlencode "text=нехороший человек" -H "accept: application/json"|jq</code>
Подробнее см в [[SMC. Руководство пользователя|руководстве пользователя]].

| -
|}

'''ВНИМАНИЕ!''' Модели '''punctuation, embeddings, correction''' обязательны для установки, остальные - в зависимости от сценария использования.

===== '''Установка моделей классификации''' =====
Модель классификации — это модель, обученная на определенном наборе данных (корпусе) и предназначенная непосредственно для классификации. Установка модели возможна запросом с помощью методов API. Методы описаны в [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F руководстве пользователя]. Также модель может быть установлена копированием содержимого каталога /opt/smc/nnets/<имя модели> с одного сервера smc на другой. Внимание! При этом способе UPS, в конфигурационном файле которого указан новый smc, не увидит скопированную модель.

===== '''Конфигурирование параметров сервиса''' =====

Настройка параметров сервиса smc производится в файле /opt/smc/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/smc/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|noise.enabled
|true
|Детекция мусора при классификации (фраз, которые не относятся ни к одному классу)
|-
|noise.threshold
|0.7
|Порог отсева
|-
|cache.size.embedding
|262144
| rowspan="5" |Максимальный размер кэша векторов (штуки)
|-
|cache.size.classify
|32768
|-
|cache.size.correction
|32768
|-
|cache.size.punctuation
|32768
|-
|cache.size.similar
|32768
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|devices.productionModel
|cuda:0
| rowspan="9" |Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей. productionModel подразумевает все рабочие модели классификации, которые создаются в системе. Остальные модели — сервисные: embeddingModel — языковая, punctuationModel — пунктуация, emotionsModel — анализ эмоций, compressorModel — модель сжатия фраз, toxicityModel — модель анализа фразы на токсичность. Можно отдельно по названию сервисной модели включать/выключать ее загрузку в GPU. Рабочие модели можно включить в память GPU только все вместе.
|-
|devices.normalizationModel
|cuda:0
|-
|devices.embeddingModel
|cuda:0
|-
|devices.punctuationModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.compressorModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.toxicityModel
|cuda:0
|-
|devices.correctionModel
|cuda:0
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

===== '''Работа сервиса через реверс-прокси''' =====
Сервис предполагает передачу больших объемов данных через HTTP. Рекомендуем соответствующим образом настроить конфигурацию сайта в реверс-прокси. Например, в nginx дополнительные параметры:
client_max_body_size 0;
proxy_read_timeout 3h;
large_client_header_buffers 8 256k;

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SMC для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SMC, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.smc.cluster.trainer указываем мастер-сервер, в servers.smc.cluster перечисляем все сервера кластера SMC, в том числе и мастер.

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/smc/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/smc/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

===== '''Практические рекомендации''' =====
Сервис SMC в работе использует большую языковую модель, которая формирует многомерное семантическое пространство. Смысл фразы для ее классификации вычисляется на основании вектора фразы в этом пространстве. Для производительности таких вычислений рекомендуется использовать GPU с 16 Гб видеопамяти. В случае отсутствия видеокарт рекомендуется использовать не менее 3 серверов по 8 ядер и 16 Гб оперативной памяти. При этом желательно в строке запуска gunicorn в файле сервиса добавить параметр '''«-w 2»'''. Это приведет к загрузке в память 2-х экземпляров приложения и моделей и позволит при высокой нагрузке полностью загрузить процессорные ядра.

В папке /opt/smc/cache/ находится кэш векторов фраз, которые были созданы моделью векторизации. При работе сервиса при наличии вектора в кэше, он берется из него, а не создается моделью заново. Причем остается в ОЗУ тоже, что значительно увеличивает производительность сервиса, однако при прохождении через сервис большого количества различных фраз может привести к потреблению нескольких гигабайт памяти. Необходимо либо увеличить количество ОЗУ, либо просто перезагружать сервис в нерабочее время. Папку cache при желании можно периодически чистить, но в данном случае кэш будет постепенно заполняться заново с использованием GPU.

RES. Руководство администратора

2026-01-16T08:35:19Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для обеспечения доступа к отчетам kibana в интерфейсе UPS и отправки в elasticsearch статистики работы роботов SES.

===== '''Термины и определения''' =====
Report Engine Service (RES) – сервис проксирования запросов к отчетам Kibana в интерфейсе UPS. Сервис отображает все отчеты Kibana.
===== '''Требования к окружению''' =====
Для нормальной работы сервис должен быть установлен на сервере с UPS. В процессе работы сервис взаимодействует со следующими сервисами:
• UPS – настройка осуществляется через файл /opt/ups/config.json
• Kibana – настраивается через файл /opt/res/config.json. kibana может быть расположен на другом хосте
• elasticsearch - настраивается через файл /opt/res/config.json. elasticsearch может быть расположен на другом хосте
• SES – настраивается через файл /opt/res/config.json. SES может быть расположен на другом хосте
===== '''Установка RES''' =====

Дистрибутив распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление RES осуществляется скриптом <code>chmod +x ./res-<версия>-<релиз>.sh && ./res-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./res-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/res/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/res</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить RES <code>/opt/res/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/res/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/res/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/res/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/res/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/res/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''<nowiki>https://repo.connect2ai.net/api</nowiki>'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от '''Nextcloud'''.
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/res/.userapi (это файл авторизации в API, нужен для обновления и загрузки )
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/res/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable res.service && sudo systemctl start res.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status res.service</code>

Разрешите доступ к портам 6157/tcp, 6170/tcp а также порту, определенном в конфиге (по умолчанию 6189/tcp) на нужном интерфейсе.

==='''Настройка'''===
===='''Файл config.json'''====
Настройка параметров сервиса res производится в файле /opt/res/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
! style="width: 22%" |Параметр
!По умолчанию
!Назначение
|-
|port
|6189
|Порт API интерфейса используется в UPS — настройка servers.res в конфиге UPS.
|-
|servers.{service}.urls
|"<nowiki>http://127.0.0.1:{port}/{service}</nowiki>"
|Список серверов {port}/{service} для получения статистики. Сервисы - 6190/ses
и 6188/cls
|-
|servers.{service}.timers.connect
|60
|Таймаут на подключение к серверам {service}. При превышении в журнал будет записана ошибка таймаута.
|-
|servers.{service}.timers.read
|120
|Таймаут на чтение статистики с серверов {service}. При превышении в журнал будет записана ошибка таймаута.
|-
|servers.ses.scores
|["one", "two", "three",
"four", "five"]
|Ключевые слова для поиска оценки работы - только для ses.
|-
|servers.elastic.url
|"https://10.2.0.30:9200"
|Сервер Elasticsearch для выгрузки статистики.
|-
|servers.elastic.username
|"elastic"
|Пользователь elasticsearch.
|-
|servers.elastic.password
|" "
|Пароль пользователя elasticsearch.
|-
|servers.elastic.timers.connect
|60
|Таймаут на подключение к серверам Elasticsearch. При превышении в журнал будет записана ошибка таймаута.
|-
|servers.elastic.timers.read
|120
|Таймаут на выгрузку статистики на сервер Elasticsearch. При превышении в журнал будет записана ошибка таймаута.
|-
|servers.kibana.url
|"https://10.2.0.30:5601"
|Сервер kibana для получения отчетов.
|-
|servers.kibana.timers.connect
|60
|Таймаут на подключение к серверу Kibana. При превышении в журнал будет записана ошибка таймаута.
|-
|servers.kibana.timers.read
|120
|Таймаут на чтение отчетов с сервера Kibana. При превышении в журнал будет записана ошибка таймаут.а
|-
|loader.time
|["0 5 * * *", "0 17 * * *"]
|Ежедневное расписание загрузки статистики в формате cron. Записей может быть больше если нужно чаще актуализировать статистику.
|-
|logs.path
|"logs/"
|Папка хранения журналов.
|-
|logs.backups
|10
|Максимальное количество журнальных файлов.
|-
|logs.maxSize
|5242880
|Максимальный размер журнального файла.
|}
Для того чтобы рабочие столы с отчетами были доступны в UPS по https протоколу, в конфигурации реверс прокси должны быть следующие директивы (для nginx):

proxy_set_header Host $host;

 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

 proxy_set_header X-Forwarded-Proto $scheme;

 proxy_set_header X-Forwarded-Ssl on; # Optional

 proxy_set_header X-Forwarded-Port $server_port;

 proxy_set_header X-Forwarded-Host $host;

Также должен быть еще один конфиг файл который перенаправляет порт 5602 ssl на порт 5602 сервиса UPS (proxy_pass <nowiki>https://UPS_IP:5602</nowiki>;)

В конфиге должны быть директивы для заголовков CORS и обработки OPTIONS запросов.

===='''Установка и настройка kibana + elasticsearch'''====

'''ВНИМАНИЕ - раздел в доработке'''

Для работы RES нужно установить и соответствующим образом настроить Elasticsearch и Kibana. Без настроенного подключения к рабочим Elasticsearch и Kibana RES не стартует и пишет в логи ошибку.

Пример установки на один хост с IP 1.2.3.4, без кластера.

'''Устанавливаем''' elasticsearch

<code>dpkg -i elasticsearch-8.15.3-amd64.deb</code>

Инсталлятор должен выдать

<code>The generated password for the elastic built-in superuser is : j9Of2HyCHcK55ElgziyW</code>

'''Копируем пароль''' — он будет использован в разделе servers.elastic.password файла конфигурации RES и для входа в веб-интерфейс Kibana.

'''Генерируем''' CA.

<code>/usr/share/elasticsearch/bin/elasticsearch-certutil ca --pem --out /etc/elasticsearch/certs/ca.zip;</code>

<code>cd /etc/elasticsearch/certs/;</code>

<code>unzip ca.zip;</code>

С использованием CA '''генерируем''' сертификаты для elastik

<code>/usr/share/elasticsearch/bin/elasticsearch-certutil cert \</code>

<code>--out /etc/elasticsearch/certs/elastic.zip \</code>

<code>--name elastic \</code>

<code>--ip 1.2.3.4, 127.0.0.1 \</code>

<code>--ca-cert /etc/elasticsearch/certs/ca/ca.crt \</code>

<code>--ca-key /etc/elasticsearch/certs/ca/ca.key \</code>

<code>--pem;</code>

<code>cd /etc/elasticsearch/certs/;</code>

<code>unzip elastic.zip</code>

'''Правим''' конфиг elasticsearch <code>/etc/elasticsearch/elasticsearch.yml</code>

Результат:

<code>cluster.name: res # '''''имя кластера - произвольно'''''</code>

<code>path.data: /var/lib/elasticsearch</code>

<code>path.logs: /var/log/elasticsearch</code>

<code>network.host: 1.2.3.4 # '''''здесь ip хоста'''''</code>

<code>http.port: 9200</code>

<code>xpack.security.enabled: true</code>

<code>xpack.security.enrollment.enabled: true</code>

<code>xpack.security.http.ssl:</code>

<code> enabled: true</code>

<code> key: /etc/elasticsearch/certs/elastic/elastic.key</code>

<code> certificate: /etc/elasticsearch/certs/elastic/elastic.crt</code>

<code> certificate_authorities: /etc/elasticsearch/certs/ca/ca.crt</code>

<code>xpack.security.transport.ssl:</code>

<code> enabled: true</code>

<code> verification_mode: certificate</code>

<code> keystore.path: certs/transport.p12</code>

<code> truststore.path: certs/transport.p12</code>

<code>cluster.initial_master_nodes: ["hostname"] # '''''здесь подставить имя хоста'''''</code>

<code>http.host: 0.0.0.0</code><blockquote>'''''Внимание: копировать конфиг отсюда напрямую не получится, wiki добавляет в начало строки вместо пробела «неразрывный пробел» — yaml его не воспринимает.'''''</blockquote>'''Стартуем''' сервис

<code>systemctl daemon-reload</code>

<code>systemctl enable elasticsearch.service</code>

<code>systemctl start elasticsearch</code>

'''Проверяем''' с использованием пароля, сгенерированного в начале

<code>curl -X GET -u elastic:j9Of2HyCHcK55ElgziyW <nowiki>https://1.2.3.4:9200</nowiki> --cacert /etc/elasticsearch/certs/ca/ca.crt</code>

'''Устанавливаем''' kibana

<code>dpkg -i kibana-8.15.3-amd64.deb</code>

Папка для сертификатов: mkdir -p /etc/kibana/certs/

Копируем корневой сертификат: cp -r /etc/elasticsearch/certs/ca /etc/kibana/certs/

'''Получим''' пароль для доступа из kibana в elasticsearch <code>/usr/share/elasticsearch/bin/elasticsearch-reset-password -u kibana_system --auto</code>

Пароль нужен будет дальше в строке <code>elasticsearch.password:</code> конфига kibana.

Kibana ставим в варианте http (без ssl).

'''Правим''' конфиг kibana <code>/etc/kibana/kibana.yml</code>

Результат

<code>server.port: 5601</code>

<code>server.host: 0.0.0.0</code>

<code>server.publicBaseUrl: "<nowiki>http://1.2.3.4:5601</nowiki>"</code>

<code>server.ssl.enabled: false</code>

<code>elasticsearch.hosts: ["<nowiki>https://1.2.3.4:9200</nowiki>"]</code>

<code>elasticsearch.username: "kibana_system"</code>

<code>elasticsearch.password: "gfntin_083SKBYC9V5yk"</code>

<code>elasticsearch.ssl.certificateAuthorities: /etc/kibana/certs/ca/ca.crt</code>

<code>elasticsearch.ssl.verificationMode: full</code>

<code>logging:</code>

<code> appenders:</code>

<code> file:</code>

<code> type: file</code>

<code> fileName: /var/log/kibana/kibana.log</code>

<code> layout:</code>

<code> type: json</code>

<code> root:</code>

<code> appenders:</code>

<code> - default</code>

<code> - file</code>

<code>pid.file: /run/kibana/kibana.pid</code>

<code>xpack.security.authc.providers:</code>

<code> basic.basic1:</code>

<code> order: 0</code>

<code>csp.strict: false</code>

<code>csp.warnLegacyBrowsers: false</code>

<code>csp.script_src:</code>

<code> - unsafe-inline</code>

<code> - self</code>

<code> - unsafe-eval</code>

<code>server.customResponseHeaders: {"x-frame-options":"ALLOWALL"}</code>

'''Запускаем''' kibana <code>systemctl enable kibana && systemctl start kibana</code>

Заходим по адресу <nowiki>https://1.2.3.4:5601/</nowiki> с пользователем elastic и паролем, который создал инсталлятор elasticsearch. Если видим стартовую страничку Kibana, то Elasticsearch и Kibana готовы к работе с RES. После запуска RES установит пользователя reports с паролем reports и правом доступа к рабочим столам kibana. Рекомендуется сменить после этого пароль. Этот пользователь и пароль должен быть указан в [https://wiki.connect2ai.net/index.php/UPS._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%BE%D0%B2_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0 конфиг файле ups] в разделе res.

==='''Протоколы и порты'''===

Сервис использует порт 6156/tcp - реверс прокси кибаны и 6189/tcp для доступа к API-интерфейсу. Порт доступа к API может быть изменен в конфигурационном файле.

==='''Журналы работы'''===

Для проверки состояния сервиса выполните <code>sudo systemctl status res</code>.

Журналы сервиса находятся в каталоге, определенном в конфигурационном файле (по умолчанию — <code>/opt/res/logs/</code>). Ошибки также пишутся в системный журнал, для просмотра можно воспользоваться командой <code>sudo journalctl -u res</code>
==='''Удаление и обновление RES'''===
Для удаления выполните команду:

<code>/opt/res/uninstall</code>

Команда удалит сервис и рабочий каталог, включая все файлы конфигурации. Для обновления запустите скрипт установки, как указано в п. 4. При этом обновление не изменяет файл /opt/res/config.json.

QAS. Руководство администратора

2026-01-15T16:50:06Z

KorolkovS:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.
====='''Термины и определения'''=====
Question Answering System (QAS) – сервис ответов на вопросы.

====='''Системные требования'''=====
Для нормальной работы сервиса без GPU необходимо не менее 8 CPU (минимальные требования для использования метода ask) >= 2.20 GHz с поддержкой инструкций AVX2 или новее:
*Intel Haswell
*Intel Broadwell
*Intel Skylake
*Intel Kaby Lake
*Intel Coffee Lake
*Intel Comet Lake
*Intel Rocket Lake
*Intel Alder Lake
*AMD Excavator
*AMD Zen (AMD Ryzen)
*AMD Zen 2 (AMD Ryzen)
*AMD Zen 3 (AMD Ryzen)
Работа на CPU при использовании метода ask крайне не рекомендуется. Оперативной памяти необходимо не менее 16Gb для работы без GPU.

====='''Установка/обновление сервиса'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/qas&fileid=26891 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить отдельный сервисный пакет окружения под QAS]].

* Установка/обновление QAS осуществляется скриптом <code>chmod +x ./qas-<версия>-<релиз>.sh && ./qas-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./qas-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s https://repo.connect2ai.net/api/qas --user '[user]:[pass]' 2>&1)"</code>.
* Обновить QAS <code>/opt/qas/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/qas/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/qas/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/qas/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/qas/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/qas/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/qas/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable qas.service && sudo systemctl start qas.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status qas.service</code>

Разрешите доступ к порту 6187 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/qas/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "qas", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start qas</code> и извлечь UUID, указанный в файле <code>/opt/qas/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка моделей'''=====

В составе QAS используются модели векторизации, и генеративные модели LLM.

Модель векторизации располагается в папке /opt/qas/pretrained/embeddings - для работы с кэшем вопросов и документами

Расположение моделей LLM: /opt/qas/pretrained/gpt/<имя_модели>/. Например , встроенная модель LLM: /opt/qas/pretrained/gpt/default/. Модели после установки QAS должны быть добавлены системным администратором.

QAS допускает использование дополнительных моделей LLM. Каждая из таких моделей должна быть в отдельной папке каталога /opt/qas/pretrained/gpt/<имя_модели>/. Если модель формата GGUF, то достаточно поместить ее в свою папку в /opt/qas/pretrained/gpt/. В остальных случаях (в том числе и если необходимо обращаться к стороннему api) в папке модели должен быть файл handler.py с функцией handler(prompt='тут текст',params={параметры запроса, см. в руководстве пользователя в метода добавления шаблона запроса}), которая возвращает сгенерированный текст.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:

* База файловая, в папке data.
* lsync настроен через конфиг QAS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах прописан в конфиге master, чтобы все операции добавления и изменения данных при автокешировании они производили через мастер. Параметр в конфиге questions.master, на мастере значение «<nowiki>http://127.0.0.1:6187»</nowiki>.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером QAS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.qas.trainer указываем мастер-сервер, в servers.qas.cluster перечисляем все сервера кластера QAS, в том числе и мастер.

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса qas производится в файле /opt/qas/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!По умолчанию
!Назначение
|-
|reloader.period
|60
|Период обновления векторов базы вопросов и документов.
|-
|gpt.instances
|1
|Количество экземпляров встроенной нейросети
|-
|gpt.gpu_layers
|12
|Количество слоёв gpt нейросети, загружаемых в память видеокарты. Остальные слои загрузятся в оперативную память. Чтобы загрузить '''всю''' модель в ГПУ использовать значение "'''-1'''"
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|2560000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|fragments.context
|16384
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.5
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|fragments.alpha
|0.5
|Параметр alpha — весовой коэффициент в формуле итоговой релевантности фрагмента, которая объединяет результаты двух моделей: векторизации и реранжирования.
Настройка параметра:

- Высокие значения (близкие к 1.0): Система в большей степени доверяет результатам модели векторизации.

- Низкие значения (близкие к 0.0): Система больше полагается на более точную, но ресурсоемкую модель реранжирования.
|-
|fragments.filters
|[
"^\\d+\\.$",

"^[^\\S\n]*[(\\{\\[«\"]?\\d+\\.[^\\S\\\n]*$",

"^[{}\\[\\]]$",

"^[a-z]{2,3}\\.?$",

"^(?:https?|ftp|www|com|org|net|io|co|edu|gov|html)$"

]
|Список регулярных выражений, который используются как фильтр мусора для векторизации. Все что вызывает положительно срабатывание не будет векторизовано.
|-
|questions.master
|"<nowiki>http://127.0.0.1:6187</nowiki>"
|Адрес мастер-сервера для работы в кластере. Необходим, чтобы добавленные вопросы распространились на серверы кластера.
|-
|questions.threshold
|0.9
|Минимальный уровень достоверности ответа для попадания в кеш.
|-
|cluster.logfile
|logs/sync.log
|Расположение лог-файла синхронизации (актуально для мастер-сервера).
|-
|cluster.logfile
|logs/sync.status
|Расположение файла статуса lsyncd (актуально для мастер-сервера)
|-
|cluster.nodes
|[ ]
|Ноды кластера, на которые с мастер-сервера будут распространяться изменения.
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/qas/logs/log.txt

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/qas/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

QAS. Руководство администратора

2026-01-15T15:14:49Z

KorolkovS:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.
====='''Термины и определения'''=====
Question Answering System (QAS) – сервис ответов на вопросы.

====='''Системные требования'''=====
Для нормальной работы сервиса без GPU необходимо не менее 8 CPU (минимальные требования для использования метода ask) >= 2.20 GHz с поддержкой инструкций AVX2 или новее:
*Intel Haswell
*Intel Broadwell
*Intel Skylake
*Intel Kaby Lake
*Intel Coffee Lake
*Intel Comet Lake
*Intel Rocket Lake
*Intel Alder Lake
*AMD Excavator
*AMD Zen (AMD Ryzen)
*AMD Zen 2 (AMD Ryzen)
*AMD Zen 3 (AMD Ryzen)
Работа на CPU при использовании метода ask крайне не рекомендуется. Оперативной памяти необходимо не менее 16Gb для работы без GPU.

====='''Установка/обновление сервиса'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/qas&fileid=26891 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить отдельный сервисный пакет окружения под QAS]].

* Установка/обновление QAS осуществляется скриптом <code>chmod +x ./qas-<версия>-<релиз>.sh && ./qas-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./qas-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s https://repo.connect2ai.net/api/qas --user '[user]:[pass]' 2>&1)"</code>.
* Обновить QAS <code>/opt/qas/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/qas/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/qas/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/qas/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/qas/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/qas/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/qas/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable qas.service && sudo systemctl start qas.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status qas.service</code>

Разрешите доступ к порту 6187 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/qas/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "qas", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start qas</code> и извлечь UUID, указанный в файле <code>/opt/qas/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка моделей'''=====

В составе QAS используются модели векторизации, и генеративные модели LLM.

Модель векторизации располагаются в папке /opt/qas/pretrained/embeddings - для работы с кэшем вопросов и документами

Расположение моделей LLM: /opt/qas/pretrained/gpt/<имя_модели>/. Например , встроенная модель LLM: /opt/qas/pretrained/gpt/default/. Модели после установки QAS должны быть добавлены системным администратором.

QAS допускает использование дополнительных моделей LLM. Каждая из таких моделей должна быть в отдельной папке каталога /opt/qas/pretrained/gpt/<имя_модели>/. Если модель формата GGUF, то достаточно поместить ее в свою папку в /opt/qas/pretrained/gpt/. В остальных случаях (в том числе и если необходимо обращаться к стороннему api) в папке модели должен быть файл handler.py с функцией handler(prompt='тут текст',params={параметры запроса, см. в руководстве пользователя в метода добавления шаблона запроса}), которая возвращает сгенерированный текст.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:

* База файловая, в папке data.
* lsync настроен через конфиг QAS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах прописан в конфиге master, чтобы все операции добавления и изменения данных при автокешировании они производили через мастер. Параметр в конфиге questions.master, на мастере значение «<nowiki>http://127.0.0.1:6187»</nowiki>.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером QAS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.qas.trainer указываем мастер-сервер, в servers.qas.cluster перечисляем все сервера кластера QAS, в том числе и мастер.

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса qas производится в файле /opt/qas/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!По умолчанию
!Назначение
|-
|reloader.period
|60
|Период обновления векторов базы вопросов и документов.
|-
|gpt.instances
|1
|Количество экземпляров встроенной нейросети
|-
|gpt.gpu_layers
|12
|Количество слоёв gpt нейросети, загружаемых в память видеокарты. Остальные слои загрузятся в оперативную память. Чтобы загрузить '''всю''' модель в ГПУ использовать значение "'''-1'''"
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|2560000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|fragments.context
|16384
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.5
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|fragments.alpha
|0.5
|Параметр alpha — весовой коэффициент в формуле итоговой релевантности фрагмента, которая объединяет результаты двух моделей: векторизации и реранжирования.
Настройка параметра:

- Высокие значения (близкие к 1.0): Система в большей степени доверяет результатам модели векторизации.

- Низкие значения (близкие к 0.0): Система больше полагается на более точную, но ресурсоемкую модель реранжирования.
|-
|fragments.filters
|[
"^\\d+\\.$",

"^[^\\S\n]*[(\\{\\[«\"]?\\d+\\.[^\\S\\\n]*$",

"^[{}\\[\\]]$",

"^[a-z]{2,3}\\.?$",

"^(?:https?|ftp|www|com|org|net|io|co|edu|gov|html)$"

]
|Список регулярных выражений, который используются как фильтр мусора для векторизации. Все что вызывает положительно срабатывание не будет векторизовано.
|-
|questions.master
|"<nowiki>http://127.0.0.1:6187</nowiki>"
|Адрес мастер-сервера для работы в кластере. Необходим, чтобы добавленные вопросы распространились на серверы кластера.
|-
|questions.threshold
|0.9
|Минимальный уровень достоверности ответа для попадания в кеш.
|-
|cluster.logfile
|logs/sync.log
|Расположение лог-файла синхронизации (актуально для мастер-сервера).
|-
|cluster.logfile
|logs/sync.status
|Расположение файла статуса lsyncd (актуально для мастер-сервера)
|-
|cluster.nodes
|[ ]
|Ноды кластера, на которые с мастер-сервера будут распространяться изменения.
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/qas/logs/log.txt

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/qas/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

TTS. Руководство пользователя

2026-01-14T07:20:00Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.

====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени

===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/cache/{path}'''
! colspan="2" style="width: 85%" |Выгрузка аудиофайла из кэша.
|-
| colspan="2" style="width: 50%" |
*'''path''' - путь к аудиофайлу относительно папки /opt/tts/cache/
| style="width: 50%" |аудиофайл
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |простой текст - строки с словом и его интерпретацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<code>[</code> <code>[ "слово", "замена слова с удар+ением"],</code>

<code>[ "слово2", "замена слова2 с удар+ением"],</code>

<code>...</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл строк со словом и его интерпретацией с ударением.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/tts/models'''
! colspan="2" style="width: 85%" |Перечень моделей синтеза речи. Модели поставляются только в составе дистрибутива.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |
<code>{"models": ["Аля","Жанна","Дима","Елена"]}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для нормализации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "нормализованный текст"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/phonemes'''
! colspan="2" style="width: 85%" |Конвертация текста в последовательность фонем.
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для фонемизации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "последовательность фонем"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
* '''wav''' — аудиофайл для обработки.
* '''revoicer''' — модель модификации голоса.
| style="width: 50%" |wav файл с модифицированным (искаженным) голосом.
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "distortion" ]
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.
|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для обработки
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "phrases": [ "фраза 1", "фраза 2", .... "фраза N" ] }
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.
|-
| colspan="2" style="width: 50%" |
* '''ID''' — имя модели
* '''text''' — текст синтезируемой фразы
* '''rate''' — скорость речи
* '''pitch''' — высота (тон)
* '''volume''' — громкость
* '''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
* '''format''' - формат файла результата (wav, opus, ogg, mp3)
* '''link''' - если 1, то вернуть только ссылку на файл
| style="width: 50%" |файл с синтезированой фразой
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |Проверка лицензии
|-
| colspan="2" |Входные параметры отсутствуют
|Пример '''неограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>

Пример '''ограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": 100,</code>

<code>"threshold": 100</code>

<code>}</code>

TTS. Руководство пользователя

2026-01-14T07:15:25Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.

====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени

===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/cache/{path}'''
! colspan="2" style="width: 85%" |Выгрузка аудиофайла из кэша.
|-
| colspan="2" style="width: 50%" |
*'''path''' - путь к аудиофайлу относительно папки /opt/tts/cache/
| style="width: 50%" |аудиофайл
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |простой текст - строки с словом и его интерпретацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<code>[</code> <code>[ "слово", "замена слова с удар+ением"],</code>

<code>[ "слово2", "замена слова2 с удар+ением"],</code>

<code>...</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл строк со словом и его интерпретацией с ударением.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/tts/models'''
! colspan="2" style="width: 85%" |Перечень моделей синтеза речи. Модели поставляются только в составе дистрибутива.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |
<code>{"models": ["Аля","Жанна","Дима","Елена"]}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для нормализации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "нормализованный текст"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
* '''wav''' — аудиофайл для обработки.
* '''revoicer''' — модель модификации голоса.
| style="width: 50%" |wav файл с модифицированным (искаженным) голосом.
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "distortion" ]
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.
|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для обработки
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "phrases": [ "фраза 1", "фраза 2", .... "фраза N" ] }
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.
|-
| colspan="2" style="width: 50%" |
* '''ID''' — имя модели
* '''text''' — текст синтезируемой фразы
* '''rate''' — скорость речи
* '''pitch''' — высота (тон)
* '''volume''' — громкость
* '''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
* '''format''' - формат файла результата (wav, opus, ogg, mp3)
* '''link''' - если 1, то вернуть только ссылку на файл
| style="width: 50%" |файл с синтезированой фразой
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |Проверка лицензии
|-
| colspan="2" |Входные параметры отсутствуют
|Пример '''неограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>

Пример '''ограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": 100,</code>

<code>"threshold": 100</code>

<code>}</code>

TTS. Руководство пользователя

2026-01-14T07:14:27Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.

====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени

===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/cache/{path}'''
! colspan="2" style="width: 85%" |Выгрузка аудиофайла из кэша.
|-
| colspan="2" style="width: 50%" |
*'''path''' - путь к аудиофайлу относительно папки /opt/tts/cache/
| style="width: 50%" |аудиофайл
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |простой текст - строки с словом и его интерпретацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<code>[</code> <code>[ "слово", "замена слова с удар+ением"],</code>

<code>[ "слово2", "замена слова2 с удар+ением"],</code>

<code>...</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл строк со словом и его интерпретацией с ударением.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/tts/models'''
! colspan="2" style="width: 85%" |Перечень моделей синтеза речи. Модели поставляются только в составе дистрибутива.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |
<code>{
"models": [
"Аля",
"Жанна",
"Дима",
"Елена"
]
}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для нормализации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "нормализованный текст"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
* '''wav''' — аудиофайл для обработки.
* '''revoicer''' — модель модификации голоса.
| style="width: 50%" |wav файл с модифицированным (искаженным) голосом.
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "distortion" ]
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.
|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для обработки
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "phrases": [ "фраза 1", "фраза 2", .... "фраза N" ] }
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.
|-
| colspan="2" style="width: 50%" |
* '''ID''' — имя модели
* '''text''' — текст синтезируемой фразы
* '''rate''' — скорость речи
* '''pitch''' — высота (тон)
* '''volume''' — громкость
* '''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
* '''format''' - формат файла результата (wav, opus, ogg, mp3)
* '''link''' - если 1, то вернуть только ссылку на файл
| style="width: 50%" |файл с синтезированой фразой
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |Проверка лицензии
|-
| colspan="2" |Входные параметры отсутствуют
|Пример '''неограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>

Пример '''ограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": 100,</code>

<code>"threshold": 100</code>

<code>}</code>

TTS. Руководство пользователя

2026-01-14T07:13:24Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.

====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени

===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/cache/{path}'''
! colspan="2" style="width: 85%" |Выгрузка аудиофайла из кэша.
|-
| colspan="2" style="width: 50%" |
*'''path''' - путь к аудиофайлу относительно папки /opt/tts/cache/
| style="width: 50%" |аудиофайл
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |простой текст - строки с словом и его интерпретацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<code>[</code> <code>[ "слово", "замена слова с удар+ением"],</code>

<code>[ "слово2", "замена слова2 с удар+ением"],</code>

<code>...</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл строк со словом и его интерпретацией с ударением.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/tts/models'''
! colspan="2" style="width: 85%" |Перечень моделей синтеза речи. Модели поставляются только в составе дистрибутива.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |
<code>{</code>
<code> "models": [</code>
<code> "Аля",</code>
<code> "Жанна",</code>
<code> "Дима",</code>
<code> "Елена"</code>
<code> ]</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для нормализации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "нормализованный текст"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
* '''wav''' — аудиофайл для обработки.
* '''revoicer''' — модель модификации голоса.
| style="width: 50%" |wav файл с модифицированным (искаженным) голосом.
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "distortion" ]
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.
|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для обработки
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "phrases": [ "фраза 1", "фраза 2", .... "фраза N" ] }
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.
|-
| colspan="2" style="width: 50%" |
* '''ID''' — имя модели
* '''text''' — текст синтезируемой фразы
* '''rate''' — скорость речи
* '''pitch''' — высота (тон)
* '''volume''' — громкость
* '''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
* '''format''' - формат файла результата (wav, opus, ogg, mp3)
* '''link''' - если 1, то вернуть только ссылку на файл
| style="width: 50%" |файл с синтезированой фразой
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |Проверка лицензии
|-
| colspan="2" |Входные параметры отсутствуют
|Пример '''неограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>

Пример '''ограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": 100,</code>

<code>"threshold": 100</code>

<code>}</code>

TTS. Руководство пользователя

2026-01-14T07:06:39Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.

====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени

===== '''Описание методов API''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом TTS. По умолчанию используется порт 6186/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6186 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/cache/{path}'''
! colspan="2" style="width: 85%" |Выгрузка аудиофайла из кэша.
|-
| colspan="2" style="width: 50%" |
*'''path''' - путь к аудиофайлу относительно папки /opt/tts/cache/
| style="width: 50%" |простой текст - строки с словом и его интерперетацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |простой текст - строки с словом и его интерперетацией с ударением
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="2" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<code>[</code> <code>[ "слово", "замена слова с удар+ением"],</code>

<code>[ "слово2", "замена слова2 с удар+ением"],</code>

<code>...</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл строк со словом и его интерпретацией с ударением.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="2" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="2" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
* '''text''' — фраза для нормализации.
| style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "text": "нормализованный текст"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="2" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
* '''wav''' — аудиофайл для обработки.
* '''revoicer''' — модель модификации голоса.
| style="width: 50%" |wav файл с модифицированным (искаженным) голосом.
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="2" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ "distortion" ]
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! colspan="2" style="width: 85%" |Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.
|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для обработки
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "phrases": [ "фраза 1", "фраза 2", .... "фраза N" ] }
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="2" style="width: 85%" |Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.
|-
| colspan="2" style="width: 50%" |
* '''ID''' — имя модели
* '''text''' — текст синтезируемой фразы
* '''rate''' — скорость речи
* '''pitch''' — высота (тон)
* '''volume''' — громкость
* '''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
* '''format''' - формат файла результата (wav, opus, ogg, mp3)
* '''link''' - если 1, то вернуть только ссылку на файл
| style="width: 50%" |файл с синтезированой фразой
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="2" |Проверка лицензии
|-
| colspan="2" |Входные параметры отсутствуют
|Пример '''неограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>

Пример '''ограниченной''' лицензии:

<code>{</code>

<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": 100,</code>

<code>"threshold": 100</code>

<code>}</code>

TTS. Руководство администратора

2026-01-14T06:33:02Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл в формате *.wav, *.ogg, *.opus, *.mp3.
====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы. '''''Модели и вокодеры поставляются в составе дистрибутива, дополнительных действий для их установки не требуется.'''''

====='''Расчет нагрузки'''=====
Для нормальной работы сервиса на каждый канал синтеза требуется 1 CPU >= 2.20 GHz. Оперативной памяти необходимо не менее 8 GB.

====='''Лицензия'''=====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/tts/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "tts", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start tts</code> и извлечь UUID, указанный в файле <code>/opt/tts/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка/обновление TTS'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/tts&fileid=4837 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для Вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

*Установка/обновление TTS осуществляется скриптом <code>chmod +x ./tts-<версия>-<релиз>.sh && ./tts-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./tts-<версия>-<релиз>.sh</code> без ключей.
*Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/tts</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
*Обновить TTS <code>/opt/tts/inupdate</code> в интерактивном режиме. Или запустить с ключом:
**<code>/opt/tts/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/tts/inupdate -r</code> – обновить до последней release версии;
**<code>/opt/tts/inupdate -n</code> – обновить до последней версии (неважно beta или release).
*Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/version</nowiki></code>.
*Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/changelog</nowiki>" --user '[user]:[pass]'</code>.
*Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
*В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
**echo -n <code>"[user]:[pass]"</code> > /opt/tts/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
**echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/tts/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable tts.service && sudo systemctl start tts.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status tts.service</code>

Разрешите доступ к порту 6186 на нужном интерфейсе по протоколу tcp.

====='''Конфигурирование параметров сервиса TTS'''=====
Настройка параметров сервиса tts производится в файле /opt/tts/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Максимальное количество логфайлов.
|-
|logs.maxSize
|5242880
|Максимальный размер одного логфайла.
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг TTS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером TTS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.tts.cluster.trainer указываем мастер-сервер, в servers.tts.cluster перечисляем все сервера кластера TTS, в том числе и мастер.

====='''Сбор данных об ошибках'''=====
Для увеличения информативности журналов можно выполнить от суперпользователя команду:

<code>sed -i 's/log-level error/log-level debug/g' /etc/systemd/system/tts.service && systemctl daemon-reload && systemctl restart tts.service</code>

При возникновении проблем в работе сервиса и недостаточной информативности журналов, можно запустить сервис вручную с привилегиями суперпользователя и выводом информации в stdout:

<code>systemctl stop tts.service && source /opt/pve/bin/activate && cd /opt/tts/ && python3 api.py && deactivate</code>

или

<code>systemctl stop tts.service</code>

<code>source /opt/pve/bin/activate</code>

<code>cd /opt/tts/ && python3 api.py</code>

<code>deactivate</code> 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/tts/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели и вокодер.

TTS. Руководство администратора

2026-01-14T06:32:22Z

KorolkovS: /* Конфигурирование параметров сервиса TTS */

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл в формате *.wav, *.ogg, *.opus, *.mp3.
====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы. '''''Модели и вокодеры поставляются в составе дистрибутива, дополнительных действий для их установки не требуется.'''''

====='''Расчет нагрузки'''=====
Для нормальной работы сервиса на каждый канал синтеза требуется 1 CPU >= 2.20 GHz. Оперативной памяти необходимо не менее 8 GB.

====='''Лицензия'''=====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/tts/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "tts", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start tts</code> и извлечь UUID, указанный в файле <code>/opt/tts/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка/обновление TTS'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/tts&fileid=4837 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для Вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

*Установка/обновление TTS осуществляется скриптом <code>chmod +x ./tts-<версия>-<релиз>.sh && ./tts-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./tts-<версия>-<релиз>.sh</code> без ключей.
*Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/tts</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
*Обновить TTS <code>/opt/tts/inupdate</code> в интерактивном режиме. Или запустить с ключом:
**<code>/opt/tts/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/tts/inupdate -r</code> – обновить до последней release версии;
**<code>/opt/tts/inupdate -n</code> – обновить до последней версии (неважно beta или release).
*Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/version</nowiki></code>.
*Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/changelog</nowiki>" --user '[user]:[pass]'</code>.
*Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
*В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
**echo -n <code>"[user]:[pass]"</code> > /opt/tts/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
**echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/tts/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable tts.service && sudo systemctl start tts.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status tts.service</code>

Разрешите доступ к порту 6186 на нужном интерфейсе по протоколу tcp.

====='''Конфигурирование параметров сервиса TTS'''=====
Настройка параметров сервиса tts производится в файле /opt/spr/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Максимальное количество логфайлов.
|-
|logs.maxSize
|5242880
|Максимальный размер одного логфайла.
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг TTS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером TTS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.tts.cluster.trainer указываем мастер-сервер, в servers.tts.cluster перечисляем все сервера кластера TTS, в том числе и мастер.

====='''Сбор данных об ошибках'''=====
Для увеличения информативности журналов можно выполнить от суперпользователя команду:

<code>sed -i 's/log-level error/log-level debug/g' /etc/systemd/system/tts.service && systemctl daemon-reload && systemctl restart tts.service</code>

При возникновении проблем в работе сервиса и недостаточной информативности журналов, можно запустить сервис вручную с привилегиями суперпользователя и выводом информации в stdout:

<code>systemctl stop tts.service && source /opt/pve/bin/activate && cd /opt/tts/ && python3 api.py && deactivate</code>

или

<code>systemctl stop tts.service</code>

<code>source /opt/pve/bin/activate</code>

<code>cd /opt/tts/ && python3 api.py</code>

<code>deactivate</code> 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/tts/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели и вокодер.

TTS. Руководство администратора

2026-01-14T06:16:06Z

KorolkovS: /* Общее описание */

===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл в формате *.wav, *.ogg, *.opus, *.mp3.
====='''Термины и определения'''=====
Text-to-speech server (TTS) – сервис синтеза речи.

Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.

Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы. '''''Модели и вокодеры поставляются в составе дистрибутива, дополнительных действий для их установки не требуется.'''''

====='''Расчет нагрузки'''=====
Для нормальной работы сервиса на каждый канал синтеза требуется 1 CPU >= 2.20 GHz. Оперативной памяти необходимо не менее 8 GB.

====='''Установка/обновление TTS'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/tts&fileid=4837 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для Вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление TTS осуществляется скриптом <code>chmod +x ./tts-<версия>-<релиз>.sh && ./tts-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./tts-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/tts</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить TTS <code>/opt/tts/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/tts/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/tts/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/tts/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/tts/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/tts/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/tts/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable tts.service && sudo systemctl start tts.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status tts.service</code>

Разрешите доступ к порту 6186 на нужном интерфейсе по протоколу tcp.

===== '''Конфигурирование параметров сервиса TTS''' =====
Настройка параметров сервиса tts производится в файле /opt/spr/params.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|gpu
|true
|Флаг использования видеокарты при ее наличии
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Максимальное количество логфайлов.
|-
|logs.maxSize
|5242880
|Максимальный размер одного логфайла.
|}

====='''Сбор данных об ошибках'''=====
Для увеличения информативности журналов можно выполнить от суперпользователя команду:

<code>sed -i 's/log-level error/log-level debug/g' /etc/systemd/system/tts.service && systemctl daemon-reload && systemctl restart tts.service</code>

При возникновении проблем в работе сервиса и недостаточной информативности журналов, можно запустить сервис вручную с привилегиями суперпользователя и выводом информации в stdout:

<code>systemctl stop tts.service && source /opt/pve/bin/activate && cd /opt/tts/ && python3 api.py && deactivate</code>

или

<code>systemctl stop tts.service</code>

<code>source /opt/pve/bin/activate</code>

<code>cd /opt/tts/ && python3 api.py</code>

<code>deactivate</code> 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/tts/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели и вокодер.

PVE. Установка сервисного пакета окружения

2026-01-14T06:11:30Z

KorolkovS: /* Общее описание */

===== '''Общее описание''' =====
Пакет Python Virtual Environment (PVE) предназначен для подготовки виртуального Python3 окружения для работы сервисов:
• Simple Entity Extractor
• Simple Message Classifier
• Short Phrase Recognizer
• Simple Biometry Server
• Text To Speech Server
• Question Answering System
• Script Engine Service
• Report Engine Service
• Call List Service

====='''Термины и определения'''=====
Python Virtual Environment (PVE) – пакет для установки Python3 окружения для сервисов. Самостоятельно PVE не используется.

====='''Расчет нагрузки'''=====
Для установки пакета требуется свободное место в каталоге /opt не менее 4Gb без поддержки видеокарты и/или 12Gb с поддержкой.

Также при установке используется временная папка /tmp/archive, куда распаковывается содержимое архива до 9Gb.

====='''Установка/обновление пакета окружения'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/pve&fileid=612 Дистрибутив] распространяется в виде универсального установочного пакета. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Пакет может быть установлен в ''онлайн''-режиме при наличии прямого доступа в интернет или через прокси. Для установки в ''оффлайн''-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версии и ядра) с доступом в интернет.
* Загрузить последнюю версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/pve</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить PVE <code>/opt/pve/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/pve/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/pve/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/pve/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с окружением можно добавить 2 файла конфигурации (данные файлы также будут использоваться продуктами при отсутствии у них своих):
** echo -n <code>"[user]:[pass]"</code> > /opt/pve/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/pve/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)
При установке рядом со скриптом окружения можно положить freeze.txt с альтернативным набором модулей. В потоке вывода в результате вы увидите сообщение «Существует внешний файл — список модулей pip3».

===== '''Варианты использование инсталлятора'''=====

Описание ключей установки приведено в таблице
{| class="wikitable"
|+
!Параметр,
назначение
!Параметр,
назначение
!Параметр,
назначение
!Примечание
|-
|''-i/--install - установить окружение''
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы установить в оффлайн-режиме, необходимо собрать скрипт с ключом -b/--build. Установка с ключом CPU актуальна при отсутствии видеокарты в системе, окружение занимает всего ~3Gb.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -u/--update - обновить окружение
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы обновить в оффлайн режиме, необходимо собрать скрипт с ключом -b/--build. Обновление с ключом CPU актуально при отсутствии видеокарты в системе, окружение занимает всего ~3Gb. Обновление отличается от установки тем, что пропускается этап установки системных пакетов. Ставится только окружение с модулями. Оффлайн инсталлятор с ключом обновления становится универсальным под любую ОС, так как не зависим от системных пакетов.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -b/--build - скачать все пакеты, и модули, и упаковать в скрипт
|''-i/--install - для установки с системными пакетами''
| -f/--full - полный набор pip3 модулей под все типы
| rowspan="6" |Данные наборы ключей используются совместно, в разных комбинациях. Сборка с ключом CPU актуальна при отсутствии видеокарты в системе, собранный инсталлятор весит ~1Gb. Ключ полного набора модулей делает инсталлятор универсальным, но такой инсталлятор весит ~12Gb. Если инсталлятор был собран с ключом установки под другую ОС, его также можно использовать с ключом обновления для текущей или любой другой. Если набор модулей, который включен в оффлайн инсталлятор, недостаточен, он попытается загрузить недостающие модули из интернета напрямую или предложит ввести настройки прокси.
|-
|
| -u/--update - для обновления, только окружение
| -cpu/--cpu - полный набор pip3 модулей под CPU
|-
|
|
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -u/--uninstall - удалить окружение
|
|
|Одинарный ключ, удаляет окружение из папки /opt
|-
| -e/--extract - скопировать внутренний архив рядом со скриптом
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки, распакуется архив. С указанием папки, распакуется содержимое архива в указанную папку.
|-
| -p/--pack имя_архива - запаковать архив в скрипт
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки к установщику прикрепляем архив. С указанием папки к установщику прикрепляем содержимое каталога.
|-
| -n/--null - удалить внутренний архив из скрипта
|
|
|Удаляем внутренний архив из инсталлятора. Редактирование инсталлятора с архивом может привести к повреждению архива.
|}
Примеры использования ключей:

-- Установить окружение с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -on</code>

-- Установить окружение из заранее собранного инсталлятора с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -off</code>

-- Собрать все пакеты для установки оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -i -cpu</code>

-- Собрать все пакеты для обновления оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -u -cpu</code>

-- Скопировать внутренний архив рядом со скриптом, не распаковывая в папку.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e</code>

-- Запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p <service>-offline.tgz</code>

-- Сжать каталог и запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p -d <имя каталога></code>

-- Распаковать внутренний архив рядом со скриптом в каталог.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e -d archive</code>

-- Удалить внутренний архив из скрипта.

Пример использования: <code>./pve-<версия>-<релиз>.sh --null</code>

-- Удалить окружение.

Пример использования: <code>./pve-<версия>-<релиз>.sh --uninstall</code>

====='''Удаление окружения'''=====
Для удаления выполните команду: <code>/opt/pve/uninstall</code>.

SBS. Руководство пользователя

2026-01-12T10:55:09Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Biometry Server предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) — сервис извлечения метаданных.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SBS.

===== '''Описание методов API сервиса биометрии (SBS)''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SBS. По умолчанию используется порт 6185/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6185</nowiki> будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа.
| colspan="2" style="width: 50%" |Пример:
<code>{</code>

<code> age: {</code>

<code> class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}</code>

<code> confidence: 0.99</code>

<code> },</code>

<code> emotion: {</code>

<code> class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", </code>

<code> <<"NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}</code>

<code> confidence: 0.99</code>

<code> },</code>

<code> gender: {</code>

<code> class: FEMALE, # { "MALE", "FEMALE" }</code>

<code> confidence: 0.99</code>

<code> },</code>

<code> multispeaker : {</code>

<code> class: YES, # { "YES", "NO" }</code>

<code> confidence: 0.99</code>

<code> }</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:

<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа
*'''threshold''' — порог совпадения спикера, от 0 до 1
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |Пример ответа:

<code>{ error: 0, speaker: Ivan, confidence: 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для поиска
*'''id''' — идентификатор говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет проверен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" | <code>{ "error": 0, "confidence": 0.78 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>[</code>
<code> {</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",</code>

<code> "name": "наименование слепка"</code>

<code> }</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для обучения

*'''id''' '''—''' идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "Success"</code>

<code>}</code>
|}
</onlyinclude>

SBS. Руководство пользователя

2026-01-12T10:54:16Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Biometry Server предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) — сервис извлечения метаданных.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SBS.

===== '''Описание методов API сервиса биометрии (SBS)''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SBS. По умолчанию используется порт 6185/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6185</nowiki> будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа.
| colspan="2" style="width: 50%" |Пример:
<code>{</code>

<code> age: {</code>
<code> class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}</code>
<code> confidence: 0.99</code>
<code> },</code>
<code> emotion: {</code>
<code> class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", </code>
<code> <<"NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}</code>
<code> confidence: 0.99</code>
<code> },</code>
<code> gender: {</code>
<code> class: FEMALE, # { "MALE", "FEMALE" }</code>
<code> confidence: 0.99</code>
<code> },</code>
<code> multispeaker : {</code>
<code> class: YES, # { "YES", "NO" }</code>
<code> confidence: 0.99</code>
<code> }</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:

<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа
*'''threshold''' — порог совпадения спикера, от 0 до 1
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |Пример ответа:

<code>{ error: 0, speaker: Ivan, confidence: 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для поиска
*'''id''' — идентификатор говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет проверен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" | <code>{ "error": 0, "confidence": 0.78 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>[</code>
<code> {</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",</code>

<code> "name": "наименование слепка"</code>

<code> }</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для обучения

*'''id''' '''—''' идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "Success"</code>

<code>}</code>
|}
</onlyinclude>

SBS. Руководство пользователя

2026-01-12T10:51:40Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Biometry Server предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) — сервис извлечения метаданных.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SBS.

===== '''Описание методов API сервиса биометрии (SBS)''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SBS. По умолчанию используется порт 6185/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6185</nowiki> будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа.
| colspan="2" style="width: 50%" |Пример:
<code>{

<<age: {
class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}
confidence: 0.99
},
emotion: {
class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR",

<<"NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}
confidence: 0.99
},
gender: {
class: FEMALE, # { "MALE", "FEMALE" }
confidence: 0.99
},

multispeaker : {

class: YES, # { "YES", "NO" }

confidence: 0.99

}

}</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:

<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа
*'''threshold''' — порог совпадения спикера, от 0 до 1
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |Пример ответа:

<code>{ error: 0, speaker: Ivan, confidence: 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для поиска
*'''id''' — идентификатор говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет проверен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" | <code>{ "error": 0, "confidence": 0.78 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>[</code>
<code> {</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",</code>

<code> "name": "наименование слепка"</code>

<code> }</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для обучения

*'''id''' '''—''' идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "Success"</code>

<code>}</code>
|}
</onlyinclude>

UPS. Описание API

2026-01-12T10:50:10Z

KorolkovS:

===== '''Описание часто используемых параметров''' =====
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
|-
|'''servicetype'''
|запрос
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts.
|-
|'''servertype'''
|запрос
|Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы).
|-
|'''model'''
|запрос
|Название модели.
|-
|'''modeltype'''
|запрос
|Тип модели. Возможные значения: '''future''' — планируемая/черновик, '''current''' — текущая/рабочая, '''previous''' — архивная.
|-
|'''error'''
|ответ
|Флаг ошибки.
|-
|'''message'''
|ответ
|Информационное сообщение.
|}

===== '''"/external modules" методы внешних модулей''' =====

В этом разделе будут методы соответствующим образом оформленных [[UPS. Руководство администратора#Установка модулей для UPS|внешних модулей]]

===== '''/auth: методы авторизации''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/auth/access'''
! colspan="3" style="width: 85%" |Получение токенов доступа. Токен доступа определяет, какие из методов будут доступны конкретному пользователю. Формируется на основании роли. Дополнительный входной параметр во всех методах, кроме перечисленных в разделе «nopassword» конфигурационного файла. Время действия токена определяется параметром auth.accessLifeTime конфигурационного файла.
|-
|colspan="2" style="width: 50%" |
* '''username''' — логин

* '''password''' — пароль
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/add'''
! colspan="3" style="width: 85%" |Добавление dataset (набора данных). Dataset (набор данных) используется для ограничения доступа к данным. В ответе метод вернет id созданного набора данных.
|-
|colspan="2" style="width: 50%" |
* data — json строка вида: { "name": "название нового набора" }
|colspan="2" style="width: 50%" |{

"error": 0

"message": "success",

"dataset_id": "XXXXXXXXXXXXX"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/dataset/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление dataset (набора данных).
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/modify/{id}'''
! colspan="3" style="width: 85%" |Переименование dataset (набора данных). Метод меняет все параметры набора данных, но на данный момент времени у набора данных, кроме id, только один параметр — наименование.
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
* '''data''' — JSON c новыми параметрами
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/datasets'''
! colspan="3" style="width: 85%" |Получение списка наборов данных.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXXXXXXXXXX",

"name": "XXX"},

{"id": "0",

"name": "По умолчанию"}

]
|-
!style="color:blue;width: 15%" |'''GET/auth/refresh'''
! colspan="3" style="width: 85%" |Обновление токенов доступа. Время, в течение которого можно обновить доступ, регулируется параметром auth.refreshLifeTime конфигурационного файла. Служебный метод, используется в основном в веб-интерфейсе, чтобы не запрашивать лишний раз пароль.
|-
|colspan="2" style="width: 50%" |
* '''x-refresh-token''' — токен обновления доступа
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/rights'''
! colspan="3" style="width: 85%" |Получение списка прав доступа. Служебный метод — по токену получает название роли и все права доступа этой роли, а также общедоступные методы.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |<<<{ "РОЛЬ": [

 "GET:/......" ],

 "nopassword": [ "GET:/.......",

...............

<<<...............

 "POST:/......." ] }
|-
!style="color:green;width: 15%" |'''POST/auth/role/add'''
! colspan="3" style="width: 85%" |Создание роли. Служебный метод — используется веб-интерфейсом при создании роли.
|-
|colspan="2" style="width: 50%" |
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{

"error": 0, "message": "success", "role_id": "a7e68bb83169f864c2fc868401b5250c"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/role/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление роли.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/role/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение роли. Параметры как при создании роли. Роль будет переписана.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/roles'''
! colspan="3" style="width: 85%" |Получение списка ролей.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[{

"id": "XXXXXXXXXXX",

"name": "имя роли",

"rights": [ "набор прав через запятую" ]

},............]
|-
!style="color:green;width: 15%" |'''POST/auth/user/add'''
! colspan="3" style="width: 85%" |Создание нового пользователя. Метод вернет или id нового пользователя или описание ошибки
|-
|colspan="2" style="width: 50%" |
* '''data''' — json строка {

"username": "login_name", "fullname": "Отображаемое Имя","password": "XXXXX","role": "role_id",

"dataset": "default dataset id", "datasets": [ "dataset id", ................. ] }
|colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"user_id": "XXXXXXXXXXXXXXXX"}
|-
!style="color:red;width: 15%" |'''DELETE/auth/user/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' - идентификатор пользователя
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/user/get/{id}'''
! colspan="3" style="width: 85%" |Получение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2" ] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/info'''
! colspan="3" style="width: 85%" |Получение параметров пользователя по его токену доступа. Служебный метод - для предоставления прав текущему пользователю по его токену
|-
|colspan="2" style="width: 50%" |
* '''x-access-token'''
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/list'''
! colspan="3" style="width: 85%" |Получение списка пользователей с их параметрами. Тоже самое что и в методе GET /auth/user/info, только для всех пользователей
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] },

......

]
|-
!style="color:green;width: 15%" |'''POST/auth/user/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''data''' — параметры пользователя как при создании
* '''id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{ "error": 0,

"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/user/password'''
! colspan="3" style="width: 85%" |Смена пароля пользователя по его токену доступа.
|-
|colspan="2" style="width: 50%" |
* '''password'''
|colspan="2" style="width: 50%" |{ "error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/userlog'''
! colspan="3" style="width: 85%" |Получение действий пользователя за период времени по его токену
|-
|colspan="2" style="width: 50%" |
* '''from''' — начало периода в формате "%Y-%m-%d %H:%M"

* '''to''' — конец периода в формате "%Y-%m-%d %H:%M"
|colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "data": [

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 .........

}
|-
!style="color:blue;width: 15%" |'''GET/auth/version'''
! colspan="3" style="width: 85%" |Получение версии сервиса ups
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |{

 "version": "4.082 release"

}
|}

===== '''/lang: методы мультиязычности''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/lang/'''
! colspan="3" style="width: 85%" |Выводит информацию о переводе элементов интерфейса на текущий язык
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "see":"Сущности",

"smc":"Классификатор",

... }
|-
!style="color:blue;width: 15%" |'''GET/lang/wallpaper'''
! colspan="3" style="width: 85%" |Отдает случайный фон рабочего стола в виде jpeg из каталога «wallpapers» на сервере ups
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |image/jpeg
|}

===== '''/server: получение информации о серверах''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |GET/server/get/addresses/{servicetype}
! colspan="3" style="width: 85%" |Вывод информации о серверах, обслуживающих данный сервис, а также настроенных параметров обращения к данным серверам.
'''trainer''' — сервер обучения, '''cluster''' — рабочие серверы, '''connect''' — время на подключение, '''read''' — время на ответ,

'''failed''' — время пребывания в сбойных, '''install''' — время на установку модели, '''info''' — время на получение информации о модели,

'''counter''' — счетчик запросов, '''current''' — индекс последнего опрошенного cluster-сервера

'''fail''' — массив сбойных серверов со временем постановки в сбой.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",

 "cluster": [ "<nowiki>http://127.0.0.1:6181</nowiki>" ],

 "timers": { "connect": 0.5,

 "read": 1,

 "failed": 600,

 "install": 60,

 "info": 3 },

 "counter": 0,

 "current": 0,

 "fail": {"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678} }
|-
!style="color:blue;width: 15%" |GET/server/get/models/{servicetype}/{servertype}
! colspan="3" style="width: 85%" |Вывод информации о моделях указанного сервиса на каждом сервере указанного типа. Вывод представляет собой массив URL-серверов, для каждого из которых указан список моделей.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса

* '''servertype''' — тип серверов
| colspan="2" style="width: 50%" |{ "<nowiki>http://127.0.0.1:6181</nowiki>": [

 "model1",

 ...

 "modelN"

 ], ... }
|}

===== '''/model: методы работы с моделями''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/model/add/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Создание пустой модели в указанном сервисе. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 30%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 70%" |{

"error":0,

"message":"success"

}
|-
!style="color:green;width: 15%" |'''POST/model/apply/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Применение установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:red;width: 15%" |'''DELETE/model/delete/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/errors/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Запрос на получение списка ошибок модели после тестирования/обучения. Доступен для сервисов see и smc. Ответ содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза).
|-
| colspan="2" style="width: 50%" |
* '''type''' — тип ошибок в выводе
'''- train''' ошибки обучения

'''- test''' ошибки тестирования

'''- mark''' ошибки авторазметки
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[ [true, predicted, phrase],

... ]
|-
!style="color:blue;width: 15%" |'''GET/model/export/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Экспорт модели, модель скачивается в виде zip-архива.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл model.zip, где model — название модели
|-
! style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Удаление постобработчика из модели типа future. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель типа future. Обработчик становится активным сразу после успешной отправки. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из модели типа future.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Удаление постобработчика в указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель указанного типа. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''modeltype''' — тип модели
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:green;width: 15%" |'''POST/model/import/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Импортирует модель в черновик (modeltype=future)
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''zip-model''' — zip с файлами модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}'''
! colspan="3" style="width: 85%" |Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "model1": {

 "previous": null,

 "current": null,

 "future": {

 "status": "empty",

 ...

 } }, ... }
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение информации о каждом типе (modeltype) указанной модели. Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{ "previous": null,

 "current": {

 "status": "trained",

 ... },

 "future": {

 "status": "trained",

 ... } }
|-
!style="color:green;width: 15%" |'''POST/model/install/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Установка импортированной или обученной модели на рабочих серверах.
Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/log/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: '''smc''', '''see'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[

 "training",

 "preparing data",

 "tokenizing",

 ...

]
|-
!style="color:green;width: 15%" |'''POST/model/restore/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так:
* '''current -> future'''
* '''previous -> current'''
* '''null -> previous'''
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|}

===== '''/corpus: работа с данными для обучения моделей''' =====
Методы данного класса предназначены только для сервисов smc и see

{| class="wikitable" style="width: 110%"
|+
!style="color: blue;width: 15%" |'''GET/corpus/automark/list'''
! colspan="3" style="width: 85%" |Перечень заданий автоматической маркировки корпусов.
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "tasks": [ {

 "id": "29d9da98-d6c1-4dc1-bbc9-111309816002",

 "taskname": "test_doc",

 "status": "finished" },

 { "id": "1a5e9bdc-9f98-49d2-84de-1a9bde8fc37c",

 "taskname": "sssss",

 "status": "finished" } ] }
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/result/{id}'''
! colspan="3" style="width: 85%" |Результат выполнения задания на автомаркировку корпуса. Если задание завершено в ответе придет маркированый корпус и время старта и финиша задания
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{
"error": 0,

"message": "success",

"started": "2024-10-09 18:05:51",

"finished": "2024-10-09 18:05:51",

"corpus": [[ [], [ ["тэг"],"фраза 1"]],

[ [], [["тэг"],"фраза 2"]] ]
}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''taskname''' — произвольное имя задания

* '''corpus''' — json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

* '''marks''' — json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

* '''appendMarks''' — "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "уникальный id задания"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — уникальный id задания
| colspan="2" style="width: 50%" |{

 "error": "",

 "status": "finished",

 "started": "2024-10-09 13:49:46",

 "finished": "2024-10-09 13:49:46",

 "progress": 0

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: green;width: 15%" |'''POST/corpus/copy/{servicetype}'''
! colspan="3" style="width: 85%" |Копирование корпуса данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: red;width: 15%" |'''DELETE/corpus/delete/{servicetype}'''
! colspan="3" style="width: 85%" |Удаляет корпус с данными
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: blue;width: 15%" |'''GET/corpus/export/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает текстовый файл с корпусом, содержащий строки вида КЛАСС<TAB>ФРАЗА
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |Файл name.txt
|-
!style="color: blue;width: 15%" |'''GET/corpus/get/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает JSON с данными корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |<code>[</code>
<code> [ "тэг",</code>

<code> "фраза"</code>

<code> ],</code>

<code> ...</code>

<code>]</code>
|-
!style="color: green;width: 15%" |'''POST/corpus/import/{servicetype}'''
! colspan="3" style="width: 85%" |Метод для импорта корпуса данных. Возможен как из текстового файла со строками вида КЛАСС<TAB>ФРАЗА (доступно для smc и see), так и из логов работы системы (только для smc). Если на вход поступил файл csv, происходит импорт из файла, в противном случае — из логов.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''csv''' — файл данных
* '''startDate''' — дата начала выборки, YYYY-MM-DD
* '''stopDate''' — дата окончания выборки, YYYY-MM-DD
* '''model''' — имя модели, из логов которой будет произведен импорт
* '''limit''' — числовое ограничение строк импорта
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/list/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает список всех корпусов данных для указанного типа сервиса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |[ "корпус1",

"корпус2",

 ...]
|-
!style="color: green;width: 15%" |'''POST/corpus/put/{servicetype}'''
! colspan="3" style="width: 85%" |Перезаписывает корпус отправленным массивом данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''json''' — строка формата json с данными. Аналогична выводу метода GET /get/{servicetype}
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: green;width: 15%" |'''POST/corpus/rename/{servicetype}'''
! colspan="3" style="width: 85%" |Переименование корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|}

===== '''/marks: работа с наборами меток в smc''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/marks/add'''
! colspan="3" style="width: 85%" |Добавление набора менток
|-
| colspan="2" style="width: 50%" |
* '''json''' —список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''name''' — имя создаваемого набора
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "132310fa-98c7-4b12-896f-ff113827d077"

}
|-
!style="color:red;width: 15%" |'''DELETE/marks/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление набора меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }

|-
!style="color:blue;width: 15%" |'''GET/marks/export/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде строк
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

метка1 синоним1,синоним2,синоним3,синонимN 0.9

меткаN синоним11,синоним21,синоним31,синонимN1 0.9
|-
!style="color:blue;width: 15%" |'''GET/marks/get/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде json
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "data": [

 ["метка1", [ "синоним1", "синоним2", "синоним3", "синонимN" ],

 0.9

 ],

 ["меткаN", ["синоним11","синоним21", "синоним31","синонимN1"],

 0.9

 ] ] }
|-
!style="color:green;width: 15%" |'''POST/marks/import/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из файла. Набор будет переписан из файла
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл "метка"ТАБ"синонимы через запятую"ТАБ"достоверность(число от 0 до 1)"

* '''id''' — идентификатор набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/marks/list'''
! colspan="3" style="width: 85%" |Получение списка наборов меток
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "result": [ { "id": "416fbe08-19e9-453c-b140-37008a08a76c","name": "test" },

 {"id": "16e77fa2-7c4d-47f9-8644-6385876525d6","name": "Рыжик" },

 {"id": "132310fa-98c7-4b12-896f-ff113827d077", "name": "test" }

 ]}
|-
!style="color:green;width: 15%" |'''POST/marks/put/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из json строки. Набор будет переписан
|-
| colspan="2" style="width: 50%" |
* '''json''' — список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''id''' — идентификатор заменяемого набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:green;width: 15%" |'''POST/marks/rename/{id}'''
! colspan="3" style="width: 85%" |Присваивает новое наименование существующему набору меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
* '''name''' — новое имя набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|}

===== '''/spr: работа с сервисом SPR''' =====

{{:SPR. Руководство пользователя}}

===== '''/smc: работа с сервисом SMC''' =====

{{:SMC. Руководство пользователя}}

===== '''/see: работа с сервисом SEE''' =====

{{:SEE. Руководство пользователя}}

===== '''/sbs: работа с сервисом SBS''' =====

{{:SBS. Руководство пользователя}}

====='''/tts: методы работы с сервисом tts'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |Простой текст — строки со словом и его интерпретацией с ударением.
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ [ "слово", "замена слова с удар+ением"],

[ "слово2", "замена слова2 с удар+ением"],

...]
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
*'''csv file''' — файл строк со словом и его интерпретацией с ударением.
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "сообщение о статусе результата"}
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка json следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "сообщение о статусе результата"

}
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="3" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
*'''text''' — фраза для нормализации
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "text": "нормализованный текст" }
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="3" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
*'''wav''' — аудиофайл для обработки

*'''revoicer''' — модель модификации голоса
| colspan="2" style="width: 50%" |wav-файл с модифицированным (искаженным) голосом
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ "distortion" ]
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{model}'''
! colspan="3" style="width: 85%" |Синтез звукового файла из текста/
|-
| colspan="2" style="width: 50%" |
*'''ID''' — имя модели
*'''text''' — текст синтезируемой фразы
*'''rate''' — скорость речи
*'''pitch''' — высота (тон)
*'''volume''' — громкость
*'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
*'''format''' - формат файла результата (wav, opus, ogg, mp3)
*'''link''' - если 1, то вернуть только ссылку на файл
| colspan="2" style="width: 50%" |файл с синтезированой фразой
|}

====='''/qas: методы работы с сервисом qas'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/qas/ask'''
! colspan="2" style="width: 85%" |Метод генерирует ответ на поставленный вопрос на основе информации из документов в базе. Ответ на вопрос генерируется на основе информации, содержащейся в одном или нескольких документах. Документы должны быть в текстовом формате. Ответ возвращается в формате JSON, его можно скачать. Если метод не смог найти ответ, возвращается код ошибки и сообщение.
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст вопроса, на основе которого будут искаться фрагменты.
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''maxDocs''' — максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{

"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы*'''mode''' - режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' - генерирует кэш через разные ответы на каждый вопрос по документации
*'''mode''' — режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' — генерирует кэш через разные ответы на каждый вопрос по документации

*'''option''' - {all | empty} обработать все вопросы или только не содержащие ответов
*'''category''' - если указан код категории, то генерация только для этой категории

*'''variants''' - количество ответов, от 1 до 9
*'''replace''' - заменить ответы на сгенерированные
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/status'''
! colspan="2" style="width: 85%" |Состояние генерации ответов на вопросы в кэше. Статусы: '''started''', '''stopped''', если были ошибки, поле ответа '''error''' будет содержать код ошибки.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "started",

 "progress": 33.33}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/stop'''
! colspan="2" style="width: 85%" |Остановить генерацию ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/category/add'''
! colspan="2" style="width: 85%" |Добавить категорию с указанным именем. В ответе — id созданной категории или сообщение об ошибке:
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "id": "ad895085-2e48-439a-831e-b5f699b6a54a" }
|-
! style="color:red;width: 15%" |'''DELETE/qas/category/delete/{id}'''
! colspan="2" style="width: 85%" |Удалить категорию. В ответе или сообщении об успехе, или ошибке, если категория используется или не существует.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/category/list'''
! colspan="2" style="width: 85%" |Получить список категорий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |В ответе json с именами и id категорий
|-
! style="color:green;width: 15%" |'''POST/qas/category/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить категорию. У категории пока есть только наименование, поэтому метод только переименовывает категорию
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/add'''
! colspan="2" style="width: 85%" |Добавление канала. В ответе id созданного канала или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование канала
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "a46fb887-5d98-41e0-8299-bcc94f615e91"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/channel/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление канала
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/channel/list'''
! colspan="2" style="width: 85%" |Получить список всех каналов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": 0,

 "channels": [

 { "id": "1", "name": "voice" },

 { "id": "56442779-e871-43fd-ae4d-caf4ab6d09b9", "name": "канал++" },

 { "id": "0", "name": "default" }

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить канал. У канала пока есть только наименование, поэтому метод только переименовывает канал
|-
| colspan="2" style="width: 50%" |
*'''name''' — новое наименование канала

*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Пример ответа на вопрос "как пройти в библиотеку"{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc/start'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
* '''text -''' текст документа
* '''model''' - какую модель использовать для ответа, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM, необязательный параметр
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/stop'''
! colspan="2" |Остановка очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/status'''
! colspan="2" |Статус очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{
"error": 0,

"status": stopped | started,

"progress": 33.3,

"message": string,

"place": number, #место в очереди

"queue": True | False #состояния - в очереди или в процессе очистки

}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/result'''
! colspan="2" |Результат очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0,"status": "stopped","text": "очищенный текст","doc_id": "ID документа"}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/add'''
! colspan="2" style="width: 85%" |Загрузить текстовый документ. Добавляет документ в базу. В ответе — id созданного документа или сообщение об ошибке.
|-
| colspan="2" style="width: 50%" |
*'''title''' — заголовок документа
*'''category''' — категория документа
*'''text''' — файл документа
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "ebe2bc57551c2d17f892987d1f62306d"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/doc/delete/{id}'''
! colspan="2" style="width: 85%" | Удаление документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка текста документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{

 "error": 0,

 "text": "Здесь будет полный текст документа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/list'''
! colspan="2" style="width: 85%" |Получение списка имеющихся документов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |Пример:

{ "error": 0,

 "docs": [

 {id": "d4999cdee5ad1faf2cb3066ea1b5e96b",

 "title": "PVE. Установка сервисного пакета окружения",

 "category": "Техническая поддержка" },

 {"id": "759042575b965745b9d2af869bca1740",

 "title": "UPS. Руководство администратора",

 "category": "Техническая поддержка"} ]}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modify/{id}'''
! colspan="2" style="width: 85%" |Обновление документа. В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c изменяемыми параметрами документа

<code>{</code>

<code> title: string,</code>

<code> category: string,</code>

<code> text: string</code>

<code>}</code>

параметр который не меняется может отсутствовать в json

*'''id''' — идентификатор документа.
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/replace'''
! colspan="2" style="width: 85%" |Замена подстроки в текстах категории Будут заменены все найденные вхождения
|-
| colspan="2" style="width: 50%" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
| style="width: 50%" |{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modifyphrases'''
! colspan="2" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/gpt/list'''
! colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success", "models": ["default" ]}
|-
! style="color:green;width: 15%" |'''POST/qas/question/add'''
! colspan="2" style="width: 85%" |Добавление вопроса. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса

*'''category''' — id категории к которой относится вопрос

*'''answers''' — ответы в виде Json:

<code>[ { "checked": true, "channel": "0", "answer": "ответ" } ]</code>

*'''aliases''' — вопросы к которым подходят ответы из блока answers в виде json:

<code>["вопрос","еще вопрос"]</code>
| style="width: 50%" |{

 "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:green;width: 15%" |'''POST/qas/question/append/{id}'''
! colspan="2" style="width: 85%" |Добавляет алиасы/кандидаты к другому вопросу
|-
| colspan="2" style="width: 50%" |
*'''aliases''' — JSON list с синонимами

*'''candidates''' JSON list с кандидатами

*'''id''' — идентификатор вопроса к которому добавить синонимы и(или) кандидаты
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/approve/{destination_id}'''
! colspan="2" style="width: 85%" |Перемещает кандидаты в формулировки другого вопроса
|-
| colspan="2" style="width: 50%" |
*'''candidates''' — json массив c текстами кандидатов

*'''destination_id''' — идентификатор вопроса
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/delete/list'''
! colspan="2" style="width: 85%" |Удаление списка вопросов или ответов
|-
| colspan="2" style="width: 50%" |
*'''questions''' — json строка с перечнем id

*'''type''' — выбор, удалять вопросы или ответы ('''questions''', '''answers''')
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:red;width: 15%" |'''DELETE/qas/question/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/question/get/{id}'''
! colspan="2" style="width: 85%" | Получение вопроса вместе с ответами и синонимами вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{ "error": 0,

 "answers": [

 { "checked": true,

 "channel": "0",

 "answer": "ответ" } ],

 "aliases": [

 "вопрос",

 "синоним вопроса",

 "еще синоним вопроса" ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/question/list'''
! colspan="2" style="width: 85%" | Получение списка вопросов.
|-
| colspan="2" style="width: 50%" |
*'''question''' — фильтр вопросов, ограничение списка по вопросам
*'''category''' — фильтр категорий

*'''answer''' — фильтр ответов, ограничение списка по ответам
*'''created''' — фильтр по дате создания, оставляет вопросы, созданные '''не ранее''' указанной даты
*'''createdBefore''' — фильтр по дате создания, оставляет вопросы, созданные '''не позже''' указанной даты
*'''modified''' — фильтр по дате изменения, оставляет вопросы, '''изменённые в точности''' в указанную дату
*'''onlyNew''' - фильтр, оставляющий только новые (необработанные) вопросы
| style="width: 50%" |{ "error": 0,

 "questions": [

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0},

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0}

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/question/modify/{id}'''
! colspan="2" style="width: 85%" |Модификация вопроса. Позволяет заменить как все параметры так и отдельные
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c измененными параметрами, пример полного:

<code>{ "answers": [</code>

<code> {</code>

<code> "checked": true,</code>

<code> "channel": "0",</code>

<code> "answer": "новый ответ"</code>

<code> }</code>

<code> ],</code>

<code>"question":"новый вопрос",</code>

<code>"category": "a3801cc0-f8e5-4f3b-bb10-e42148cd772b",</code>

<code> "aliases": [</code>

<code> "новый вопрос",</code>

<code> "синоним",</code>

<code> "еще синоним"</code>

<code> ]</code>

<code>}</code>

*'''id''' — идентификатор вопроса
| style="width: 50%" |В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.

{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/question/replace'''
! colspan="2" |Поиск и замена подстроки. Будут заменены все найденные вхождения
|-
| colspan="2" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
|{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/question/modifyanswers'''
! colspan="2" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/paraphrase'''
! colspan="2" |Генерация фраз-синонимов для предложения.
|-
| colspan="2" |
*'''text -''' предложение
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "texts": [ "перефразированный текст 1", ... ]}
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/answers'''
! colspan="2" style="width: 85%" |Отображает лог массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |на выходе :
массив из объектов {

 error: number;

 question: string;

 answer: string;

 confidence: number | null;

}
|-
! style="color:green;width: 15%" |'''POST/qas/questionlist/start'''
! colspan="2" style="width: 85%" | Старт массовой обработки вопросов из файла
|-
| colspan="2" style="width: 50%" |
*'''questions''' - файл с вопросами
*'''format''' - в json или в text файл с вопросами
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

— "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''threshold''' - порог достоверности при обработке
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/status'''
! colspan="2" style="width: 85%" |Статус массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;

 status: 'started' | 'stopped';

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/stop'''
! colspan="2" style="width: 85%" |Остановка массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM для анализа на несоответствия, необязательный параметр
*'''asktemplate''' - ID шаблона запроса к LLM для генерации ответов по документу, необязательный параметр
*'''answers''' - тип вопросов, по которым осуществляется поиск несоответствий, необязательный параметр, по умолчанию «all»
|<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/status'''
! colspan="2" style="width: 85%" |Статус поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;<nowiki> status: 'started' | 'stopped';</nowiki>

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/stop'''
! colspan="2" style="width: 85%" |Остановка поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/mismatches'''
| colspan="2" |Статус получения результатов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": 0,"message": "success","mismatches": [{"question_id": "ID вопроса", "question": "вопрос", "category": "ID категории", "answer_id": "ID ответа", "answer": "ответ на вопрос {question}", "description": "результат поиска", "error" : string, "context": "фрагмент документа", "generatedText" : "Результат генерации" }, ... ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/start'''
| colspan="2" |Запуск генерации вопросов
|-
| colspan="2" |
*'''category''' - ID категории, по которой будет происходить генерация вопросов
*'''doc''' - ID документа, по которому будет происходить генерация вопросов
*'''generateAnswers''' - флаг для генерации ответов вместе с вопросами '''[yse|no]''', по умолчанию '''«no»'''
*'''model''' - имя модели GPT, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM для анализа генерации вопросов, необязательный параметр
|{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
| colspan="2" |Статус генерации вопросов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": string, <nowiki>"status": 'started' | 'stopped',</nowiki> "progress": 33.3 }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/stop'''
! colspan="2" style="width: 85%" |Прервать генерацию.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
* '''maxDocs''' - максимальное количество документов одной категории для формирования контекста при поиске ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{ "error": 0,

 "text": "

 Фрагмент 1:Здесь будет текст найденного фрагмента

 Фрагмент 2:Здесь будет текст найденного фрагмента",

 "fragments": [

 { "id": "3a386b0a9e0e19efb0870685e1d0b484",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" },

 { "id": "44fd73ea1ac63f32cf18d79c854dbfe2",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" } ] }
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/add'''
! colspan="2" style="width: 85%" |Добавление шаблона протокола. В случае успеха метод вернет id шаблона, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''name''' — название шаблона

* '''options''' — json словарь с именами разделов и их описанием
| style="width: 50%" |{ "error": 0, "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"}
|-
! style="color:red;width: 15%" |'''DELETEqas/summarization_template/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление шаблона.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/get/{id}'''
! colspan="2" style="width: 85%" |Получение json с шаблоном.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |На выходе словарь, основные элементы: data — словарь с шаблоном, остальные элементы этого уровня служебные. В data: id, name (идентификатор и наименование).И options — словарь с разделами шаблона.
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/list'''
! colspan="2" style="width: 85%" |Получение всех шаблонов.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |На выходе словарь, основной элемент — templates, содержит список шаблонов (каждый шаблон как в выдаче метода GET /qas/summarization_template/get/{id}).
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение шаблона.
|-
| colspan="2" style="width: 50%" |
*'''data''' — словарь как в выдаче метода GET/qas/summarization_template/get/{id}

*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/summarize'''
! colspan="2" style="width: 85%" |Построение протокола или краткого содержания совещания
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст совещания

*'''options''' — словарь с разделами протокола, где ключ — название раздела, значение - краткая инструкция к формированию раздела.
*'''model''' - какую GPT модель использовать для построения протокола, если кроме default используются другие модели

*'''file''' — файл с текстом (текст, csv, pdf или текстовые офисные документы)
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{ "error": 0,
 "message": "success",

 "summary": "здесь текст протокола"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replace'''
! colspan="2" |корректировка информации в тексте при помощи LLM
|-
| colspan="2" |
*'''text''' - текст
*'''oldinfo''' — старая информация
*'''newinfo''' — новая информация
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{ "error": 0, "message": "success",

 "text": "итоговый текст"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replacementlist'''
! colspan="2" |список всех фраз в документах и ответов в вопросах, подлежащих правке. Векторно ищет все фрагменты по указанному тексту.
|-
| colspan="2" |
*'''text''' - текст
*'''category''' — категория, в которой производится векторный поиск
*'''threshold''' — порог похожести, необязательный параметр, если не указан, берется из конфигурационного файла (fragments -> threshold)
*'''answers''' - тип вопросов, по которым осуществляется поиск для внесения правок, необязательный параметр, по умолчанию «all»
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/add'''
! colspan="2" |Добавление шаблона запроса к LLM. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" |
*'''type''' — тип шаблона - chat - произвольный чат, - ask - запрос к документам, - cleandoc - очистка документа, форматирование либо другое преобразование, - similars_generator - генерация синонимичных которотких фраз, - paraphrase - перефразировка текста, - summarize - суммаризация текста (формирование краткой выдержки из текста), - question_generator - генерация вопросов по тексту, - replace - замена информации в тексте, mismatch - поиск несоответствий

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
*'''params''' - параметры запроса к LLM"max_tokens": 4096, "top_k": 30, "top_p": 0.5, "temperature": 0.5, "repeat_penalty": 1.3
|{ "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:red;width: 15%" |'''DELETE/qas/prompt/delete/{id}'''
! colspan="2" |Удаление шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/get/{id}'''
! colspan="2" |Получение шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{ "error": 0, "prompt": {

 "id": "cleandoc",

 "type": "cleandoc",

 "isDefault": false,

 "name": "Чистка документа",

 "prompt": "Удали сноски, колонтитуры и мусорную информацию из текста ниже. Не удаляй ничего лишнего. Не добавляй ничего, только информация из текста. Выведи только конечный результат без отчета о результате.\n###Текст:\n{context}\n\n###Конечный результат:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/list'''
! colspan="2" |Получение списка шаблонов.
|-
| colspan="2" |
|{ "error": 0, "prompts": [

 {

 "id": "chat",

 "type": "chat",

 "isDefault": false,

 "name": "Чат",

 "prompt": "Ты спокойный вежливый консультант.[\n\n###История переписки:\n{history}]\n\n###Вопрос: {question}\n###Ответ:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

 ]

}
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/modify/{id}'''
! colspan="2" |Модификация шаблона. Позволяет заменить как все параметры, так и отдельные.
|-
| colspan="2" |
*'''data''' — json c измененными параметрами:
<code>{ "name": "новое имя" }</code>
*'''id''' — идентификатор вопроса
|В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.{"error": INT, "message": DESCRIPTION}
|}

====='''/ses: методы работы с роботом'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться к продовой версии - нужен постфикс "_prod", для бэкапа "_backup"
актуально для методов

- получения данных робота GET/ses/robot/get/{id}

- применение настроек робота GET/ses/robot/commit/{id}

- экспорт робота GET/ses/robot/export/{id}

- список скриптов GET/ses/robot/script/list/{robot}

- получение скрипта GET/ses/robot/script/get/{robot}/{id}

- список ЭД GET/ses/robot/data/list/{robot}

- получение ЭД GET/ses/robot/data/get/{robot}/{id}

- список КТ GET/ses/robot/endpoint/list/{robot}

- получение КТ GET/ses/robot/endpoint/get/{robot}/{id}

- метода ask (отладчика) POST/ses/ask/{robot_id}

- данные сессии (отладчика) GET/ses/session/{robot_id}/{session_id}
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/audio/{uuid}'''
! colspan="2" style="width: 85%" |Получение аудио-файла из архива диалогов
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |аудио-файл с расширением opus
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/dialog/{uuid}'''
! colspan="2" style="width: 85%" |Получение диалога из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |{ "error": 0, "message": "success",

 "dialog": [{"id": "...", "robot": "...", "channel": "...",

 "unknown": true/false, "closed": true/false, "endpoint": "...",

 "answered": true/false, "models": [...], "variables": {}, "current": {

 "id": "...", "qas": "", "category": "...", "entry": [...],

 "nearest": "...", "missingRunData": [...], "waitingRunData": "...",

 "answered": true/false, "lastreply": "..."},

 "request": {"datetime": "...", "message": "", "data": [...]},

 "reply": {"answers": [{"messages": [...], "voice": "...",

 "interruptible": true/false, "file": null}],

<nowiki> "datetime": "...", "answered": true/false}}]}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/list'''
! colspan="2" style="width: 85%" |Получение списка диалогов из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
*'''startdate''' - начало временного интервала в формате date %Y-%m-%d %H:%M
*'''enddate''' - конец временного интервала в формате date %Y-%m-%d %H:%M
*'''phone''' - номер телефона
*'''variable''' - переменная в формате variable=value
*'''robot''' - идентификатор робота (id)
*'''text''' - фрагмент текста в любом сообщении
*'''data''' - id элемента данных
*'''channel''' - название канала (коннектора)
| style="width: 50%" |[{"uuid": "...", "datetime": "...","phone": "", "channel": [...], "robot": ["..."]}]
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/waveform/{uuid}'''
! colspan="2" style="width: 85%" |Служебный метод для визуализации полученного из архива диалогов аудио-файла, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |[0.016,

0.015,

0.01]
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст запроса

*'''channel''' - id канала

*'''connector''' - имя коннектора

*'''session''' - uuid сессии, если это не первый запрос в сессии

*'''tts''' - вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' - словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''handler''' - python скрипт для изменения ответов метода под требования внешних систем, подробнее в следующем разделе. в поле имя файла без расширения.

*'''restartClosed''' - перезагрузить сессию при её закрытии с новым id (1 - перезагрузить, 0 - не перезагружать)

*'''audio''' - аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''document''' - документ для последующей обработки

*'''robot_id''' - id робота

*'''endpoint''' - id точки, в которую передать управление диалогом (необязательный параметр, используется для исходящих оповещений)
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="2" style="width: 85%" |Создание нового робота. На выходе id созданного робота или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя нового робота
| style="width: 50%" |{ "error": 0, "id": "2fd2f909-2069-4b20-a725-3a598c83f886"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/apply/{id}'''
! colspan="2" style="width: 85%" | Применение робота. Переводит черновик робота в статус prod. Если до этого был prod вариант — становится backup.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/cleardraft/{id}'''
! colspan="2" style="width: 85%" |Обнуление черновика рабочей версией робота

|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": { "id": "id ЭД", "name": "Имя ЭД", "comment": "",

 "type": "...", "rtype": "report", "model": "Имя модели",

 "param": "Ответ", "script": "", "weight": 3,

 "slaveData": [], "getOnlyAsNearest": true/false,

 "injectToMessage": true/false, "longWaiting": true/false,

 "dataWaiting": [], "actions": { "alone": {

<nowiki> "default": [{"action": "say", "type": "random", "text": ["....."]}]}},</nowiki>

<nowiki> "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[ { "id": "3ebfe38b-95bf-4927-a662-17f6e5da22ea",
 "name": "pve", "type": "smc", "rtype": "report",

 "weight": 3, "hasNearestAction": false } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение элемента данных. Формат '''data''' как на выходе метода '''GET/ses/robot/data/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
*'''id''' — идентификатор элемента данных
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление всех версий робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/add/{robot}'''
! colspan="2" style="width: 85%" | Создание конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами конечной точки

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "id": "8576593b-b0d8-4b03-a623-74f3132356ea"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/endpoint/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление конечной точки.
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек конечной точки
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "data": { "id": "...", "name": "...", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка конечных точек робота
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[{ "error": 0, "data": { "id": "...", "name": "точка 1", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "....", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор элемента данных
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="2" style="width: 85%" |Выгрузка робота в архив
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |zip файл с именем = идентификатор робота
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/files/download/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''id''' - идентификатор файла
| style="width: 50%" |файл
|-
! style="color:green;width: 15%" |'''POST/ses/robot/files/upload/{robot}'''
! colspan="2" style="width: 85%" |Отправка файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''file''' - файл
| style="width: 50%" |{"error": 0, "message": "success", "id": "Id файла"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="2" style="width: 85%" | Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": {

 "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78",

 "name": "test", "description": "", "voice": "",

 "session": { "lifetime": 600 },

 "models": {}, "servicedata": {},

 "exceptions": {}, "actions": {},

 "holidays": [], "timeintervals": {

 "name": { "weekdays": [ 1, 2, 3, 4, 5, 6, 7 ],

 "dates": [ 0, 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],

"months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],

<nowiki>"days": "all", "intervals": [ [ 0, 1440 ] ] }}}}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="2" style="width: 85%" |Загрузка архива робота в черновик существующего робота
|-
| colspan="2" style="width: 50%" |
*'''zip —''' файл с архивом робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="2" style="width: 85%" |Получение списка роботов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ { "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78", "name": "test",

 "hasProd": true,

 "hasBackup": true } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение основных настроек робота. Формат '''data''' как в ответе метода '''GET/ses/robot/get/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с новыми настройками робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление нового скрипта. Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/script/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление скрипта
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение текста скрипита
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "data": {

 "id": "6a9f91b6-9634-4079-ac2b-60a944922c61",

"type": "Тип скрипта",

 "name": "Наименование скрипта",

 "code": "Текст скрипта" }

}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка скриптов
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |[ { "id": "9b9d83b7-d5c3-49e6-9bd4-a123a9047939", "name": "наименование1",

 "type": "Тип скрипта"},

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2",

 "type": "Тип скрипта"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение скрипта.Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/test/{robot}/{id}'''
! colspan="2" style="width: 85%" |Тестирование скрипта. Формат '''data''' как в ответе метода '''GET/ses/session/{robot_id}/{session_id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка с параметрами сессии
*'''id''' - идентификатор скрипта
*'''robot''' - идентификатор робота
| style="width: 50%" |<nowiki>{"error": 0, "message": "success", "result": {.....}, "variables": {}}</nowiki>
|-
! style="color:blue;width: 15%" |'''POST/ses/robot/userdata/data/add/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление записи в пользовательский справочник.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "id": "id записи"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/data/delete/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Удаление записи из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/data/list/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Получение данных из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |[{ "колонка 1": "значение 1", "колонка n": "значение n", "id": "id записи"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}'''
! colspan="2" style="width: 85%" | Массовое изменение данных в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Изменение одной записи пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/put/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление данных с заменой в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code> Поле "id" опционально, при его добавлении данные в строке будут заменены.
*'''replace''' - замена всех данных в справочнике новыми данными. Возможные значения: yes/no. По-умолчанию - yes.
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"id": "id справочника", "name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code> Поле "id" опционально.
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |{"error": 0, "id": "id справочника"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/structure/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/structure/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка пользовательских справочников.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |<nowiki>[{"id": "id справочника", "name": "справочник", "fields": {"колонка1": "значение по умолчанию"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Модификация структуры пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code>
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="2" style="width: 85%" |Выдает параметры сессии. Для отображения на боковой панели тестирования в UPS. Основные блоки результата:
|-
| colspan="2" style="width: 50%" |
*'''robot_id''' — id робота

*'''session_id''' — id незакрытой сессии
| style="width: 50%" |{ "started": "", "modified": "",

 "robot": "",

 "session": "",

 "channel": "",

 "connector": "",

 "unknown": true/false,

 "current": {"id": "", "qas": "", "answered": true/false, "category": "",

 "nearest": "", "entry": [.....], "missingRunData": [],

 "passedRunData": [.....], "waitingRunData": null,

 "border": int, "preborder": int, "lastreply": ""},

 "models": [.....],

 "scripts": [.....],

<nowiki> "data": [{"request": {.....}, "reply": {.....}}],</nowiki>

 "timers": [],

 "variables": {},

 "error": "",

 "events": {.....},

 "closed": "" }
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/config'''
! colspan="3" style="width: 85%" |Выдает параметры виджета для web канала по запросу js скрипта
|-
| colspan="2" style="width: 50%" |
*'''token''' — уникальный код виджета, создается при внедрении
| colspan="2" style="width: 50%" |Состав конфига канала, для передачи виджету. Подробней в [https://wiki.connect2ai.net/index.php/SES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B0_%D0%B4%D0%BB%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%B0 Руководстве администратора]
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/js'''
! colspan="3" style="width: 85%" |Выдает код js скрипта виджета для web-канала
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |Код скрипта
|}

====='''/res: методы работы с сервисом отчетов'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/res/dashboards'''
! colspan="3" style="width: 85%" |Получить список рабочих столов kibana с наборами отчетов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |{ "error": 0, "message": "success",

 "dashboards": {

"Наименование1": "https://........",

<nowiki>"Наименование2": "https://........." }}</nowiki>
|}

====='''/transcription: методы работы со стенографией'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/transcription/audio/{id}'''
! colspan="3" style="width: 85%" | Получить аудиофайл по id стенограммы. Идентификатор нужной стенограммы можно получить методом
"GET /transcription/list"
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |wav файл сохраненной стенограммы
|-
! style="color:green;width: 15%" |'''POST/transcription/create'''
! colspan="3" style="width: 85%" |Создание стенограммы из завершенного задания в очереди распознавания. В ответ придет id созданной стенограммы
|-
| colspan="2" style="width: 50%" |
*'''taskID''' — идентификатор задания из очереди

*'''name''' — имя создаваемой стенограммы
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"id": "74721a3b-9055-4650-9afb-de4d103cafc7"}
|-
! style="color:red;width: 15%" |'''DELETE/transcription/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление стенограммы
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/get/{id}'''
! colspan="3" style="width: 85%" |Получение стенограммы. Используется для отображения стенограммы в веб интерфейсе
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |стенограмма в json формате
|-
! style="color:blue;width: 15%" |'''GET/transcription/list'''
! colspan="3" style="width: 85%" |Получение списка сохраненных стенограмм
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ { "id": "926e8d25-4275-4a78-906b-a1109cdacbea",

"name": "название",

"model": "big",

"created": "2024-03-29 12:37:42",

"modified": "2024-04-24 16:09:09",

"user": "0",

"dataset": "0" }, .... ]
|-
! style="color:green;width: 15%" |'''POST/transcription/save/{id}'''
! colspan="3" style="width: 85%" |Сохранение стенограмы. Используется для сохранения изменений по нажатию кнопки «Сохранить».
|-
| colspan="2" style="width: 50%" |
*'''data''' — стенограмма в json формате

*'''id''' стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/waveform/{id}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, ответ содержит пики сигнала
|-
| colspan="2" style="width: 50%" |
*'''id''' стенограммы
| colspan="2" style="width: 50%" |{ "error": 0,

"waveform": [

 0.016,

 ..........

 ..........

 0.015,

 0.01 ] }
|}

SBS. Руководство пользователя

2026-01-12T10:49:01Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Biometry Server предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) — сервис извлечения метаданных.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SBS.

===== '''Описание методов API сервиса биометрии (SBS)''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SBS. По умолчанию используется порт 6185/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6185</nowiki> будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа.
| colspan="2" style="width: 50%" |Пример:
<code>{</code>

<<age: {
class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}
confidence: 0.99
},
emotion: {
class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR",

<<"NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}
confidence: 0.99
},
gender: {
class: FEMALE, # { "MALE", "FEMALE" }
confidence: 0.99
},

multispeaker : {

class: YES, # { "YES", "NO" }

confidence: 0.99

}

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:

<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 50%" |
* '''wav''' — файл для анализа
*'''threshold''' — порог совпадения спикера, от 0 до 1
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |Пример ответа:

<code>{ error: 0, speaker: Ivan, confidence: 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для поиска
*'''id''' — идентификатор говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет проверен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" | <code>{ "error": 0, "confidence": 0.78 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>[</code>
<code> {</code>

<code> "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",</code>

<code> "name": "наименование слепка"</code>

<code> }</code>

<code>]</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 50%" |
*'''wav''' — файл для обучения

*'''id''' '''—''' идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "Success"</code>

<code>}</code>
|}
</onlyinclude>

SBS. Руководство администратора

2026-01-12T10:47:06Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для получения метаданных из естественной человеческой речи. Входным значением для сервиса являются wav-файлы. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) – сервис получения метаданных.

===== '''Системные требования''' =====
Для нормальной работы сервиса необходимо CPU >= 2.20 GHz с поддержкой инструкций AVX2 или новее. Оперативной памяти необходимо не менее 4 Gb. Для работы на нагруженных сервисах рекомендуется использовать GPU NVIDIA с поддержкой CUDA и наличием CUDA ядер.

Быстродействие на '''CPU''': например, поиск спикера, 8 потоков Xeon(R) Gold 6148 CPU @ 2.40 GHz, 8 Гб ОЗУ, запрос поиска в базе спикера по аудио 10 сек, 100 запросов со сдвигом 0.01 с (100 запросов выполнено за 1 с), максимальное время ожидания 14 с. Одиночный запрос ~1 с.

Тот же запрос с '''GPU''' А16 (с одним из 4-х ядер), максимальное время ожидания '''1.6 с'''.

===== '''Установка/обновление SBS''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/sbs&fileid=601 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для Вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SBS осуществляется скриптом <code>chmod +x ./sbs-<версия>-<релиз>.sh && ./sbs-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./sbs-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/sbs</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SBS <code>/opt/sbs/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/sbs/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/sbs/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/sbs/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/sbs/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/sbs/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable sbs.service && sudo systemctl start sbs.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status sbs.service</code>

Разрешите доступ к порту 6185 на нужном интерфейсе по протоколу tcp.

===== '''Конфигурирование параметров сервиса SBS'''=====
Настройка параметров сервиса spr производится в файле /opt/sbs/config.json

Описание параметров приведено в таблице. '''Применение любого из параметров требует перезапуска сервиса sbs.'''
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|saveAudio
|true
|Ключ хранения аудио отрезков в базе.
'''Внимание!''' При смене модели векторизации sbs сбросит все вектора и попытается сформировать новые из сохраненного аудио. Если аудио не будет ( saveAudio="false"), все слепки будут фактически уничтожены.
|-
|modifyType
|audio
|Способ дообучения слепка
audio — если указан этот тип, то обновление слепка дозагрузкой аудио делается через объединение старого и загружаемого аудио. Если старого аудио нет, то вектор делается только по новому аудио. В базу сохраняется только новое аудио (если стоит флаг сохранения в базу).

average — в базу сохраняется только новое аудио (если стоит флаг). А новый вектор создается из усреднения старого вектора и вектора из нового аудио.
|-
|db_handler
|""
|[https://wiki.connect2ai.net/index.php/SBS._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%92%D0%BD%D0%B5%D1%88%D0%BD%D0%B8%D0%B9_%D0%B4%D1%80%D0%B0%D0%B9%D0%B2%D0%B5%D1%80_%D1%88%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F Внешний драйвер шифрования]
|-
|logs.path
|logs/
|Путь к папке логов
|-
|logs.backups
|10
|Максимальное количество лог файлов
|-
|logs.maxSize
|5242880
|Максимальный размер одного лог файла
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[ ]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|-
|spr.url
|http://127.0.0.1:6183
|Путь к [[SPR. Руководство пользователя|сервису распознавания речи]] для получения текста
|-
|spr.model
|common
|Модель для распознавания текста
|-
|spr.conn_timeout
|10
|Таймаут на подключение к API SPR
|-
|spr.read_timeout
|30
|Таймаут на получения ответа от API SPR
|-
|reloader.period
|900
|Периодичность проверки изменения данных, для полной перезаливки векторной базы в ОЗУ
|}

===== '''Внешний драйвер шифрования'''=====

Файловая база данных хранит в составе слепки аудио, на основе которых рассчитываются вектора (если включен параметр saveAudio). В части сценариев аудио требуется шифровать. Для этого предусмотрен внешний драйвер шифрования. Чтобы использовать драйвер шифрования, необходимо создать программу (скрипт) шифрования, поместить его в каталог /opt/sbs/db_handlers/, а затем имя созданного файла прописать в параметр db_handler конфигурационного файла (/opt/sbs/config.json). Пример драйвера шифрования, который перекодирует слепки в файловой системе в base64, распространяется в составе дистрибутива и расположен в папке /opt/sbs/db_handlers/.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SBS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SBS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.sbs.cluster.trainer указываем мастер-сервер, в servers.sbs.cluster перечисляем все сервера кластера SBS, в том числе и мастер.

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/sbs/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/sbs/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SBS. Руководство администратора

2026-01-12T10:46:40Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для получения метаданных из естественной человеческой речи. Входным значением для сервиса являются wav-файлы. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Biometry Server (SBS) – сервис получения метаданных.

===== '''Системные требования''' =====
Для нормальной работы сервиса необходимо CPU >= 2.20 GHz с поддержкой инструкций AVX2 или новее. Оперативной памяти необходимо не менее 4 Gb. Для работы на нагруженных сервисах рекомендуется использовать GPU NVIDIA с поддержкой CUDA и наличием CUDA ядер.

Быстродействие на '''CPU''': например, поиск спикера, 8 потоков Xeon(R) Gold 6148 CPU @ 2.40 GHz, 8 Гб ОЗУ, запрос поиска в базе спикера по аудио 10 сек, 100 запросов со сдвигом 0.01 с (100 запросов выполнено за 1 с), максимальное время ожидания 14 с. Одиночный запрос ~1 с.

Тот же запрос с '''GPU''' А16 (с одним из 4-х ядер), максимальное время ожидания '''1.6 с'''.

===== '''Установка/обновление SBS''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/sbs&fileid=601 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для Вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SBS осуществляется скриптом <code>chmod +x ./sbs-<версия>-<релиз>.sh && ./sbs-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./sbs-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/sbs</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SBS <code>/opt/sbs/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/sbs/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/sbs/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/sbs/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/sbs/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/sbs/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/sbs/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable sbs.service && sudo systemctl start sbs.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status sbs.service</code>

Разрешите доступ к порту 6185 на нужном интерфейсе по протоколу tcp.

===== '''Конфигурирование параметров сервиса SBS'''=====
Настройка параметров сервиса spr производится в файле /opt/sbs/params.json

Описание параметров приведено в таблице. '''Применение любого из параметров требует перезапуска сервиса sbs.'''
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|saveAudio
|true
|Ключ хранения аудио отрезков в базе.
'''Внимание!''' При смене модели векторизации sbs сбросит все вектора и попытается сформировать новые из сохраненного аудио. Если аудио не будет ( saveAudio="false"), все слепки будут фактически уничтожены.
|-
|modifyType
|audio
|Способ дообучения слепка
audio — если указан этот тип, то обновление слепка дозагрузкой аудио делается через объединение старого и загружаемого аудио. Если старого аудио нет, то вектор делается только по новому аудио. В базу сохраняется только новое аудио (если стоит флаг сохранения в базу).

average — в базу сохраняется только новое аудио (если стоит флаг). А новый вектор создается из усреднения старого вектора и вектора из нового аудио.
|-
|db_handler
|""
|[https://wiki.connect2ai.net/index.php/SBS._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%92%D0%BD%D0%B5%D1%88%D0%BD%D0%B8%D0%B9_%D0%B4%D1%80%D0%B0%D0%B9%D0%B2%D0%B5%D1%80_%D1%88%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F Внешний драйвер шифрования]
|-
|logs.path
|logs/
|Путь к папке логов
|-
|logs.backups
|10
|Максимальное количество лог файлов
|-
|logs.maxSize
|5242880
|Максимальный размер одного лог файла
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[ ]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|-
|spr.url
|http://127.0.0.1:6183
|Путь к [[SPR. Руководство пользователя|сервису распознавания речи]] для получения текста
|-
|spr.model
|common
|Модель для распознавания текста
|-
|spr.conn_timeout
|10
|Таймаут на подключение к API SPR
|-
|spr.read_timeout
|30
|Таймаут на получения ответа от API SPR
|-
|reloader.period
|900
|Периодичность проверки изменения данных, для полной перезаливки векторной базы в ОЗУ
|}

===== '''Внешний драйвер шифрования'''=====

Файловая база данных хранит в составе слепки аудио, на основе которых рассчитываются вектора (если включен параметр saveAudio). В части сценариев аудио требуется шифровать. Для этого предусмотрен внешний драйвер шифрования. Чтобы использовать драйвер шифрования, необходимо создать программу (скрипт) шифрования, поместить его в каталог /opt/sbs/db_handlers/, а затем имя созданного файла прописать в параметр db_handler конфигурационного файла (/opt/sbs/config.json). Пример драйвера шифрования, который перекодирует слепки в файловой системе в base64, распространяется в составе дистрибутива и расположен в папке /opt/sbs/db_handlers/.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SBS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SBS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.sbs.cluster.trainer указываем мастер-сервер, в servers.sbs.cluster перечисляем все сервера кластера SBS, в том числе и мастер.

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/sbs/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/sbs/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SEE. Руководство администратора

2026-01-12T10:45:15Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor (SEE) предназначен для выделения смысловых сущностей из текста. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) – сервис выделения сущностей.

===== '''Системные требования''' =====
Для нормальной работы сервиса на каждые 100 одновременных запросов классификации необходимо обеспечить 1 CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее.

Оперативной памяти необходимо не менее 4Gb.

===== '''Установка/обновление сервиса''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/see&fileid=581 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].
* Установка/обновление SEE осуществляется скриптом <code>chmod +x ./see-<версия>-<релиз>.sh && ./see-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./see-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/see</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SEE <code>/opt/see/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/see/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/see/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/see/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/see/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/see/.proxy (это файл конфигурации proxy необходим для обновления, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable see.service && sudo systemctl start see.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status see.service</code>

Разрешите доступ к порту 6184 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/see/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "see", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start see</code> и извлечь UUID, указанный в файле <code>/opt/see/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Предустановленные модели''' =====
В состоянии поставки SEE содержит специализированные модели. Предустановленные модели расположены в каталоге /opt/see/pretrained/. Одна из моделей — «fio» для выделения фамилий, имен, отчеств из текста. Для этой модели возможно создать пользовательский словарь на случай, если модель не смогла определить правильно ФИО. Пользовательские словари нужно располагать в папке /opt/see/pretrained/fio/custom (surnames.txt - фамилии, firstname.txt - имена, lastnames.txt - отчества, в именительном падеже).

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса see производится в файле /opt/see/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/see/"
|-
|logs.backups
|10
|Количество файлов ротации
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|stricts
|[ "не" ]
|«Строгие частицы» — частицы речи, меняющие смысл фразы. После применения настройки, если сущность содержит такую частицу, то фраза без этой частицы не вызовет положительного срабатывания.
|-
|smc.url
|"<nowiki>http://127.0.0.1:6181</nowiki>"
|Адрес по которому доступен smc с моделью [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BD%D1%8B%D1%85_%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B5%D0%B9_SMC коррекции]
|-
|smc.conn_timeout
|2
|Таймаут подключения к smc
|-
|smc.read_timeout
|30
|Таймаут ответа от smc
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SEE для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SEE, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.see.cluster.trainer указываем мастер-сервер, в servers.see.cluster перечисляем все сервера кластера SEE, в том числе и мастер.

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/see/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/see/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SMC. Руководство администратора

2026-01-12T10:43:36Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для анализа и классификации текстовой информации. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Message Classifier (SMC) – сервис анализа и классификации.

===== '''Системные требования для SMC''' =====
Для работы smc рекомендуется использовать видеокарту NVIDIA, поддерживающую технологию CUDA и имеющую в составе ядра CUDA.

В случае отсутствия видеокарты для нормальной работы сервиса необходимо обеспечить не менее 8 потоков CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее. В конфигурации 8 потоков Intel(R) Xeon(R) Gold 6148 2.40GHz 6Гб ОЗУ фраза из 10 слов классифицируется 0.2с, соответственно за секунду может быть распознано до 5 фраз, отправленных на распознавание последовательно или одновременно. Увеличение количества ядер/потоков дает прирост производительности, но не прямо пропорциональный.

Оперативной памяти необходимо не менее 4Gb.

Для обучения моделей рекомендуется использовать видеокарту. Обучение модели на корпусе размером 7500 строк занимает на ВМ с 16 ядрами, 16Гб ОЗУ и видеокартой А16 (одном из 4-х ее ядер) около 20 минут. Недостаточная мощность CPU может увеличить время обучения за счет подготовки данных.

===== '''Установка/обновление сервиса SMC''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/smc&fileid=560 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SMC осуществляется скриптом <code>chmod +x ./smc-<версия>-<релиз>.sh && ./smc-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./smc-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/smc</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SMC<code>/opt/smc/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/smc/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/smc/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/smc/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/smc/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/smc/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/smc/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable smc.service && sudo systemctl start smc.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status smc.service</code>

Разрешите доступ к порту 6181 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/smc/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "smc", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start smc</code> и извлечь UUID, указанный в файле <code>/opt/smc/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка сервисных моделей SMC''' =====
Установка сервисных моделей возможна только копированием файла(файлов) модели в каталог с названием модели. Названия моделей предопределены и соответствуют их назначению (compressor, correction, embeddings, emotions, normalization, punctuation, toxicity). Установка сервисных моделей невозможна через API, в отличие от моделей классификации.

Модели располагаются в каталоге /opt/smc/pretrained/. Для установки модели необходимо создать каталог /opt/smc/pretrained/<название модели>/ и распаковать в неё архив модели, после чего перезагрузить сервис командой systemctl restart smc.

Проверить корректность работы модели пунктуации можно запросом к API с отправкой текста на распознавание:

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate?text=</nowiki><текст>"</code>

Список всех моделей представлен в таблице:
{| class="wikitable"
|+
!'''Модель'''
!'''Описание'''
!'''Пример запроса к модели'''
!'''Пример ответа от модели'''
|-
|'''embeddings'''
|Языковая, отвечает за вычисление векторов при обучении модели.
|Проверить работу напрямую запросом к API не получится, метод не предусмотрен.
| -
|-
|'''compressor'''
|Модель сжатия фраз. Убирает из фразы слова, не влияющие на ее смысл.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/compress?threshold=30</nowiki>" --data-urlencode "text=как можно было бы получить выплату мне бы" -H "accept: application/json"|jq</code>
|<code>{ "text": "получить выплату мне бы" }</code>
|-
|'''emotions'''
|Анализ эмоций.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/emotion</nowiki>" --data-urlencode "text=спасибо все хорошо" -H "accept: application/json"|jq</code>
|''<code>{ "emotion": "positive", "score": 0.9601 }</code>''
|-
|'''punctuation'''
|Пунктуация.
|Проверить работу можно через API запросом:
''<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate</nowiki>?" --data-urlencode "text=я пришел как мне получить услугу" -H "accept: application/json"|jq</code>''
|<code>{ "text": "Я пришел. Как мне получить услугу?" }</code>
|-
|'''normalization'''
|Обратная нормализация, заменяет числа прописью на цифры. <blockquote>''Внимание! У модели есть дополнительные требования к модулям Python в файле requirements.txt!''</blockquote>
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/normalize</nowiki>?" --data-urlencode "text=запишите меня к тринадцати" -H "accept: application/json"|jq</code>
|<code>{"text": "запишите меня к 13-ти"}</code>
|-
|'''correction'''
|Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели).
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/correct</nowiki>?" --data-urlencode "text=халодная вода" -H "accept: application/json"|jq</code>
|<code>{"text": "холодная вода"}</code>
|-
|'''toxicity'''
|Анализ текста на невежливость, угрозы, брань.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/toxicity</nowiki>?" --data-urlencode "text=нехороший человек" -H "accept: application/json"|jq</code>
Подробнее см в [[SMC. Руководство пользователя|руководстве пользователя]].

| -
|}

'''ВНИМАНИЕ!''' Модели '''punctuation, embeddings, correction''' обязательны для установки, остальные - в зависимости от сценария использования.

===== '''Установка моделей классификации''' =====
Модель классификации — это модель, обученная на определенном наборе данных (корпусе) и предназначенная непосредственно для классификации. Установка модели возможна запросом с помощью методов API. Методы описаны в [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F руководстве пользователя]. Также модель может быть установлена копированием содержимого каталога /opt/smc/nnets/<имя модели> с одного сервера smc на другой. Внимание! При этом способе UPS, в конфигурационном файле которого указан новый smc, не увидит скопированную модель.

===== '''Конфигурирование параметров сервиса''' =====

Настройка параметров сервиса smc производится в файле /opt/smc/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/smc/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|noise.enabled
|true
|Детекция мусора при классификации (фраз, которые не относятся ни к одному классу)
|-
|noise.threshold
|0.7
|Порог отсева
|-
|devices.productionModel
|cuda:0
| rowspan="9" |Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей. productionModel подразумевает все рабочие модели классификации, которые создаются в системе. Остальные модели — сервисные: embeddingModel — языковая, punctuationModel — пунктуация, emotionsModel — анализ эмоций, compressorModel — модель сжатия фраз, toxicityModel — модель анализа фразы на токсичность. Можно отдельно по названию сервисной модели включать/выключать ее загрузку в GPU. Рабочие модели можно включить в память GPU только все вместе.
|-
|devices.normalizationModel
|cuda:0
|-
|devices.embeddingModel
|cuda:0
|-
|devices.punctuationModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.compressorModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.toxicityModel
|cuda:0
|-
|devices.correctionModel
|cuda:0
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

===== '''Работа сервиса через реверс-прокси''' =====
Сервис предполагает передачу больших объемов данных через HTTP. Рекомендуем соответствующим образом настроить конфигурацию сайта в реверс-прокси. Например, в nginx дополнительные параметры:
client_max_body_size 0;
proxy_read_timeout 3h;
large_client_header_buffers 8 256k;

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SMC для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SMC, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.smc.cluster.trainer указываем мастер-сервер, в servers.smc.cluster перечисляем все сервера кластера SMC, в том числе и мастер.

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/smc/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/smc/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

===== '''Практические рекомендации''' =====
Сервис SMC в работе использует большую языковую модель, которая формирует многомерное семантическое пространство. Смысл фразы для ее классификации вычисляется на основании вектора фразы в этом пространстве. Для производительности таких вычислений рекомендуется использовать GPU с 16 Гб видеопамяти. В случае отсутствия видеокарт рекомендуется использовать не менее 3 серверов по 8 ядер и 16 Гб оперативной памяти. При этом желательно в строке запуска gunicorn в файле сервиса добавить параметр '''«-w 2»'''. Это приведет к загрузке в память 2-х экземпляров приложения и моделей и позволит при высокой нагрузке полностью загрузить процессорные ядра.

В папке /opt/smc/cache/ находится кэш векторов фраз, которые были созданы моделью векторизации. При работе сервиса при наличии вектора в кэше, он берется из него, а не создается моделью заново. Причем остается в ОЗУ тоже, что значительно увеличивает производительность сервиса, однако при прохождении через сервис большого количества различных фраз может привести к потреблению нескольких гигабайт памяти. Необходимо либо увеличить количество ОЗУ, либо просто перезагружать сервис в нерабочее время. Папку cache при желании можно периодически чистить, но в данном случае кэш будет постепенно заполняться заново с использованием GPU.

SPR. Руководство администратора

2026-01-12T10:41:46Z

KorolkovS:

===== '''Общее описание сервиса распознавания речи (SPR)''' =====
Сервис предназначен для преобразования естественной речи в текст. Входными данными для сервиса являются аудиофайлы в формате *.wav, результатом работы выступают данные в текстовом формате.

====='''Термины и определения'''=====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — модель нейронной сети, описывает её архитектуру и конфигурацию, а также используемые алгоритмы обучения.

====='''Расчет нагрузки SPR'''=====
Для нормальной работы сервиса требуются CPU с поддержкой инструкций AVX2 или новее.

Сервис требует разных ресурсов в зависимости от сценария использования.

Распознавание для голосовых помощников — рекомендуется модель common и работа на GPU NVIDIA. Возможна работа на CPU. В этом случае приемлемую задержку распознавания для одиночных фраз можно получить на ВМ с 8 потоками, 6 Гб оперативной памяти с резервом по частоте 9600 МГц (соответствует 4 ядрам по 2,4 ГГц). В этом случае 8-секундная речь будет распознана ориентировочно за 0,8 с. 4 таких ВМ обеспечат распознавание голоса абонента в диалогах длительностью 60–80 с с количеством одновременных диалогов до 60.

В случае использования GPU A16 (одной из 4 голов на ВМ 8 потоков, 6 Гб) 8-секундная речь будет распознана примерно за 0,2 с. На такой ВМ можно распознавать до 100 одновременных диалогов. При расчетах и моделировании предполагалось, что за весь диалог длительностью 60–80 с будет распознано до 6 фраз длительностью до 8 с. GPU A16 содержит 1300 ядер CUDA в одной голове. На более мощных GPU возможности возрастают кратно количеству CUDA ядер.

При распознавании для голосовых помощников рекомендуется использовать от 2-х воркеров gunicorn (-w 2 в строке запуска в файле службы) в зависимости от наличия памяти.

Распознавание для диаризации (транскрибации) длительных переговоров — одновременное, используются модели common и big. Распознавание на CPU в этом режиме не поддерживается. Для распознавания рекомендуется минимум ВМ 8 ядер 16 Гб GPU A16. На такой ВМ время распознавания в 2,5 раза меньше длительности аудио. На GPU V100 время распознавания меньше длительности аудио ориентировочно в 5 раз. Пример распознавания одного и того же файла на разных GPU:
{| class="wikitable" style="text-align: center"
|+
!Карта
!Видеопамять
!Количество ядер CUDA
!Время распознавания
(минут)
!Примечание
|-
|'''<big>A100</big>'''
|80
|6912
|12
|
|-
|'''<big>V100</big>'''
|16
|5120
|16
|
|-
|'''<big>RTX 3060</big>'''
|12
|3584
|24
|
|-
|'''<big>A16</big>'''
|'''16'''
|1280
|33
|1/4 карты
|}

Переключение между режимами распознавания — в зависимости от длительности аудио. Аудио короче 30 с распознаются для голосовых помощников. Остальные аудио разбиваются на фразы и выделяются фрагменты речи, принадлежащие разным лицам, то есть формат вывода тоже изменяется.

Требования к загружаемому аудио

Для преобразования фрагментов речи в текст используйте аудио в форматах, поддерживаемых ffmpeg.

====='''Установка/обновление SPR'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr&fileid=519 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SPR осуществляется скриптом <code>chmod +x ./spr-<версия>-<релиз>.sh && ./spr-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./spr-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/spr</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SPR <code>/opt/spr/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/spr/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/spr/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/spr/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/spr/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/spr/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей),
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/spr/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету),

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable spr.service && sudo systemctl start spr.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status spr.service</code>

Разрешите доступ к порту 6183 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/spr/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "spr", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start spr</code> и извлечь UUID, указанный в файле <code>/opt/spr/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка моделей SPR'''=====
Установка моделей возможна прямым копированием файла модели или загрузкой через API сервиса (метод POST /spr/data/{id}).

Модели располагаются в каталоге /opt/spr/nnets/. Для установки модели необходимо создать каталог /opt/spr/nnets/<название модели>/ и скопировать в него содержимое архива модели, после чего перезагрузить сервис командой systemctl restart spr.

Чтобы убедиться, что модели доступны, выполните запрос

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>"</code>

В ответе должно содержаться название новой модели или перечень названий моделей в формате json.

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/common</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code>

Некоторые модели работают только на GPU. На данный момент такая модель только одна — «big». 

===== '''Внешние модули распознавания''' =====
Сервис SPR поддерживает установку произвольных модулей распознавания. Для этого папка external должна содержать директорию с нужным модулем, в которой обязательным является наличие файла handler.py с функцией recognize(data, sr). Сервис передаст в данную функцию аудиоданные в переменную data, в формате pydub.AudioSegment, а также значение sample rate в переменной sr. Готовые внешние модули распознавания доступны по [https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr ссылке].

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/Имя_Модуля</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code> Со списком методов можно ознакомиться в [[SPR. Руководство пользователя|руководстве пользователя]]. Метод на загрузку модели <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/data/Имя_Модуля</nowiki>" -H "accept: application/json"</code> не работает с модулями в целях безопасности. Также модули не отображаются в списке моделей по запросу <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>" -H "accept: application/json"</code>. В некоторых модулях конфигурация может быть вынесена в отдельный файл. Например, для модуля yandex это - /opt/spr/external/config.json.

===== '''Конфигурирование параметров сервиса SPR'''=====
Настройка параметров сервиса spr производится в файле /opt/spr/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|max_gpu_memory
|0.99
|Лимит использования ОЗУ видеокарты.
|-
|punctuation
|false
|Расстановка знаков препинания через [[SMC. Руководство пользователя|сервис SMC]].
|-
|normalization
|false
|Обратная нормализация текста через [[SMC. Руководство пользователя|сервис SMC]].
|-
|toxicity
|false
|Анализ текста на токсичность через [[SMC. Руководство пользователя|сервис SMC]].
|-
|emotions
|false
|Анализ текста на эмоции через [[SMC. Руководство пользователя|сервис SMC]].
|-
|voice_analyzer
|false
|Анализ голоса спикера на эмоции, возраст, пол через [[SBS. Руководство пользователя.|сервис SBS]].
|-
|save_audio_requests
|false
|Записывать аудио получаемые для распознавания в синхронном режиме. Будут сохраняться в /tmp/spr/. Только для диагностики. Не применять в нагруженных серверах.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|cache.lifetime
|604800
|Время жизни кэша результатов отложенного распознавания.
|-
| sbs.url
|<nowiki>http://127.0.0.1:6185</nowiki>
|Путь к [[SBS. Руководство пользователя|сервису биометрии]] для получения метаданных голосового фрагмента.
|-
|sbs.conn_timeout
|2
|Таймаут на подключение к API SBS.
|-
|sbs.read_timeout
|30
|Таймаут на получение ответа от API SBS.
|-
|smc.url
|<nowiki>http://127.0.0.1:6181</nowiki>
|Путь к [[SMC. Руководство пользователя|сервису классификации]] для дополнительной работы с распознанным текстом.
|-
|smc.conn_timeout
|2
|Таймаут на подключение к API SMC.
|-
|smc.read_timeout
|30
|Таймаут на получение ответа от API SMC.
|-
|see.url
|<nowiki>http://127.0.0.1:6184</nowiki>
|Путь к [[SEE. Руководство пользователя|сервису поиска сущностей]] для дополнительной работы с распознанным текстом.
|-
|see.conn_timeout
|2
|Таймаут на подключение к API SEE.
|-
|see.read_timeout
|30
|Таймаут на получение ответа от API SEE.
|-
|vad.default
|webrtc
|Тип VAD по умолчанию для разбивки аудиофайлов. Возможные значения — пока только webrtc.
|-
|vad.maxSilence
|2000
|Длительность паузы в речи в миллисекундах для разбивки длинных аудиофайлов на фрагменты.
|-
|speakers.similarityThreshold
|0.7
|Порог различия для разделения говорящих.
|-
|speakers.maxSpeechLength
|10000
|Максимальная длительность фрагмента для сравнения говорящих в миллисекундах.
|-
|speakers.wordMinLimit
|5
|Минимальный размер фразы при определении говорящих.
|-
|speakers.timeMinLimit
|3000
|Минимальная длительность аудио, чтобы оно могло быть использовано для добавления нового говорящего.
|-
|speakers.batch
|4
|Количество одновременного анализируемых аудиофрагментов при разделении говорящих.
|-
|speakers.concatEqual
|true
|Позволяет склеивать последовательные фразы одного и того же говорящего.
|-
|speakers.defaultModel
|call
|Модель определения говорящего.
|-
|blacklist
|[]
|Список моделей распознавания в папках nnets и external, которые не должны быть загружены при старте сервиса SPR.
|-
|corrections
|{ "big": "common" }
|Добавление модели коррекции для стенографирования.
|-
|garbage
|[ "—", "[*]" ]
|Массив фраз, которые считаются мусорными и откидываются из распознанного текста.
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы.

* База файловая, в папке data.
* lsync настроен через конфиг SPR для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах список cluster.nodes: [] оставляем пустым.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером SPR, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.spr.cluster.trainer указываем мастер-сервер, в servers.spr.cluster перечисляем все сервера кластера SPR, в том числе и мастер.

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/spr/logs/log.txt 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/spr/uninstall</code>. Команда удалит сервис и рабочий каталог, включая все установленные модели.

====='''Практические рекомендации'''=====
Сервис spr на системах с видеокартой на большой нагрузке может не полностью использовать ресурсы GPU, при этом могут быть задержки в распознавании. Для более полного использования ресурсов рекомендуется в строке запуска gunicorn в файле сервиса добавить параметр «'''-w 2'''». Это приведет к загрузке в видеопамять 2-х экземпляров приложения и моделей. Таким образом приложение сможет более эффективно использовать ресурсы GPU, но при этом возрастет потребность в памяти GPU.

В случае если в системе обработки речи используется несколько несимметричных по ресурсам серверов spr, регулировать нагрузку на них можно указывая адрес сервера, в котором больше ресурсов, большее количество раз в разделе «spr.cluster» конфигурационного файла ups.

SPR. Руководство администратора

2026-01-12T10:40:39Z

KorolkovS:

===== '''Общее описание сервиса распознавания речи (SPR)''' =====
Сервис предназначен для преобразования естественной речи в текст. Входными данными для сервиса являются аудиофайлы в формате *.wav, результатом работы выступают данные в текстовом формате.

====='''Термины и определения'''=====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — модель нейронной сети, описывает её архитектуру и конфигурацию, а также используемые алгоритмы обучения.

====='''Расчет нагрузки SPR'''=====
Для нормальной работы сервиса требуются CPU с поддержкой инструкций AVX2 или новее.

Сервис требует разных ресурсов в зависимости от сценария использования.

Распознавание для голосовых помощников — рекомендуется модель common и работа на GPU NVIDIA. Возможна работа на CPU. В этом случае приемлемую задержку распознавания для одиночных фраз можно получить на ВМ с 8 потоками, 6 Гб оперативной памяти с резервом по частоте 9600 МГц (соответствует 4 ядрам по 2,4 ГГц). В этом случае 8-секундная речь будет распознана ориентировочно за 0,8 с. 4 таких ВМ обеспечат распознавание голоса абонента в диалогах длительностью 60–80 с с количеством одновременных диалогов до 60.

В случае использования GPU A16 (одной из 4 голов на ВМ 8 потоков, 6 Гб) 8-секундная речь будет распознана примерно за 0,2 с. На такой ВМ можно распознавать до 100 одновременных диалогов. При расчетах и моделировании предполагалось, что за весь диалог длительностью 60–80 с будет распознано до 6 фраз длительностью до 8 с. GPU A16 содержит 1300 ядер CUDA в одной голове. На более мощных GPU возможности возрастают кратно количеству CUDA ядер.

При распознавании для голосовых помощников рекомендуется использовать от 2-х воркеров gunicorn (-w 2 в строке запуска в файле службы) в зависимости от наличия памяти.

Распознавание для диаризации (транскрибации) длительных переговоров — одновременное, используются модели common и big. Распознавание на CPU в этом режиме не поддерживается. Для распознавания рекомендуется минимум ВМ 8 ядер 16 Гб GPU A16. На такой ВМ время распознавания в 2,5 раза меньше длительности аудио. На GPU V100 время распознавания меньше длительности аудио ориентировочно в 5 раз. Пример распознавания одного и того же файла на разных GPU:
{| class="wikitable" style="text-align: center"
|+
!Карта
!Видеопамять
!Количество ядер CUDA
!Время распознавания
(минут)
!Примечание
|-
|'''<big>A100</big>'''
|80
|6912
|12
|
|-
|'''<big>V100</big>'''
|16
|5120
|16
|
|-
|'''<big>RTX 3060</big>'''
|12
|3584
|24
|
|-
|'''<big>A16</big>'''
|'''16'''
|1280
|33
|1/4 карты
|}

Переключение между режимами распознавания — в зависимости от длительности аудио. Аудио короче 30 с распознаются для голосовых помощников. Остальные аудио разбиваются на фразы и выделяются фрагменты речи, принадлежащие разным лицам, то есть формат вывода тоже изменяется.

Требования к загружаемому аудио

Для преобразования фрагментов речи в текст используйте аудио в форматах, поддерживаемых ffmpeg.

====='''Установка/обновление SPR'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr&fileid=519 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SPR осуществляется скриптом <code>chmod +x ./spr-<версия>-<релиз>.sh && ./spr-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./spr-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/spr</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SPR <code>/opt/spr/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/spr/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/spr/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/spr/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/spr/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/spr/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей),
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/spr/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету),

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable spr.service && sudo systemctl start spr.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status spr.service</code>

Разрешите доступ к порту 6183 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/spr/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "spr", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start spr</code> и извлечь UUID, указанный в файле <code>/opt/spr/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка моделей SPR'''=====
Установка моделей возможна прямым копированием файла модели или загрузкой через API сервиса (метод POST /spr/data/{id}).

Модели располагаются в каталоге /opt/spr/nnets/. Для установки модели необходимо создать каталог /opt/spr/nnets/<название модели>/ и скопировать в него содержимое архива модели, после чего перезагрузить сервис командой systemctl restart spr.

Чтобы убедиться, что модели доступны, выполните запрос

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>"</code>

В ответе должно содержаться название новой модели или перечень названий моделей в формате json.

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/common</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code>

Некоторые модели работают только на GPU. На данный момент такая модель только одна — «big». 

===== '''Внешние модули распознавания''' =====
Сервис SPR поддерживает установку произвольных модулей распознавания. Для этого папка external должна содержать директорию с нужным модулем, в которой обязательным является наличие файла handler.py с функцией recognize(data, sr). Сервис передаст в данную функцию аудиоданные в переменную data, в формате pydub.AudioSegment, а также значение sample rate в переменной sr. Готовые внешние модули распознавания доступны по [https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr ссылке].

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/Имя_Модуля</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code> Со списком методов можно ознакомиться в [[SPR. Руководство пользователя|руководстве пользователя]]. Метод на загрузку модели <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/data/Имя_Модуля</nowiki>" -H "accept: application/json"</code> не работает с модулями в целях безопасности. Также модули не отображаются в списке моделей по запросу <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>" -H "accept: application/json"</code>. В некоторых модулях конфигурация может быть вынесена в отдельный файл. Например, для модуля yandex это - /opt/spr/external/config.json.

===== '''Конфигурирование параметров сервиса SPR'''=====
Настройка параметров сервиса spr производится в файле /opt/spr/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|max_gpu_memory
|0.99
|Лимит использования ОЗУ видеокарты.
|-
|punctuation
|false
|Расстановка знаков препинания через [[SMC. Руководство пользователя|сервис SMC]].
|-
|normalization
|false
|Обратная нормализация текста через [[SMC. Руководство пользователя|сервис SMC]].
|-
|toxicity
|false
|Анализ текста на токсичность через [[SMC. Руководство пользователя|сервис SMC]].
|-
|emotions
|false
|Анализ текста на эмоции через [[SMC. Руководство пользователя|сервис SMC]].
|-
|voice_analyzer
|false
|Анализ голоса спикера на эмоции, возраст, пол через [[SBS. Руководство пользователя.|сервис SBS]].
|-
|save_audio_requests
|false
|Записывать аудио получаемые для распознавания в синхронном режиме. Будут сохраняться в /tmp/spr/. Только для диагностики. Не применять в нагруженных серверах.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|cache.lifetime
|604800
|Время жизни кэша результатов отложенного распознавания.
|-
| sbs.url
|<nowiki>http://127.0.0.1:6185</nowiki>
|Путь к [[SBS. Руководство пользователя|сервису биометрии]] для получения метаданных голосового фрагмента.
|-
|sbs.conn_timeout
|2
|Таймаут на подключение к API SBS.
|-
|sbs.read_timeout
|30
|Таймаут на получение ответа от API SBS.
|-
|smc.url
|<nowiki>http://127.0.0.1:6181</nowiki>
|Путь к [[SMC. Руководство пользователя|сервису классификации]] для дополнительной работы с распознанным текстом.
|-
|smc.conn_timeout
|2
|Таймаут на подключение к API SMC.
|-
|smc.read_timeout
|30
|Таймаут на получение ответа от API SMC.
|-
|see.url
|<nowiki>http://127.0.0.1:6184</nowiki>
|Путь к [[SEE. Руководство пользователя|сервису поиска сущностей]] для дополнительной работы с распознанным текстом.
|-
|see.conn_timeout
|2
|Таймаут на подключение к API SEE.
|-
|see.read_timeout
|30
|Таймаут на получение ответа от API SEE.
|-
|vad.default
|webrtc
|Тип VAD по умолчанию для разбивки аудиофайлов. Возможные значения — пока только webrtc.
|-
|vad.maxSilence
|2000
|Длительность паузы в речи в миллисекундах для разбивки длинных аудиофайлов на фрагменты.
|-
|speakers.similarityThreshold
|0.7
|Порог различия для разделения говорящих.
|-
|speakers.maxSpeechLength
|10000
|Максимальная длительность фрагмента для сравнения говорящих в миллисекундах.
|-
|speakers.wordMinLimit
|5
|Минимальный размер фразы при определении говорящих.
|-
|speakers.timeMinLimit
|3000
|Минимальная длительность аудио, чтобы оно могло быть использовано для добавления нового говорящего.
|-
|speakers.batch
|4
|Количество одновременного анализируемых аудиофрагментов при разделении говорящих.
|-
|speakers.concatEqual
|true
|Позволяет склеивать последовательные фразы одного и того же говорящего.
|-
|speakers.defaultModel
|call
|Модель определения говорящего.
|-
|blacklist
|[]
|Список моделей распознавания в папках nnets и external, которые не должны быть загружены при старте сервиса SPR.
|-
|corrections
|{ "big": "common" }
|Добавление модели коррекции для стенографирования.
|-
|garbage
|[ "—", "[*]" ]
|Массив фраз, которые считаются мусорными и откидываются из распознанного текста.
|-
|cluster.logfile
|logs/sync.log
|Файл логов синхронизации есть только на главном сервере кластера
|-
|cluster.statusFile
|logs/sync.status
|Статус задачи синхронизации есть только на главном сервере кластера
|-
|cluster.nodes
|[]
|Перечень подчиненных нод для синхронизации изменений заполняется только на главном сервере кластера
|}

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/spr/logs/log.txt 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/spr/uninstall</code>. Команда удалит сервис и рабочий каталог, включая все установленные модели.

====='''Практические рекомендации'''=====
Сервис spr на системах с видеокартой на большой нагрузке может не полностью использовать ресурсы GPU, при этом могут быть задержки в распознавании. Для более полного использования ресурсов рекомендуется в строке запуска gunicorn в файле сервиса добавить параметр «'''-w 2'''». Это приведет к загрузке в видеопамять 2-х экземпляров приложения и моделей. Таким образом приложение сможет более эффективно использовать ресурсы GPU, но при этом возрастет потребность в памяти GPU.

В случае если в системе обработки речи используется несколько несимметричных по ресурсам серверов spr, регулировать нагрузку на них можно указывая адрес сервера, в котором больше ресурсов, большее количество раз в разделе «spr.cluster» конфигурационного файла ups.

UPS. Описание API

2026-01-12T10:31:20Z

KorolkovS:

===== '''Описание часто используемых параметров''' =====
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
|-
|'''servicetype'''
|запрос
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts.
|-
|'''servertype'''
|запрос
|Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы).
|-
|'''model'''
|запрос
|Название модели.
|-
|'''modeltype'''
|запрос
|Тип модели. Возможные значения: '''future''' — планируемая/черновик, '''current''' — текущая/рабочая, '''previous''' — архивная.
|-
|'''error'''
|ответ
|Флаг ошибки.
|-
|'''message'''
|ответ
|Информационное сообщение.
|}

===== '''"/external modules" методы внешних модулей''' =====

В этом разделе будут методы соответствующим образом оформленных [[UPS. Руководство администратора#Установка модулей для UPS|внешних модулей]]

===== '''/auth: методы авторизации''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/auth/access'''
! colspan="3" style="width: 85%" |Получение токенов доступа. Токен доступа определяет, какие из методов будут доступны конкретному пользователю. Формируется на основании роли. Дополнительный входной параметр во всех методах, кроме перечисленных в разделе «nopassword» конфигурационного файла. Время действия токена определяется параметром auth.accessLifeTime конфигурационного файла.
|-
|colspan="2" style="width: 50%" |
* '''username''' — логин

* '''password''' — пароль
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/add'''
! colspan="3" style="width: 85%" |Добавление dataset (набора данных). Dataset (набор данных) используется для ограничения доступа к данным. В ответе метод вернет id созданного набора данных.
|-
|colspan="2" style="width: 50%" |
* data — json строка вида: { "name": "название нового набора" }
|colspan="2" style="width: 50%" |{

"error": 0

"message": "success",

"dataset_id": "XXXXXXXXXXXXX"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/dataset/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление dataset (набора данных).
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/modify/{id}'''
! colspan="3" style="width: 85%" |Переименование dataset (набора данных). Метод меняет все параметры набора данных, но на данный момент времени у набора данных, кроме id, только один параметр — наименование.
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
* '''data''' — JSON c новыми параметрами
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/datasets'''
! colspan="3" style="width: 85%" |Получение списка наборов данных.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXXXXXXXXXX",

"name": "XXX"},

{"id": "0",

"name": "По умолчанию"}

]
|-
!style="color:blue;width: 15%" |'''GET/auth/refresh'''
! colspan="3" style="width: 85%" |Обновление токенов доступа. Время, в течение которого можно обновить доступ, регулируется параметром auth.refreshLifeTime конфигурационного файла. Служебный метод, используется в основном в веб-интерфейсе, чтобы не запрашивать лишний раз пароль.
|-
|colspan="2" style="width: 50%" |
* '''x-refresh-token''' — токен обновления доступа
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/rights'''
! colspan="3" style="width: 85%" |Получение списка прав доступа. Служебный метод — по токену получает название роли и все права доступа этой роли, а также общедоступные методы.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |<<<{ "РОЛЬ": [

 "GET:/......" ],

 "nopassword": [ "GET:/.......",

...............

<<<...............

 "POST:/......." ] }
|-
!style="color:green;width: 15%" |'''POST/auth/role/add'''
! colspan="3" style="width: 85%" |Создание роли. Служебный метод — используется веб-интерфейсом при создании роли.
|-
|colspan="2" style="width: 50%" |
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{

"error": 0, "message": "success", "role_id": "a7e68bb83169f864c2fc868401b5250c"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/role/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление роли.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/role/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение роли. Параметры как при создании роли. Роль будет переписана.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/roles'''
! colspan="3" style="width: 85%" |Получение списка ролей.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[{

"id": "XXXXXXXXXXX",

"name": "имя роли",

"rights": [ "набор прав через запятую" ]

},............]
|-
!style="color:green;width: 15%" |'''POST/auth/user/add'''
! colspan="3" style="width: 85%" |Создание нового пользователя. Метод вернет или id нового пользователя или описание ошибки
|-
|colspan="2" style="width: 50%" |
* '''data''' — json строка {

"username": "login_name", "fullname": "Отображаемое Имя","password": "XXXXX","role": "role_id",

"dataset": "default dataset id", "datasets": [ "dataset id", ................. ] }
|colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"user_id": "XXXXXXXXXXXXXXXX"}
|-
!style="color:red;width: 15%" |'''DELETE/auth/user/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' - идентификатор пользователя
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/user/get/{id}'''
! colspan="3" style="width: 85%" |Получение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2" ] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/info'''
! colspan="3" style="width: 85%" |Получение параметров пользователя по его токену доступа. Служебный метод - для предоставления прав текущему пользователю по его токену
|-
|colspan="2" style="width: 50%" |
* '''x-access-token'''
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/list'''
! colspan="3" style="width: 85%" |Получение списка пользователей с их параметрами. Тоже самое что и в методе GET /auth/user/info, только для всех пользователей
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] },

......

]
|-
!style="color:green;width: 15%" |'''POST/auth/user/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''data''' — параметры пользователя как при создании
* '''id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{ "error": 0,

"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/user/password'''
! colspan="3" style="width: 85%" |Смена пароля пользователя по его токену доступа.
|-
|colspan="2" style="width: 50%" |
* '''password'''
|colspan="2" style="width: 50%" |{ "error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/userlog'''
! colspan="3" style="width: 85%" |Получение действий пользователя за период времени по его токену
|-
|colspan="2" style="width: 50%" |
* '''from''' — начало периода в формате "%Y-%m-%d %H:%M"

* '''to''' — конец периода в формате "%Y-%m-%d %H:%M"
|colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "data": [

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 .........

}
|-
!style="color:blue;width: 15%" |'''GET/auth/version'''
! colspan="3" style="width: 85%" |Получение версии сервиса ups
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |{

 "version": "4.082 release"

}
|}

===== '''/lang: методы мультиязычности''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/lang/'''
! colspan="3" style="width: 85%" |Выводит информацию о переводе элементов интерфейса на текущий язык
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "see":"Сущности",

"smc":"Классификатор",

... }
|-
!style="color:blue;width: 15%" |'''GET/lang/wallpaper'''
! colspan="3" style="width: 85%" |Отдает случайный фон рабочего стола в виде jpeg из каталога «wallpapers» на сервере ups
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |image/jpeg
|}

===== '''/server: получение информации о серверах''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |GET/server/get/addresses/{servicetype}
! colspan="3" style="width: 85%" |Вывод информации о серверах, обслуживающих данный сервис, а также настроенных параметров обращения к данным серверам.
'''trainer''' — сервер обучения, '''cluster''' — рабочие серверы, '''connect''' — время на подключение, '''read''' — время на ответ,

'''failed''' — время пребывания в сбойных, '''install''' — время на установку модели, '''info''' — время на получение информации о модели,

'''counter''' — счетчик запросов, '''current''' — индекс последнего опрошенного cluster-сервера

'''fail''' — массив сбойных серверов со временем постановки в сбой.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",

 "cluster": [ "<nowiki>http://127.0.0.1:6181</nowiki>" ],

 "timers": { "connect": 0.5,

 "read": 1,

 "failed": 600,

 "install": 60,

 "info": 3 },

 "counter": 0,

 "current": 0,

 "fail": {"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678} }
|-
!style="color:blue;width: 15%" |GET/server/get/models/{servicetype}/{servertype}
! colspan="3" style="width: 85%" |Вывод информации о моделях указанного сервиса на каждом сервере указанного типа. Вывод представляет собой массив URL-серверов, для каждого из которых указан список моделей.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса

* '''servertype''' — тип серверов
| colspan="2" style="width: 50%" |{ "<nowiki>http://127.0.0.1:6181</nowiki>": [

 "model1",

 ...

 "modelN"

 ], ... }
|}

===== '''/model: методы работы с моделями''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/model/add/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Создание пустой модели в указанном сервисе. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 30%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 70%" |{

"error":0,

"message":"success"

}
|-
!style="color:green;width: 15%" |'''POST/model/apply/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Применение установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:red;width: 15%" |'''DELETE/model/delete/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/errors/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Запрос на получение списка ошибок модели после тестирования/обучения. Доступен для сервисов see и smc. Ответ содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза).
|-
| colspan="2" style="width: 50%" |
* '''type''' — тип ошибок в выводе
'''- train''' ошибки обучения

'''- test''' ошибки тестирования

'''- mark''' ошибки авторазметки
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[ [true, predicted, phrase],

... ]
|-
!style="color:blue;width: 15%" |'''GET/model/export/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Экспорт модели, модель скачивается в виде zip-архива.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл model.zip, где model — название модели
|-
! style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Удаление постобработчика из модели типа future. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель типа future. Обработчик становится активным сразу после успешной отправки. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из модели типа future.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Удаление постобработчика в указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель указанного типа. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''modeltype''' — тип модели
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:green;width: 15%" |'''POST/model/import/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Импортирует модель в черновик (modeltype=future)
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''zip-model''' — zip с файлами модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}'''
! colspan="3" style="width: 85%" |Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "model1": {

 "previous": null,

 "current": null,

 "future": {

 "status": "empty",

 ...

 } }, ... }
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение информации о каждом типе (modeltype) указанной модели. Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{ "previous": null,

 "current": {

 "status": "trained",

 ... },

 "future": {

 "status": "trained",

 ... } }
|-
!style="color:green;width: 15%" |'''POST/model/install/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Установка импортированной или обученной модели на рабочих серверах.
Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/log/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: '''smc''', '''see'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[

 "training",

 "preparing data",

 "tokenizing",

 ...

]
|-
!style="color:green;width: 15%" |'''POST/model/restore/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так:
* '''current -> future'''
* '''previous -> current'''
* '''null -> previous'''
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|}

===== '''/corpus: работа с данными для обучения моделей''' =====
Методы данного класса предназначены только для сервисов smc и see

{| class="wikitable" style="width: 110%"
|+
!style="color: blue;width: 15%" |'''GET/corpus/automark/list'''
! colspan="3" style="width: 85%" |Перечень заданий автоматической маркировки корпусов.
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "tasks": [ {

 "id": "29d9da98-d6c1-4dc1-bbc9-111309816002",

 "taskname": "test_doc",

 "status": "finished" },

 { "id": "1a5e9bdc-9f98-49d2-84de-1a9bde8fc37c",

 "taskname": "sssss",

 "status": "finished" } ] }
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/result/{id}'''
! colspan="3" style="width: 85%" |Результат выполнения задания на автомаркировку корпуса. Если задание завершено в ответе придет маркированый корпус и время старта и финиша задания
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{
"error": 0,

"message": "success",

"started": "2024-10-09 18:05:51",

"finished": "2024-10-09 18:05:51",

"corpus": [[ [], [ ["тэг"],"фраза 1"]],

[ [], [["тэг"],"фраза 2"]] ]
}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''taskname''' — произвольное имя задания

* '''corpus''' — json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

* '''marks''' — json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

* '''appendMarks''' — "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "уникальный id задания"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — уникальный id задания
| colspan="2" style="width: 50%" |{

 "error": "",

 "status": "finished",

 "started": "2024-10-09 13:49:46",

 "finished": "2024-10-09 13:49:46",

 "progress": 0

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: green;width: 15%" |'''POST/corpus/copy/{servicetype}'''
! colspan="3" style="width: 85%" |Копирование корпуса данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: red;width: 15%" |'''DELETE/corpus/delete/{servicetype}'''
! colspan="3" style="width: 85%" |Удаляет корпус с данными
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: blue;width: 15%" |'''GET/corpus/export/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает текстовый файл с корпусом, содержащий строки вида КЛАСС<TAB>ФРАЗА
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |Файл name.txt
|-
!style="color: blue;width: 15%" |'''GET/corpus/get/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает JSON с данными корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |<code>[</code>
<code> [ "тэг",</code>

<code> "фраза"</code>

<code> ],</code>

<code> ...</code>

<code>]</code>
|-
!style="color: green;width: 15%" |'''POST/corpus/import/{servicetype}'''
! colspan="3" style="width: 85%" |Метод для импорта корпуса данных. Возможен как из текстового файла со строками вида КЛАСС<TAB>ФРАЗА (доступно для smc и see), так и из логов работы системы (только для smc). Если на вход поступил файл csv, происходит импорт из файла, в противном случае — из логов.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''csv''' — файл данных
* '''startDate''' — дата начала выборки, YYYY-MM-DD
* '''stopDate''' — дата окончания выборки, YYYY-MM-DD
* '''model''' — имя модели, из логов которой будет произведен импорт
* '''limit''' — числовое ограничение строк импорта
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/list/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает список всех корпусов данных для указанного типа сервиса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |[ "корпус1",

"корпус2",

 ...]
|-
!style="color: green;width: 15%" |'''POST/corpus/put/{servicetype}'''
! colspan="3" style="width: 85%" |Перезаписывает корпус отправленным массивом данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''json''' — строка формата json с данными. Аналогична выводу метода GET /get/{servicetype}
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: green;width: 15%" |'''POST/corpus/rename/{servicetype}'''
! colspan="3" style="width: 85%" |Переименование корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|}

===== '''/marks: работа с наборами меток в smc''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/marks/add'''
! colspan="3" style="width: 85%" |Добавление набора менток
|-
| colspan="2" style="width: 50%" |
* '''json''' —список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''name''' — имя создаваемого набора
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "132310fa-98c7-4b12-896f-ff113827d077"

}
|-
!style="color:red;width: 15%" |'''DELETE/marks/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление набора меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }

|-
!style="color:blue;width: 15%" |'''GET/marks/export/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде строк
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

метка1 синоним1,синоним2,синоним3,синонимN 0.9

меткаN синоним11,синоним21,синоним31,синонимN1 0.9
|-
!style="color:blue;width: 15%" |'''GET/marks/get/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде json
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "data": [

 ["метка1", [ "синоним1", "синоним2", "синоним3", "синонимN" ],

 0.9

 ],

 ["меткаN", ["синоним11","синоним21", "синоним31","синонимN1"],

 0.9

 ] ] }
|-
!style="color:green;width: 15%" |'''POST/marks/import/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из файла. Набор будет переписан из файла
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл "метка"ТАБ"синонимы через запятую"ТАБ"достоверность(число от 0 до 1)"

* '''id''' — идентификатор набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/marks/list'''
! colspan="3" style="width: 85%" |Получение списка наборов меток
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "result": [ { "id": "416fbe08-19e9-453c-b140-37008a08a76c","name": "test" },

 {"id": "16e77fa2-7c4d-47f9-8644-6385876525d6","name": "Рыжик" },

 {"id": "132310fa-98c7-4b12-896f-ff113827d077", "name": "test" }

 ]}
|-
!style="color:green;width: 15%" |'''POST/marks/put/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из json строки. Набор будет переписан
|-
| colspan="2" style="width: 50%" |
* '''json''' — список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''id''' — идентификатор заменяемого набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:green;width: 15%" |'''POST/marks/rename/{id}'''
! colspan="3" style="width: 85%" |Присваивает новое наименование существующему набору меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
* '''name''' — новое имя набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|}

===== '''/spr: работа с сервисом SPR''' =====

{{:SPR. Руководство пользователя}}

===== '''/smc: работа с сервисом SMC''' =====

{{:SMC. Руководство пользователя}}

===== '''/see: работа с сервисом SEE''' =====

{{:SEE. Руководство пользователя}}

===== '''/sbs: работа с сервисом SBS''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 20%" |
* '''wav''' — файл для анализа
| colspan="2" style="width: 80%" |Пример:

{ age: {

 class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}

 confidence: 0.99 },

emotion: {

 class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", "NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}

 confidence: 0.99 },

gender: {

 class: FEMALE, # { "MALE", "FEMALE" }

 confidence: 0.99 } }
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:
<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для анализа
*'''threshold''' — порог похожести при поиске, от 0 до 1.
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |Пример ответа:

{ error: 0, speaker: Ivan, confidence: 0.79 }
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{

 "error": 0,

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"

}
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 20%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 80%" |{ error: INT, message: DESCRIPTION }
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |[ {

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",

 "name": "наименование слепка"

 }]
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для обучения
*'''id''' — идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0,

 "message": "Success"}
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0, "confidence": 0.78 }
|}

====='''/tts: методы работы с сервисом tts'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |Простой текст — строки со словом и его интерпретацией с ударением.
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ [ "слово", "замена слова с удар+ением"],

[ "слово2", "замена слова2 с удар+ением"],

...]
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
*'''csv file''' — файл строк со словом и его интерпретацией с ударением.
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "сообщение о статусе результата"}
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка json следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "сообщение о статусе результата"

}
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="3" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
*'''text''' — фраза для нормализации
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "text": "нормализованный текст" }
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="3" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
*'''wav''' — аудиофайл для обработки

*'''revoicer''' — модель модификации голоса
| colspan="2" style="width: 50%" |wav-файл с модифицированным (искаженным) голосом
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ "distortion" ]
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{model}'''
! colspan="3" style="width: 85%" |Синтез звукового файла из текста/
|-
| colspan="2" style="width: 50%" |
*'''ID''' — имя модели
*'''text''' — текст синтезируемой фразы
*'''rate''' — скорость речи
*'''pitch''' — высота (тон)
*'''volume''' — громкость
*'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
*'''format''' - формат файла результата (wav, opus, ogg, mp3)
*'''link''' - если 1, то вернуть только ссылку на файл
| colspan="2" style="width: 50%" |файл с синтезированой фразой
|}

====='''/qas: методы работы с сервисом qas'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/qas/ask'''
! colspan="2" style="width: 85%" |Метод генерирует ответ на поставленный вопрос на основе информации из документов в базе. Ответ на вопрос генерируется на основе информации, содержащейся в одном или нескольких документах. Документы должны быть в текстовом формате. Ответ возвращается в формате JSON, его можно скачать. Если метод не смог найти ответ, возвращается код ошибки и сообщение.
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст вопроса, на основе которого будут искаться фрагменты.
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''maxDocs''' — максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{

"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы*'''mode''' - режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' - генерирует кэш через разные ответы на каждый вопрос по документации
*'''mode''' — режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' — генерирует кэш через разные ответы на каждый вопрос по документации

*'''option''' - {all | empty} обработать все вопросы или только не содержащие ответов
*'''category''' - если указан код категории, то генерация только для этой категории

*'''variants''' - количество ответов, от 1 до 9
*'''replace''' - заменить ответы на сгенерированные
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/status'''
! colspan="2" style="width: 85%" |Состояние генерации ответов на вопросы в кэше. Статусы: '''started''', '''stopped''', если были ошибки, поле ответа '''error''' будет содержать код ошибки.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "started",

 "progress": 33.33}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/stop'''
! colspan="2" style="width: 85%" |Остановить генерацию ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/category/add'''
! colspan="2" style="width: 85%" |Добавить категорию с указанным именем. В ответе — id созданной категории или сообщение об ошибке:
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "id": "ad895085-2e48-439a-831e-b5f699b6a54a" }
|-
! style="color:red;width: 15%" |'''DELETE/qas/category/delete/{id}'''
! colspan="2" style="width: 85%" |Удалить категорию. В ответе или сообщении об успехе, или ошибке, если категория используется или не существует.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/category/list'''
! colspan="2" style="width: 85%" |Получить список категорий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |В ответе json с именами и id категорий
|-
! style="color:green;width: 15%" |'''POST/qas/category/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить категорию. У категории пока есть только наименование, поэтому метод только переименовывает категорию
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/add'''
! colspan="2" style="width: 85%" |Добавление канала. В ответе id созданного канала или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование канала
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "a46fb887-5d98-41e0-8299-bcc94f615e91"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/channel/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление канала
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/channel/list'''
! colspan="2" style="width: 85%" |Получить список всех каналов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": 0,

 "channels": [

 { "id": "1", "name": "voice" },

 { "id": "56442779-e871-43fd-ae4d-caf4ab6d09b9", "name": "канал++" },

 { "id": "0", "name": "default" }

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить канал. У канала пока есть только наименование, поэтому метод только переименовывает канал
|-
| colspan="2" style="width: 50%" |
*'''name''' — новое наименование канала

*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Пример ответа на вопрос "как пройти в библиотеку"{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc/start'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
* '''text -''' текст документа
* '''model''' - какую модель использовать для ответа, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM, необязательный параметр
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/stop'''
! colspan="2" |Остановка очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/status'''
! colspan="2" |Статус очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{
"error": 0,

"status": stopped | started,

"progress": 33.3,

"message": string,

"place": number, #место в очереди

"queue": True | False #состояния - в очереди или в процессе очистки

}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/result'''
! colspan="2" |Результат очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0,"status": "stopped","text": "очищенный текст","doc_id": "ID документа"}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/add'''
! colspan="2" style="width: 85%" |Загрузить текстовый документ. Добавляет документ в базу. В ответе — id созданного документа или сообщение об ошибке.
|-
| colspan="2" style="width: 50%" |
*'''title''' — заголовок документа
*'''category''' — категория документа
*'''text''' — файл документа
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "ebe2bc57551c2d17f892987d1f62306d"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/doc/delete/{id}'''
! colspan="2" style="width: 85%" | Удаление документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка текста документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{

 "error": 0,

 "text": "Здесь будет полный текст документа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/list'''
! colspan="2" style="width: 85%" |Получение списка имеющихся документов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |Пример:

{ "error": 0,

 "docs": [

 {id": "d4999cdee5ad1faf2cb3066ea1b5e96b",

 "title": "PVE. Установка сервисного пакета окружения",

 "category": "Техническая поддержка" },

 {"id": "759042575b965745b9d2af869bca1740",

 "title": "UPS. Руководство администратора",

 "category": "Техническая поддержка"} ]}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modify/{id}'''
! colspan="2" style="width: 85%" |Обновление документа. В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c изменяемыми параметрами документа

<code>{</code>

<code> title: string,</code>

<code> category: string,</code>

<code> text: string</code>

<code>}</code>

параметр который не меняется может отсутствовать в json

*'''id''' — идентификатор документа.
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/replace'''
! colspan="2" style="width: 85%" |Замена подстроки в текстах категории Будут заменены все найденные вхождения
|-
| colspan="2" style="width: 50%" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
| style="width: 50%" |{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modifyphrases'''
! colspan="2" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/gpt/list'''
! colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success", "models": ["default" ]}
|-
! style="color:green;width: 15%" |'''POST/qas/question/add'''
! colspan="2" style="width: 85%" |Добавление вопроса. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса

*'''category''' — id категории к которой относится вопрос

*'''answers''' — ответы в виде Json:

<code>[ { "checked": true, "channel": "0", "answer": "ответ" } ]</code>

*'''aliases''' — вопросы к которым подходят ответы из блока answers в виде json:

<code>["вопрос","еще вопрос"]</code>
| style="width: 50%" |{

 "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:green;width: 15%" |'''POST/qas/question/append/{id}'''
! colspan="2" style="width: 85%" |Добавляет алиасы/кандидаты к другому вопросу
|-
| colspan="2" style="width: 50%" |
*'''aliases''' — JSON list с синонимами

*'''candidates''' JSON list с кандидатами

*'''id''' — идентификатор вопроса к которому добавить синонимы и(или) кандидаты
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/approve/{destination_id}'''
! colspan="2" style="width: 85%" |Перемещает кандидаты в формулировки другого вопроса
|-
| colspan="2" style="width: 50%" |
*'''candidates''' — json массив c текстами кандидатов

*'''destination_id''' — идентификатор вопроса
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/delete/list'''
! colspan="2" style="width: 85%" |Удаление списка вопросов или ответов
|-
| colspan="2" style="width: 50%" |
*'''questions''' — json строка с перечнем id

*'''type''' — выбор, удалять вопросы или ответы ('''questions''', '''answers''')
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:red;width: 15%" |'''DELETE/qas/question/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/question/get/{id}'''
! colspan="2" style="width: 85%" | Получение вопроса вместе с ответами и синонимами вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{ "error": 0,

 "answers": [

 { "checked": true,

 "channel": "0",

 "answer": "ответ" } ],

 "aliases": [

 "вопрос",

 "синоним вопроса",

 "еще синоним вопроса" ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/question/list'''
! colspan="2" style="width: 85%" | Получение списка вопросов.
|-
| colspan="2" style="width: 50%" |
*'''question''' — фильтр вопросов, ограничение списка по вопросам
*'''category''' — фильтр категорий

*'''answer''' — фильтр ответов, ограничение списка по ответам
*'''created''' — фильтр по дате создания, оставляет вопросы, созданные '''не ранее''' указанной даты
*'''createdBefore''' — фильтр по дате создания, оставляет вопросы, созданные '''не позже''' указанной даты
*'''modified''' — фильтр по дате изменения, оставляет вопросы, '''изменённые в точности''' в указанную дату
*'''onlyNew''' - фильтр, оставляющий только новые (необработанные) вопросы
| style="width: 50%" |{ "error": 0,

 "questions": [

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0},

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0}

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/question/modify/{id}'''
! colspan="2" style="width: 85%" |Модификация вопроса. Позволяет заменить как все параметры так и отдельные
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c измененными параметрами, пример полного:

<code>{ "answers": [</code>

<code> {</code>

<code> "checked": true,</code>

<code> "channel": "0",</code>

<code> "answer": "новый ответ"</code>

<code> }</code>

<code> ],</code>

<code>"question":"новый вопрос",</code>

<code>"category": "a3801cc0-f8e5-4f3b-bb10-e42148cd772b",</code>

<code> "aliases": [</code>

<code> "новый вопрос",</code>

<code> "синоним",</code>

<code> "еще синоним"</code>

<code> ]</code>

<code>}</code>

*'''id''' — идентификатор вопроса
| style="width: 50%" |В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.

{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/question/replace'''
! colspan="2" |Поиск и замена подстроки. Будут заменены все найденные вхождения
|-
| colspan="2" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
|{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/question/modifyanswers'''
! colspan="2" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/paraphrase'''
! colspan="2" |Генерация фраз-синонимов для предложения.
|-
| colspan="2" |
*'''text -''' предложение
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "texts": [ "перефразированный текст 1", ... ]}
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/answers'''
! colspan="2" style="width: 85%" |Отображает лог массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |на выходе :
массив из объектов {

 error: number;

 question: string;

 answer: string;

 confidence: number | null;

}
|-
! style="color:green;width: 15%" |'''POST/qas/questionlist/start'''
! colspan="2" style="width: 85%" | Старт массовой обработки вопросов из файла
|-
| colspan="2" style="width: 50%" |
*'''questions''' - файл с вопросами
*'''format''' - в json или в text файл с вопросами
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

— "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''threshold''' - порог достоверности при обработке
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/status'''
! colspan="2" style="width: 85%" |Статус массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;

 status: 'started' | 'stopped';

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/stop'''
! colspan="2" style="width: 85%" |Остановка массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM для анализа на несоответствия, необязательный параметр
*'''asktemplate''' - ID шаблона запроса к LLM для генерации ответов по документу, необязательный параметр
*'''answers''' - тип вопросов, по которым осуществляется поиск несоответствий, необязательный параметр, по умолчанию «all»
|<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/status'''
! colspan="2" style="width: 85%" |Статус поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;<nowiki> status: 'started' | 'stopped';</nowiki>

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/stop'''
! colspan="2" style="width: 85%" |Остановка поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/mismatches'''
| colspan="2" |Статус получения результатов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": 0,"message": "success","mismatches": [{"question_id": "ID вопроса", "question": "вопрос", "category": "ID категории", "answer_id": "ID ответа", "answer": "ответ на вопрос {question}", "description": "результат поиска", "error" : string, "context": "фрагмент документа", "generatedText" : "Результат генерации" }, ... ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/start'''
| colspan="2" |Запуск генерации вопросов
|-
| colspan="2" |
*'''category''' - ID категории, по которой будет происходить генерация вопросов
*'''doc''' - ID документа, по которому будет происходить генерация вопросов
*'''generateAnswers''' - флаг для генерации ответов вместе с вопросами '''[yse|no]''', по умолчанию '''«no»'''
*'''model''' - имя модели GPT, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM для анализа генерации вопросов, необязательный параметр
|{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
| colspan="2" |Статус генерации вопросов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": string, <nowiki>"status": 'started' | 'stopped',</nowiki> "progress": 33.3 }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/stop'''
! colspan="2" style="width: 85%" |Прервать генерацию.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
* '''maxDocs''' - максимальное количество документов одной категории для формирования контекста при поиске ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{ "error": 0,

 "text": "

 Фрагмент 1:Здесь будет текст найденного фрагмента

 Фрагмент 2:Здесь будет текст найденного фрагмента",

 "fragments": [

 { "id": "3a386b0a9e0e19efb0870685e1d0b484",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" },

 { "id": "44fd73ea1ac63f32cf18d79c854dbfe2",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" } ] }
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/add'''
! colspan="2" style="width: 85%" |Добавление шаблона протокола. В случае успеха метод вернет id шаблона, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''name''' — название шаблона

* '''options''' — json словарь с именами разделов и их описанием
| style="width: 50%" |{ "error": 0, "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"}
|-
! style="color:red;width: 15%" |'''DELETEqas/summarization_template/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление шаблона.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/get/{id}'''
! colspan="2" style="width: 85%" |Получение json с шаблоном.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |На выходе словарь, основные элементы: data — словарь с шаблоном, остальные элементы этого уровня служебные. В data: id, name (идентификатор и наименование).И options — словарь с разделами шаблона.
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/list'''
! colspan="2" style="width: 85%" |Получение всех шаблонов.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |На выходе словарь, основной элемент — templates, содержит список шаблонов (каждый шаблон как в выдаче метода GET /qas/summarization_template/get/{id}).
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение шаблона.
|-
| colspan="2" style="width: 50%" |
*'''data''' — словарь как в выдаче метода GET/qas/summarization_template/get/{id}

*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/summarize'''
! colspan="2" style="width: 85%" |Построение протокола или краткого содержания совещания
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст совещания

*'''options''' — словарь с разделами протокола, где ключ — название раздела, значение - краткая инструкция к формированию раздела.
*'''model''' - какую GPT модель использовать для построения протокола, если кроме default используются другие модели

*'''file''' — файл с текстом (текст, csv, pdf или текстовые офисные документы)
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{ "error": 0,
 "message": "success",

 "summary": "здесь текст протокола"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replace'''
! colspan="2" |корректировка информации в тексте при помощи LLM
|-
| colspan="2" |
*'''text''' - текст
*'''oldinfo''' — старая информация
*'''newinfo''' — новая информация
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{ "error": 0, "message": "success",

 "text": "итоговый текст"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replacementlist'''
! colspan="2" |список всех фраз в документах и ответов в вопросах, подлежащих правке. Векторно ищет все фрагменты по указанному тексту.
|-
| colspan="2" |
*'''text''' - текст
*'''category''' — категория, в которой производится векторный поиск
*'''threshold''' — порог похожести, необязательный параметр, если не указан, берется из конфигурационного файла (fragments -> threshold)
*'''answers''' - тип вопросов, по которым осуществляется поиск для внесения правок, необязательный параметр, по умолчанию «all»
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/add'''
! colspan="2" |Добавление шаблона запроса к LLM. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" |
*'''type''' — тип шаблона - chat - произвольный чат, - ask - запрос к документам, - cleandoc - очистка документа, форматирование либо другое преобразование, - similars_generator - генерация синонимичных которотких фраз, - paraphrase - перефразировка текста, - summarize - суммаризация текста (формирование краткой выдержки из текста), - question_generator - генерация вопросов по тексту, - replace - замена информации в тексте, mismatch - поиск несоответствий

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
*'''params''' - параметры запроса к LLM"max_tokens": 4096, "top_k": 30, "top_p": 0.5, "temperature": 0.5, "repeat_penalty": 1.3
|{ "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:red;width: 15%" |'''DELETE/qas/prompt/delete/{id}'''
! colspan="2" |Удаление шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/get/{id}'''
! colspan="2" |Получение шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{ "error": 0, "prompt": {

 "id": "cleandoc",

 "type": "cleandoc",

 "isDefault": false,

 "name": "Чистка документа",

 "prompt": "Удали сноски, колонтитуры и мусорную информацию из текста ниже. Не удаляй ничего лишнего. Не добавляй ничего, только информация из текста. Выведи только конечный результат без отчета о результате.\n###Текст:\n{context}\n\n###Конечный результат:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/list'''
! colspan="2" |Получение списка шаблонов.
|-
| colspan="2" |
|{ "error": 0, "prompts": [

 {

 "id": "chat",

 "type": "chat",

 "isDefault": false,

 "name": "Чат",

 "prompt": "Ты спокойный вежливый консультант.[\n\n###История переписки:\n{history}]\n\n###Вопрос: {question}\n###Ответ:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

 ]

}
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/modify/{id}'''
! colspan="2" |Модификация шаблона. Позволяет заменить как все параметры, так и отдельные.
|-
| colspan="2" |
*'''data''' — json c измененными параметрами:
<code>{ "name": "новое имя" }</code>
*'''id''' — идентификатор вопроса
|В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.{"error": INT, "message": DESCRIPTION}
|}

====='''/ses: методы работы с роботом'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться к продовой версии - нужен постфикс "_prod", для бэкапа "_backup"
актуально для методов

- получения данных робота GET/ses/robot/get/{id}

- применение настроек робота GET/ses/robot/commit/{id}

- экспорт робота GET/ses/robot/export/{id}

- список скриптов GET/ses/robot/script/list/{robot}

- получение скрипта GET/ses/robot/script/get/{robot}/{id}

- список ЭД GET/ses/robot/data/list/{robot}

- получение ЭД GET/ses/robot/data/get/{robot}/{id}

- список КТ GET/ses/robot/endpoint/list/{robot}

- получение КТ GET/ses/robot/endpoint/get/{robot}/{id}

- метода ask (отладчика) POST/ses/ask/{robot_id}

- данные сессии (отладчика) GET/ses/session/{robot_id}/{session_id}
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/audio/{uuid}'''
! colspan="2" style="width: 85%" |Получение аудио-файла из архива диалогов
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |аудио-файл с расширением opus
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/dialog/{uuid}'''
! colspan="2" style="width: 85%" |Получение диалога из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |{ "error": 0, "message": "success",

 "dialog": [{"id": "...", "robot": "...", "channel": "...",

 "unknown": true/false, "closed": true/false, "endpoint": "...",

 "answered": true/false, "models": [...], "variables": {}, "current": {

 "id": "...", "qas": "", "category": "...", "entry": [...],

 "nearest": "...", "missingRunData": [...], "waitingRunData": "...",

 "answered": true/false, "lastreply": "..."},

 "request": {"datetime": "...", "message": "", "data": [...]},

 "reply": {"answers": [{"messages": [...], "voice": "...",

 "interruptible": true/false, "file": null}],

<nowiki> "datetime": "...", "answered": true/false}}]}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/list'''
! colspan="2" style="width: 85%" |Получение списка диалогов из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
*'''startdate''' - начало временного интервала в формате date %Y-%m-%d %H:%M
*'''enddate''' - конец временного интервала в формате date %Y-%m-%d %H:%M
*'''phone''' - номер телефона
*'''variable''' - переменная в формате variable=value
*'''robot''' - идентификатор робота (id)
*'''text''' - фрагмент текста в любом сообщении
*'''data''' - id элемента данных
*'''channel''' - название канала (коннектора)
| style="width: 50%" |[{"uuid": "...", "datetime": "...","phone": "", "channel": [...], "robot": ["..."]}]
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/waveform/{uuid}'''
! colspan="2" style="width: 85%" |Служебный метод для визуализации полученного из архива диалогов аудио-файла, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |[0.016,

0.015,

0.01]
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст запроса

*'''channel''' - id канала

*'''connector''' - имя коннектора

*'''session''' - uuid сессии, если это не первый запрос в сессии

*'''tts''' - вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' - словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''handler''' - python скрипт для изменения ответов метода под требования внешних систем, подробнее в следующем разделе. в поле имя файла без расширения.

*'''restartClosed''' - перезагрузить сессию при её закрытии с новым id (1 - перезагрузить, 0 - не перезагружать)

*'''audio''' - аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''document''' - документ для последующей обработки

*'''robot_id''' - id робота

*'''endpoint''' - id точки, в которую передать управление диалогом (необязательный параметр, используется для исходящих оповещений)
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="2" style="width: 85%" |Создание нового робота. На выходе id созданного робота или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя нового робота
| style="width: 50%" |{ "error": 0, "id": "2fd2f909-2069-4b20-a725-3a598c83f886"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/apply/{id}'''
! colspan="2" style="width: 85%" | Применение робота. Переводит черновик робота в статус prod. Если до этого был prod вариант — становится backup.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/cleardraft/{id}'''
! colspan="2" style="width: 85%" |Обнуление черновика рабочей версией робота

|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": { "id": "id ЭД", "name": "Имя ЭД", "comment": "",

 "type": "...", "rtype": "report", "model": "Имя модели",

 "param": "Ответ", "script": "", "weight": 3,

 "slaveData": [], "getOnlyAsNearest": true/false,

 "injectToMessage": true/false, "longWaiting": true/false,

 "dataWaiting": [], "actions": { "alone": {

<nowiki> "default": [{"action": "say", "type": "random", "text": ["....."]}]}},</nowiki>

<nowiki> "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[ { "id": "3ebfe38b-95bf-4927-a662-17f6e5da22ea",
 "name": "pve", "type": "smc", "rtype": "report",

 "weight": 3, "hasNearestAction": false } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение элемента данных. Формат '''data''' как на выходе метода '''GET/ses/robot/data/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
*'''id''' — идентификатор элемента данных
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление всех версий робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/add/{robot}'''
! colspan="2" style="width: 85%" | Создание конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами конечной точки

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "id": "8576593b-b0d8-4b03-a623-74f3132356ea"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/endpoint/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление конечной точки.
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек конечной точки
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "data": { "id": "...", "name": "...", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка конечных точек робота
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[{ "error": 0, "data": { "id": "...", "name": "точка 1", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "....", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор элемента данных
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="2" style="width: 85%" |Выгрузка робота в архив
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |zip файл с именем = идентификатор робота
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/files/download/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''id''' - идентификатор файла
| style="width: 50%" |файл
|-
! style="color:green;width: 15%" |'''POST/ses/robot/files/upload/{robot}'''
! colspan="2" style="width: 85%" |Отправка файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''file''' - файл
| style="width: 50%" |{"error": 0, "message": "success", "id": "Id файла"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="2" style="width: 85%" | Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": {

 "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78",

 "name": "test", "description": "", "voice": "",

 "session": { "lifetime": 600 },

 "models": {}, "servicedata": {},

 "exceptions": {}, "actions": {},

 "holidays": [], "timeintervals": {

 "name": { "weekdays": [ 1, 2, 3, 4, 5, 6, 7 ],

 "dates": [ 0, 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],

"months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],

<nowiki>"days": "all", "intervals": [ [ 0, 1440 ] ] }}}}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="2" style="width: 85%" |Загрузка архива робота в черновик существующего робота
|-
| colspan="2" style="width: 50%" |
*'''zip —''' файл с архивом робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="2" style="width: 85%" |Получение списка роботов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ { "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78", "name": "test",

 "hasProd": true,

 "hasBackup": true } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение основных настроек робота. Формат '''data''' как в ответе метода '''GET/ses/robot/get/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с новыми настройками робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление нового скрипта. Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/script/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление скрипта
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение текста скрипита
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "data": {

 "id": "6a9f91b6-9634-4079-ac2b-60a944922c61",

"type": "Тип скрипта",

 "name": "Наименование скрипта",

 "code": "Текст скрипта" }

}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка скриптов
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |[ { "id": "9b9d83b7-d5c3-49e6-9bd4-a123a9047939", "name": "наименование1",

 "type": "Тип скрипта"},

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2",

 "type": "Тип скрипта"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение скрипта.Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/test/{robot}/{id}'''
! colspan="2" style="width: 85%" |Тестирование скрипта. Формат '''data''' как в ответе метода '''GET/ses/session/{robot_id}/{session_id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка с параметрами сессии
*'''id''' - идентификатор скрипта
*'''robot''' - идентификатор робота
| style="width: 50%" |<nowiki>{"error": 0, "message": "success", "result": {.....}, "variables": {}}</nowiki>
|-
! style="color:blue;width: 15%" |'''POST/ses/robot/userdata/data/add/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление записи в пользовательский справочник.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "id": "id записи"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/data/delete/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Удаление записи из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/data/list/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Получение данных из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |[{ "колонка 1": "значение 1", "колонка n": "значение n", "id": "id записи"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}'''
! colspan="2" style="width: 85%" | Массовое изменение данных в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Изменение одной записи пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/put/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление данных с заменой в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code> Поле "id" опционально, при его добавлении данные в строке будут заменены.
*'''replace''' - замена всех данных в справочнике новыми данными. Возможные значения: yes/no. По-умолчанию - yes.
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"id": "id справочника", "name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code> Поле "id" опционально.
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |{"error": 0, "id": "id справочника"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/structure/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/structure/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка пользовательских справочников.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |<nowiki>[{"id": "id справочника", "name": "справочник", "fields": {"колонка1": "значение по умолчанию"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Модификация структуры пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code>
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="2" style="width: 85%" |Выдает параметры сессии. Для отображения на боковой панели тестирования в UPS. Основные блоки результата:
|-
| colspan="2" style="width: 50%" |
*'''robot_id''' — id робота

*'''session_id''' — id незакрытой сессии
| style="width: 50%" |{ "started": "", "modified": "",

 "robot": "",

 "session": "",

 "channel": "",

 "connector": "",

 "unknown": true/false,

 "current": {"id": "", "qas": "", "answered": true/false, "category": "",

 "nearest": "", "entry": [.....], "missingRunData": [],

 "passedRunData": [.....], "waitingRunData": null,

 "border": int, "preborder": int, "lastreply": ""},

 "models": [.....],

 "scripts": [.....],

<nowiki> "data": [{"request": {.....}, "reply": {.....}}],</nowiki>

 "timers": [],

 "variables": {},

 "error": "",

 "events": {.....},

 "closed": "" }
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/config'''
! colspan="3" style="width: 85%" |Выдает параметры виджета для web канала по запросу js скрипта
|-
| colspan="2" style="width: 50%" |
*'''token''' — уникальный код виджета, создается при внедрении
| colspan="2" style="width: 50%" |Состав конфига канала, для передачи виджету. Подробней в [https://wiki.connect2ai.net/index.php/SES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B0_%D0%B4%D0%BB%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%B0 Руководстве администратора]
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/js'''
! colspan="3" style="width: 85%" |Выдает код js скрипта виджета для web-канала
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |Код скрипта
|}

====='''/res: методы работы с сервисом отчетов'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/res/dashboards'''
! colspan="3" style="width: 85%" |Получить список рабочих столов kibana с наборами отчетов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |{ "error": 0, "message": "success",

 "dashboards": {

"Наименование1": "https://........",

<nowiki>"Наименование2": "https://........." }}</nowiki>
|}

====='''/transcription: методы работы со стенографией'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/transcription/audio/{id}'''
! colspan="3" style="width: 85%" | Получить аудиофайл по id стенограммы. Идентификатор нужной стенограммы можно получить методом
"GET /transcription/list"
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |wav файл сохраненной стенограммы
|-
! style="color:green;width: 15%" |'''POST/transcription/create'''
! colspan="3" style="width: 85%" |Создание стенограммы из завершенного задания в очереди распознавания. В ответ придет id созданной стенограммы
|-
| colspan="2" style="width: 50%" |
*'''taskID''' — идентификатор задания из очереди

*'''name''' — имя создаваемой стенограммы
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"id": "74721a3b-9055-4650-9afb-de4d103cafc7"}
|-
! style="color:red;width: 15%" |'''DELETE/transcription/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление стенограммы
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/get/{id}'''
! colspan="3" style="width: 85%" |Получение стенограммы. Используется для отображения стенограммы в веб интерфейсе
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |стенограмма в json формате
|-
! style="color:blue;width: 15%" |'''GET/transcription/list'''
! colspan="3" style="width: 85%" |Получение списка сохраненных стенограмм
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ { "id": "926e8d25-4275-4a78-906b-a1109cdacbea",

"name": "название",

"model": "big",

"created": "2024-03-29 12:37:42",

"modified": "2024-04-24 16:09:09",

"user": "0",

"dataset": "0" }, .... ]
|-
! style="color:green;width: 15%" |'''POST/transcription/save/{id}'''
! colspan="3" style="width: 85%" |Сохранение стенограмы. Используется для сохранения изменений по нажатию кнопки «Сохранить».
|-
| colspan="2" style="width: 50%" |
*'''data''' — стенограмма в json формате

*'''id''' стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/waveform/{id}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, ответ содержит пики сигнала
|-
| colspan="2" style="width: 50%" |
*'''id''' стенограммы
| colspan="2" style="width: 50%" |{ "error": 0,

"waveform": [

 0.016,

 ..........

 ..........

 0.015,

 0.01 ] }
|}

SEE. Руководство пользователя

2026-01-12T10:30:30Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) — сервис извлечения именованных сущностей.

Модель — предварительно подготовленная специализированная модель распознавания и извлечения именованных сущностей из коротких фраз.

Именованная сущность — слово или словосочетание, выделяющее определенный предмет или явление из ряда однотипных предметов или явлений. Например, это названия городов, стран, валют, имен.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SEE.

===== '''Описание методов API SEE''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SEE. По умолчанию используется порт 6184/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса SEE представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6184 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:green;width: 15%" |'''POST/see/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели
|-
| colspan="2" style="width: 50%" |
*'''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:red;width: 15%" |'''DELETE/see/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Возвращает zip-файл с моделью.
|-
! style="color:green;width: 15%" |'''POST/see/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Метод асинхронный. Окончание работы проверяется через метод /see/info/{id}.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели;
* '''zip-model''' — zip-архив с файлами модели;
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/entities/{id}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* id — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |<code>{</code> <code>ID-модели: [</code>

<code>{</code>

<code>position: 0, # позиция слова начала фрагмента, определяющего сущность</code>

<code>confidence: 1, #вероятность правильного определения сущности</code>

<code>text: текст сущности,</code>

<code>calculated: vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели</code>

<code>}, {...}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели. В случае, если производилось тестирование модели, то файл содержит ошибки тестирования. Если не производилось — ошибки после обучения.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:red;width: 15%" |'''DELETE/see/handler/{id}'''
! colspan="3" style="width: 85%" |Удаление постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/handler/{id}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Файл handler.py
|-
! style="color:green;width: 15%" |'''POST/see/handler/{id}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |
* id — идентификатор
* status — статус
* classes — список сущностей в модели
* entityMaxWords — максимальная длина сущности в корпусе обучения
* sequenceLength — максимальная длина последовательности при обучении
* noiseLevel — уровень шума, использованный при обучении модели
* trainCorpusName — название файла, использованного при обучении
* trainAccuracy — точность обучения и тестирования
* testCorpusLength — размер тестового корпуса
* trainCorpusLength — размер обучающего корпуса
* trainConfusionMatrix — матрица ошибок обучения
* testConfusionMatrix — матрица ошибок тестирования.
|-
! style="color:blue;width: 15%" |'''GET/see/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{</code>

<code> "log": [</code>

<code> "training",</code>

<code> "macroEpoch: 1, microEpoch: 1 loss: 1.23790...",</code>

<code> ...</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:green;width: 15%" |'''POST/see/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/see/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''noise''' - уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 2.
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|}
</onlyinclude>

===== '''Постобработка''' =====

Модель может содержать '''постобработчик'''. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /see/entities/{id}.

Пример пустой функции, которая просто повторяет на выходе результат:

<code>def handler(entities=[],text=""):</code>

<code> returns entities</code>

На вход подается результат работы модели, а также начальный текст.

SEE. Руководство пользователя

2026-01-12T10:29:33Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) — сервис извлечения именованных сущностей.

Модель — предварительно подготовленная специализированная модель распознавания и извлечения именованных сущностей из коротких фраз.

Именованная сущность — слово или словосочетание, выделяющее определенный предмет или явление из ряда однотипных предметов или явлений. Например, это названия городов, стран, валют, имен.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SEE.

===== '''Описание методов API SEE''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SEE. По умолчанию используется порт 6184/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса SEE представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6184 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:green;width: 15%" |'''POST/see/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели
|-
| colspan="2" style="width: 50%" |
*'''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:red;width: 15%" |'''DELETE/see/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Возвращает zip-файл с моделью.
|-
! style="color:green;width: 15%" |'''POST/see/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Метод асинхронный. Окончание работы проверяется через метод /see/info/{id}.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели;
* '''zip-model''' — zip-архив с файлами модели;
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/entities/{id}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* id — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |<code>{</code> <code>ID-модели: [</code>

<code>{</code>

<code>position: 0, # позиция слова начала фрагмента, определяющего сущность</code>

<code>confidence: 1, #вероятность правильного определения сущности</code>

<code>text: текст сущности,</code>

<code>calculated: vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели</code>

<code>}, {...}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели. В случае, если производилось тестирование модели, то файл содержит ошибки тестирования. Если не производилось — ошибки после обучения.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:red;width: 15%" |'''DELETE/see/handler/{id}'''
! colspan="3" style="width: 85%" |Удаление постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/handler/{id}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Файл handler.py
|-
! style="color:green;width: 15%" |'''POST/see/handler/{id}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |
* id — идентификатор
* status — статус
* classes — список сущностей в модели
* entityMaxWords — максимальная длина сущности в корпусе обучения
* sequenceLength — максимальная длина последовательности при обучении
* noiseLevel — уровень шума, использованный при обучении модели
* trainCorpusName — название файла, использованного при обучении
* trainAccuracy — точность обучения и тестирования
* testCorpusLength — размер тестового корпуса
* trainCorpusLength — размер обучающего корпуса
* trainConfusionMatrix — матрица ошибок обучения
* testConfusionMatrix — матрица ошибок тестирования.
|-
! style="color:blue;width: 15%" |'''GET/see/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{</code>

<code> "log": [</code>

<code> "training",</code>

<code> "macroEpoch: 1, microEpoch: 1 loss: 1.23790...",</code>

<code> ...</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:green;width: 15%" |'''POST/see/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/see/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''noise''' - уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 2.
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|}

===== '''Постобработка''' =====

Модель может содержать '''постобработчик'''. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /see/entities/{id}.

Пример пустой функции, которая просто повторяет на выходе результат:

<code>def handler(entities=[],text=""):</code>

<code> returns entities</code>

На вход подается результат работы модели, а также начальный текст.

SEE. Руководство пользователя

2026-01-12T10:24:39Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) — сервис извлечения именованных сущностей.

Модель — предварительно подготовленная специализированная модель распознавания и извлечения именованных сущностей из коротких фраз.

Именованная сущность — слово или словосочетание, выделяющее определенный предмет или явление из ряда однотипных предметов или явлений. Например, это названия городов, стран, валют, имен.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SEE.

===== '''Описание методов API SEE''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SEE. По умолчанию используется порт 6184/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса SEE представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6184 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:red;width: 15%" |'''DELETE/see/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Возвращает zip-файл с моделью.
|-
! style="color:green;width: 15%" |'''POST/see/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Метод асинхронный. Окончание работы проверяется через метод /see/info/{id}.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели;
* '''zip-model''' — zip-архив с файлами модели;
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/entities/{id}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* id — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |<code>{</code> <code>ID-модели: [</code>

<code>{</code>

<code>position: 0, # позиция слова начала фрагмента, определяющего сущность</code>

<code>confidence: 1, #вероятность правильного определения сущности</code>

<code>text: текст сущности,</code>

<code>calculated: vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели</code>

<code>}, {...}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели. В случае, если производилось тестирование модели, то файл содержит ошибки тестирования. Если не производилось — ошибки после обучения.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:red;width: 15%" |'''DELETE/see/handler/{id}'''
! colspan="3" style="width: 85%" |Удаление постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/handler/{id}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Файл handler.py
|-
! style="color:green;width: 15%" |'''POST/see/handler/{id}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |
* id — идентификатор
* status — статус
* classes — список сущностей в модели
* entityMaxWords — максимальная длина сущности в корпусе обучения
* sequenceLength — максимальная длина последовательности при обучении
* noiseLevel — уровень шума, использованный при обучении модели
* trainCorpusName — название файла, использованного при обучении
* trainAccuracy — точность обучения и тестирования
* testCorpusLength — размер тестового корпуса
* trainCorpusLength — размер обучающего корпуса
* trainConfusionMatrix — матрица ошибок обучения
* testConfusionMatrix — матрица ошибок тестирования.
|-
! style="color:blue;width: 15%" |'''GET/see/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{</code>

<code> "log": [</code>

<code> "training",</code>

<code> "macroEpoch: 1, microEpoch: 1 loss: 1.23790...",</code>

<code> ...</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|}

===== '''Постобработка''' =====

Модель может содержать '''постобработчик'''. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /see/entities/{id}.

Пример пустой функции, которая просто повторяет на выходе результат:

<code>def handler(entities=[],text=""):</code>

<code> returns entities</code>

На вход подается результат работы модели, а также начальный текст.

SEE. Руководство пользователя

2026-01-12T10:23:09Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) — сервис извлечения именованных сущностей.

Модель — предварительно подготовленная специализированная модель распознавания и извлечения именованных сущностей из коротких фраз.

Именованная сущность — слово или словосочетание, выделяющее определенный предмет или явление из ряда однотипных предметов или явлений. Например, это названия городов, стран, валют, имен.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SEE.

===== '''Описание методов API SEE''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SEE. По умолчанию используется порт 6184/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса SEE представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6184 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/see/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:red;width: 15%" |'''DELETE/see/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Возвращает zip-файл с моделью.
|-
! style="color:green;width: 15%" |'''POST/see/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Метод асинхронный. Окончание работы проверяется через метод /see/info/{id}.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели;
* '''zip-model''' — zip-архив с файлами модели;
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/entities/{id}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* id — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |<code>{</code> <code>ID-модели: [</code>

<code>{</code>

<code>position: 0, # позиция слова начала фрагмента, определяющего сущность</code>

<code>confidence: 1, #вероятность правильного определения сущности</code>

<code>text: текст сущности,</code>

<code>calculated: vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели</code>

<code>}, {...}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели. В случае, если производилось тестирование модели, то файл содержит ошибки тестирования. Если не производилось — ошибки после обучения.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:red;width: 15%" |'''DELETE/see/handler/{id}'''
! colspan="3" style="width: 85%" |Удаление постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/handler/{id}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Файл handler.py
|-
! style="color:green;width: 15%" |'''POST/see/handler/{id}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |
* id — идентификатор
* status — статус
* classes — список сущностей в модели
* entityMaxWords — максимальная длина сущности в корпусе обучения
* sequenceLength — максимальная длина последовательности при обучении
* noiseLevel — уровень шума, использованный при обучении модели
* trainCorpusName — название файла, использованного при обучении
* trainAccuracy — точность обучения и тестирования
* testCorpusLength — размер тестового корпуса
* trainCorpusLength — размер обучающего корпуса
* trainConfusionMatrix — матрица ошибок обучения
* testConfusionMatrix — матрица ошибок тестирования.
|-
! style="color:blue;width: 15%" |'''GET/see/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{</code>

<code> "log": [</code>

<code> "training",</code>

<code> "macroEpoch: 1, microEpoch: 1 loss: 1.23790...",</code>

<code> ...</code>

<code> ]</code>

<code>}</code>
|}

===== '''Постобработка''' =====

Модель может содержать '''постобработчик'''. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /see/entities/{id}.

Пример пустой функции, которая просто повторяет на выходе результат:

<code>def handler(entities=[],text=""):</code>

<code> returns entities</code>

На вход подается результат работы модели, а также начальный текст.

SEE. Руководство пользователя

2026-01-12T10:09:32Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor предназначен для извлечения именованных сущностей из текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) — сервис извлечения именованных сущностей.

Модель — предварительно подготовленная специализированная модель распознавания и извлечения именованных сущностей из коротких фраз.

Именованная сущность — слово или словосочетание, выделяющее определенный предмет или явление из ряда однотипных предметов или явлений. Например, это названия городов, стран, валют, имен.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SEE.

===== '''Описание методов API SEE''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SEE. По умолчанию используется порт 6184/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса SEE представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6184 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/see/'''
! colspan="3" style="width: 85%" |Вывод списка моделей.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/confusion/{id}/{type}'''
! colspan="3" style="width: 85%" |Получение изображения матрицы ошибок.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели
* '''type''' — тип данных для построения матрицы.
| colspan="2" style="width: 50%" |Возвращает PNG-изображение с матрицей ошибок.
|-
! style="color:red;width: 15%" |'''DELETE/see/data/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/data/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Возвращает zip-файл с моделью.
|-
! style="color:green;width: 15%" |'''POST/see/data/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Метод асинхронный. Окончание работы проверяется через метод /see/info/{id}.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели;
* '''zip-model''' — zip-архив с файлами модели; или
* '''from-existing-model''' — название модели, которое должно быть переименовано в id; или
* '''csv''' — текстовый файл для обучения модели, со строками СУЩНОСТЬ<TAB>ФРАЗА;
* '''noise''' — уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 2.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/entities/{id}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* id — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |<code>{</code> <code>ID-модели: [</code>

<code>{</code>

<code>position: 0, # позиция слова начала фрагмента, определяющего сущность</code>

<code>confidence: 1, #вероятность правильного определения сущности</code>

<code>text: текст сущности,</code>

<code>calculated: vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели</code>

<code>}, {...}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/see/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели. В случае, если производилось тестирование модели, то файл содержит ошибки тестирования. Если не производилось — ошибки после обучения.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:red;width: 15%" |'''DELETE/see/handler/{id}'''
! colspan="3" style="width: 85%" |Удаление постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/handler/{id}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Файл handler.py
|-
! style="color:green;width: 15%" |'''POST/see/handler/{id}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/see/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |
* id — идентификатор
* status — статус
* classes — список сущностей в модели
* entityMaxWords — максимальная длина сущности в корпусе обучения
* sequenceLength — максимальная длина последовательности при обучении
* noiseLevel — уровень шума, использованный при обучении модели
* trainCorpusName — название файла, использованного при обучении
* trainAccuracy — точность обучения и тестирования
* testCorpusLength — размер тестового корпуса
* trainCorpusLength — размер обучающего корпуса
* trainConfusionMatrix — матрица ошибок обучения
* testConfusionMatrix — матрица ошибок тестирования.
|-
! style="color:blue;width: 15%" |'''GET/see/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор модели.
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{</code>

<code> "log": [</code>

<code> "training",</code>

<code> "macroEpoch: 1, microEpoch: 1 loss: 1.23790...",</code>

<code> ...</code>

<code> ]</code>

<code>}</code>
|}

===== '''Постобработка''' =====

Модель может содержать '''постобработчик'''. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /see/entities/{id}.

Пример пустой функции, которая просто повторяет на выходе результат:

<code>def handler(entities=[],text=""):</code>

<code> returns entities</code>

На вход подается результат работы модели, а также начальный текст.

SEE. Руководство администратора

2026-01-12T10:08:07Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Simple Entity Extractor (SEE) предназначен для выделения смысловых сущностей из текста. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Entity Extractor (SEE) – сервис выделения сущностей.

===== '''Системные требования''' =====
Для нормальной работы сервиса на каждые 100 одновременных запросов классификации необходимо обеспечить 1 CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее.

Оперативной памяти необходимо не менее 4Gb.

===== '''Установка/обновление сервиса''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/see&fileid=581 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].
* Установка/обновление SEE осуществляется скриптом <code>chmod +x ./see-<версия>-<релиз>.sh && ./see-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./see-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/see</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SEE <code>/opt/see/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/see/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/see/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/see/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/see/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/see/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/see/.proxy (это файл конфигурации proxy необходим для обновления, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable see.service && sudo systemctl start see.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status see.service</code>

Разрешите доступ к порту 6184 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/see/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "see", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start see</code> и извлечь UUID, указанный в файле <code>/opt/see/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Предустановленные модели''' =====
В состоянии поставки SEE содержит специализированные модели. Предустановленные модели расположены в каталоге /opt/see/pretrained/. Одна из моделей — «fio» для выделения фамилий, имен, отчеств из текста. Для этой модели возможно создать пользовательский словарь на случай, если модель не смогла определить правильно ФИО. Пользовательские словари нужно располагать в папке /opt/see/pretrained/fio/custom (surnames.txt - фамилии, firstname.txt - имена, lastnames.txt - отчества, в именительном падеже).

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса see производится в файле /opt/see/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/see/"
|-
|logs.backups
|10
|Количество файлов ротации
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|stricts
|[ "не" ]
|«Строгие частицы» — частицы речи, меняющие смысл фразы. После применения настройки, если сущность содержит такую частицу, то фраза без этой частицы не вызовет положительного срабатывания.
|-
|smc.url
|"<nowiki>http://127.0.0.1:6181</nowiki>"
|Адрес по которому доступен smc с моделью [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%BD%D1%8B%D1%85_%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B5%D0%B9_SMC коррекции]
|-
|smc.conn_timeout
|2
|Таймаут подключения к smc
|-
|smc.read_timeout
|30
|Таймаут ответа от smc
|-
|cluster.logfile
|logs/sync.log
|путь к логу синхронизации ноды кластера
|-
|cluster.statusFile
|logs/sync.status
|путь к файлу статуса ноды кластера
|-
|cluster.nodes
|[]
|список IP адресов нод кластера
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/see/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/see/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

SMC. Руководство пользователя

2026-01-12T10:01:56Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short Message Classifier предназначен для классификации текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Message Classifier (SMC) - сервис классификации текстовых фрагментов.

Модель — предварительно обученная специализированная нейронная сеть классификации коротких фраз.

Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SMC.

===== '''Описание методов API SMC''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SMC. По умолчанию используется порт 6181/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6181</nowiki> будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+

! style="color:blue;width: 15%" |'''GET/smc/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей. Выводит только пользовательские модели. Сервисные модели, корпуса, наборы меток не выводит.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/list'''
! colspan="3" style="width: 85%" |Список заданий на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "tasks": [</code>

<code> {</code>

<code> "id": "id-1",</code>

<code> "taskname": "name1",</code>

<code> "status": "finished"</code>

<code> },</code>

<code> {</code>

<code> "id": "id-nnnn",</code>

<code> "taskname": "name2",</code>

<code> "status": "finished"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/result/{id}'''
! colspan="3" style="width: 85%" |Получить результат задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "started": "2024-10-09 18:05:51",</code>

<code> "finished": "2024-10-09 18:05:51",</code>

<code> "corpus": [[ [], [ ["тэг"],"фраза 1"]],</code>

<code> [ [], [["тэг"],"фраза 2"]] ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''taskname''' - произвольное имя задания

*'''corpus''' - json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

*'''marks''' - json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

*'''appendMarks''' - "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "id": "уникальный id задания"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": "",</code>

<code> "status": "finished",</code>

<code> "started": "2024-10-09 13:49:46",</code>

<code> "finished": "2024-10-09 13:49:46",</code>

<code> "progress": 0</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "success"</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/classify/{id}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случает если модель была создана из меток в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

*'''classes''' - список , для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.

*'''groups''' - название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т.е. чем полнее группа, тем выше ее позиция в списке).

*'''nearest''' - отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели

*'''text''' - текст, подлежащий классификации
*'''correction''' - проверять правописание слов и исправлять ошибки

*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |<code>{</code>
<code> "classes": [</code>

<code> {</code>

<code> "class": "название класса",</code>

<code> "confidence": 1</code>

<code> },</code>

<code> {</code>

<code> "class": "название класса 2",</code>

<code> "confidence": 1</code>

<code> }</code>

<code> ],</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "название группы 1",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "название класса", "название класса 2" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "название группы 2",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 1"</code>

<code> },</code>

<code> {</code>

<code> "group": ""название группы 3",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 2"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.

|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для сжатия

*'''threshold''' - уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |<code>{</code>

<code> "text": "сжатый текст"</code>

<code>}</code>

|-
! style="color:green;width: 15%" |'''POST/smc/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели

|-
| colspan="2" style="width: 50%" |
* '''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> { error: INT, message: DESCRIPTION }</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернет текст неизменным.

|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> "text": "корректный текст"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |ZIP-файл с моделью, либо { error: 1, message: DESCRIPTION }
|-
! style="color:red;width: 15%" |'''DELETE/smc/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''zip-model''' - zip-архив с файлами модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/embedding'''
! colspan="3" style="width: 85%" |
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза
| colspan="2" style="width: 50%" | <code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов ''positive negative neutral.''
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза для анализа эмоций
| colspan="2" style="width: 50%" |<code>{ "emotion": "positive", "score": 0.9601 }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' - идентификатор модели
*'''type''' - тип ошибок, возможные варианты:
'''train''' - ошибки обучения

'''test''' - ошибки тестирования

'''mark''' - ошибки создания модели из меток
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:blue;width: 15%" |'''GET/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат - группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''classes''' — набор меток через запятую
| colspan="2" style="width: 50%" |Результат в виде json.<code>{</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "Группа 1",</code>

<code> "intersection": 3,</code>

<code> "classes": [ "метка1_о", "метка2_о", "метка3_о"]</code>

<code> },</code>

<code> {</code>

<code> "group": "Группа 2",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "метка1_о", "метка5_о" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "Группа до которой не хватило 1 метки",</code>

<code> "percent": 0.75,</code>

<code> "need": "недостающая метка_о"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
*'''groups''' - JSON с новыми группами

* '''csv-file''' - файл с группами
| colspan="2" style="width: 50%" |<code>{ "error": 0,</code><code>"message": "string"</code> <code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Получает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Файл программы обработчика на python
|-
! style="color:red;width: 15%" |'''DELETE/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Удаляет [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Устанавливает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели

*'''handler''' - файл постобработчика
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |На выходе будут следующие параметры:
'''id''' - идентификатор

'''status''' - статус

'''classes''' - список классов в модели

'''groups''' - список групп в модели

'''trainCorpusName''', '''testCorpusName''' - названия файлов, использованных при обучении и тестировании

'''trainAccuracy''', '''testAccuracy''' - точность обучения и тестирования

'''initCorpusLength''' - начальный размер корпуса обучения

'''trainCorpusLength''' - размер корпуса после нормализации и синтеза данных

'''testCorpusLength''' - размер тестового корпуса

'''trainConfusionMatrix''' - матрица ошибок обучения

'''testConfusionMatrix''' - матрица ошибок тестирования
|-
! style="color:blue;width: 15%" |'''GET/smc/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{ </code>

<code>"log": [</code>

<code> "training",</code>

<code> "normalization: 5, model size: 2",</code>

<code> ...</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу -> 25 апреля в 5-м часу
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{"text": "<строка после обратной нормализации>"}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{ "text": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/search'''
! colspan="3" style="width: 85%" |Семантический поиск фразы в тексте.
|-
| colspan="2" style="width: 50%" |
*'''phrase''' - искомая фраза

*'''text''' - текст в котором нужно найти фразу
| colspan="2" style="width: 50%" |<code>{</code> <code>"error": 0,</code>

<code> "message": "success",</code>

<code> "similarity": 1,</code>

<code> "fragment": "найденная фраза"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/test/{id}'''
! colspan="3" style="width: 85%" | Тестирование модели. Тестируется заранее подготовленным текстовым файлом со строками вида: КЛАСС<TAB>ФРАЗА

Метод асинхронный. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - файл для тестирования
*'''correction''' - исправлять ошибки правописания в файле для тестирования ('''0''' или '''1''')
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
*'''text''' - текстовая строка с высказыванием
| colspan="2" style="width: 50%" |<code>{</code> <code>"insult": 0.13, # оскорбление</code>

<code> "obscenity": 0, # брань</code>

<code> "threat": 0, # угрозы</code>

<code> "politeness": 0.53 вежливость</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''isMarks''' - если "1" то вместо csv файла корпуса метод ожидает json файл с меткам, формат файла csv-file:{"id": "уникальный идентификатор", "name": "имя набора", "data": [ ["метка1",["синоним1", "еще несколько синонимов через запятую"],порог достоверности], ["еще метка",["синоним", "еще несколько синонимов через запятую"],порог достоверности]]} модель созданная из меток при этом не обучается, созданный файл модели используется для расчетов векторов "на лету" и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|}
</onlyinclude>

===== '''Постобработка''' =====
Модель может содержать постобработчик. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /smc/classify/{id}.

Пример пустой функции:

<code>def handler(classes=[],text=""):</code>

<code> returns classes</code>

На вход подается результат работы модели, а также начальный текст.

UPS. Описание API

2026-01-12T10:00:37Z

KorolkovS:

===== '''Описание часто используемых параметров''' =====
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
|-
|'''servicetype'''
|запрос
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts.
|-
|'''servertype'''
|запрос
|Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы).
|-
|'''model'''
|запрос
|Название модели.
|-
|'''modeltype'''
|запрос
|Тип модели. Возможные значения: '''future''' — планируемая/черновик, '''current''' — текущая/рабочая, '''previous''' — архивная.
|-
|'''error'''
|ответ
|Флаг ошибки.
|-
|'''message'''
|ответ
|Информационное сообщение.
|}

===== '''"/external modules" методы внешних модулей''' =====

В этом разделе будут методы соответствующим образом оформленных [[UPS. Руководство администратора#Установка модулей для UPS|внешних модулей]]

===== '''/auth: методы авторизации''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/auth/access'''
! colspan="3" style="width: 85%" |Получение токенов доступа. Токен доступа определяет, какие из методов будут доступны конкретному пользователю. Формируется на основании роли. Дополнительный входной параметр во всех методах, кроме перечисленных в разделе «nopassword» конфигурационного файла. Время действия токена определяется параметром auth.accessLifeTime конфигурационного файла.
|-
|colspan="2" style="width: 50%" |
* '''username''' — логин

* '''password''' — пароль
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/add'''
! colspan="3" style="width: 85%" |Добавление dataset (набора данных). Dataset (набор данных) используется для ограничения доступа к данным. В ответе метод вернет id созданного набора данных.
|-
|colspan="2" style="width: 50%" |
* data — json строка вида: { "name": "название нового набора" }
|colspan="2" style="width: 50%" |{

"error": 0

"message": "success",

"dataset_id": "XXXXXXXXXXXXX"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/dataset/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление dataset (набора данных).
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/modify/{id}'''
! colspan="3" style="width: 85%" |Переименование dataset (набора данных). Метод меняет все параметры набора данных, но на данный момент времени у набора данных, кроме id, только один параметр — наименование.
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
* '''data''' — JSON c новыми параметрами
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/datasets'''
! colspan="3" style="width: 85%" |Получение списка наборов данных.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXXXXXXXXXX",

"name": "XXX"},

{"id": "0",

"name": "По умолчанию"}

]
|-
!style="color:blue;width: 15%" |'''GET/auth/refresh'''
! colspan="3" style="width: 85%" |Обновление токенов доступа. Время, в течение которого можно обновить доступ, регулируется параметром auth.refreshLifeTime конфигурационного файла. Служебный метод, используется в основном в веб-интерфейсе, чтобы не запрашивать лишний раз пароль.
|-
|colspan="2" style="width: 50%" |
* '''x-refresh-token''' — токен обновления доступа
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/rights'''
! colspan="3" style="width: 85%" |Получение списка прав доступа. Служебный метод — по токену получает название роли и все права доступа этой роли, а также общедоступные методы.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |<<<{ "РОЛЬ": [

 "GET:/......" ],

 "nopassword": [ "GET:/.......",

...............

<<<...............

 "POST:/......." ] }
|-
!style="color:green;width: 15%" |'''POST/auth/role/add'''
! colspan="3" style="width: 85%" |Создание роли. Служебный метод — используется веб-интерфейсом при создании роли.
|-
|colspan="2" style="width: 50%" |
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{

"error": 0, "message": "success", "role_id": "a7e68bb83169f864c2fc868401b5250c"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/role/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление роли.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/role/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение роли. Параметры как при создании роли. Роль будет переписана.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/roles'''
! colspan="3" style="width: 85%" |Получение списка ролей.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[{

"id": "XXXXXXXXXXX",

"name": "имя роли",

"rights": [ "набор прав через запятую" ]

},............]
|-
!style="color:green;width: 15%" |'''POST/auth/user/add'''
! colspan="3" style="width: 85%" |Создание нового пользователя. Метод вернет или id нового пользователя или описание ошибки
|-
|colspan="2" style="width: 50%" |
* '''data''' — json строка {

"username": "login_name", "fullname": "Отображаемое Имя","password": "XXXXX","role": "role_id",

"dataset": "default dataset id", "datasets": [ "dataset id", ................. ] }
|colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"user_id": "XXXXXXXXXXXXXXXX"}
|-
!style="color:red;width: 15%" |'''DELETE/auth/user/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' - идентификатор пользователя
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/user/get/{id}'''
! colspan="3" style="width: 85%" |Получение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2" ] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/info'''
! colspan="3" style="width: 85%" |Получение параметров пользователя по его токену доступа. Служебный метод - для предоставления прав текущему пользователю по его токену
|-
|colspan="2" style="width: 50%" |
* '''x-access-token'''
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/list'''
! colspan="3" style="width: 85%" |Получение списка пользователей с их параметрами. Тоже самое что и в методе GET /auth/user/info, только для всех пользователей
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] },

......

]
|-
!style="color:green;width: 15%" |'''POST/auth/user/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''data''' — параметры пользователя как при создании
* '''id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{ "error": 0,

"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/user/password'''
! colspan="3" style="width: 85%" |Смена пароля пользователя по его токену доступа.
|-
|colspan="2" style="width: 50%" |
* '''password'''
|colspan="2" style="width: 50%" |{ "error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/userlog'''
! colspan="3" style="width: 85%" |Получение действий пользователя за период времени по его токену
|-
|colspan="2" style="width: 50%" |
* '''from''' — начало периода в формате "%Y-%m-%d %H:%M"

* '''to''' — конец периода в формате "%Y-%m-%d %H:%M"
|colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "data": [

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 .........

}
|-
!style="color:blue;width: 15%" |'''GET/auth/version'''
! colspan="3" style="width: 85%" |Получение версии сервиса ups
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |{

 "version": "4.082 release"

}
|}

===== '''/lang: методы мультиязычности''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/lang/'''
! colspan="3" style="width: 85%" |Выводит информацию о переводе элементов интерфейса на текущий язык
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "see":"Сущности",

"smc":"Классификатор",

... }
|-
!style="color:blue;width: 15%" |'''GET/lang/wallpaper'''
! colspan="3" style="width: 85%" |Отдает случайный фон рабочего стола в виде jpeg из каталога «wallpapers» на сервере ups
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |image/jpeg
|}

===== '''/server: получение информации о серверах''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |GET/server/get/addresses/{servicetype}
! colspan="3" style="width: 85%" |Вывод информации о серверах, обслуживающих данный сервис, а также настроенных параметров обращения к данным серверам.
'''trainer''' — сервер обучения, '''cluster''' — рабочие серверы, '''connect''' — время на подключение, '''read''' — время на ответ,

'''failed''' — время пребывания в сбойных, '''install''' — время на установку модели, '''info''' — время на получение информации о модели,

'''counter''' — счетчик запросов, '''current''' — индекс последнего опрошенного cluster-сервера

'''fail''' — массив сбойных серверов со временем постановки в сбой.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",

 "cluster": [ "<nowiki>http://127.0.0.1:6181</nowiki>" ],

 "timers": { "connect": 0.5,

 "read": 1,

 "failed": 600,

 "install": 60,

 "info": 3 },

 "counter": 0,

 "current": 0,

 "fail": {"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678} }
|-
!style="color:blue;width: 15%" |GET/server/get/models/{servicetype}/{servertype}
! colspan="3" style="width: 85%" |Вывод информации о моделях указанного сервиса на каждом сервере указанного типа. Вывод представляет собой массив URL-серверов, для каждого из которых указан список моделей.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса

* '''servertype''' — тип серверов
| colspan="2" style="width: 50%" |{ "<nowiki>http://127.0.0.1:6181</nowiki>": [

 "model1",

 ...

 "modelN"

 ], ... }
|}

===== '''/model: методы работы с моделями''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/model/add/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Создание пустой модели в указанном сервисе. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 30%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 70%" |{

"error":0,

"message":"success"

}
|-
!style="color:green;width: 15%" |'''POST/model/apply/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Применение установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:red;width: 15%" |'''DELETE/model/delete/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/errors/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Запрос на получение списка ошибок модели после тестирования/обучения. Доступен для сервисов see и smc. Ответ содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза).
|-
| colspan="2" style="width: 50%" |
* '''type''' — тип ошибок в выводе
'''- train''' ошибки обучения

'''- test''' ошибки тестирования

'''- mark''' ошибки авторазметки
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[ [true, predicted, phrase],

... ]
|-
!style="color:blue;width: 15%" |'''GET/model/export/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Экспорт модели, модель скачивается в виде zip-архива.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл model.zip, где model — название модели
|-
! style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Удаление постобработчика из модели типа future. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель типа future. Обработчик становится активным сразу после успешной отправки. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из модели типа future.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Удаление постобработчика в указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель указанного типа. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''modeltype''' — тип модели
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:green;width: 15%" |'''POST/model/import/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Импортирует модель в черновик (modeltype=future)
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''zip-model''' — zip с файлами модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}'''
! colspan="3" style="width: 85%" |Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "model1": {

 "previous": null,

 "current": null,

 "future": {

 "status": "empty",

 ...

 } }, ... }
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение информации о каждом типе (modeltype) указанной модели. Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{ "previous": null,

 "current": {

 "status": "trained",

 ... },

 "future": {

 "status": "trained",

 ... } }
|-
!style="color:green;width: 15%" |'''POST/model/install/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Установка импортированной или обученной модели на рабочих серверах.
Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/log/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: '''smc''', '''see'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[

 "training",

 "preparing data",

 "tokenizing",

 ...

]
|-
!style="color:green;width: 15%" |'''POST/model/restore/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так:
* '''current -> future'''
* '''previous -> current'''
* '''null -> previous'''
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|}

===== '''/corpus: работа с данными для обучения моделей''' =====
Методы данного класса предназначены только для сервисов smc и see

{| class="wikitable" style="width: 110%"
|+
!style="color: blue;width: 15%" |'''GET/corpus/automark/list'''
! colspan="3" style="width: 85%" |Перечень заданий автоматической маркировки корпусов.
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "tasks": [ {

 "id": "29d9da98-d6c1-4dc1-bbc9-111309816002",

 "taskname": "test_doc",

 "status": "finished" },

 { "id": "1a5e9bdc-9f98-49d2-84de-1a9bde8fc37c",

 "taskname": "sssss",

 "status": "finished" } ] }
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/result/{id}'''
! colspan="3" style="width: 85%" |Результат выполнения задания на автомаркировку корпуса. Если задание завершено в ответе придет маркированый корпус и время старта и финиша задания
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{
"error": 0,

"message": "success",

"started": "2024-10-09 18:05:51",

"finished": "2024-10-09 18:05:51",

"corpus": [[ [], [ ["тэг"],"фраза 1"]],

[ [], [["тэг"],"фраза 2"]] ]
}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''taskname''' — произвольное имя задания

* '''corpus''' — json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

* '''marks''' — json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

* '''appendMarks''' — "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "уникальный id задания"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — уникальный id задания
| colspan="2" style="width: 50%" |{

 "error": "",

 "status": "finished",

 "started": "2024-10-09 13:49:46",

 "finished": "2024-10-09 13:49:46",

 "progress": 0

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: green;width: 15%" |'''POST/corpus/copy/{servicetype}'''
! colspan="3" style="width: 85%" |Копирование корпуса данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: red;width: 15%" |'''DELETE/corpus/delete/{servicetype}'''
! colspan="3" style="width: 85%" |Удаляет корпус с данными
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: blue;width: 15%" |'''GET/corpus/export/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает текстовый файл с корпусом, содержащий строки вида КЛАСС<TAB>ФРАЗА
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |Файл name.txt
|-
!style="color: blue;width: 15%" |'''GET/corpus/get/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает JSON с данными корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |<code>[</code>
<code> [ "тэг",</code>

<code> "фраза"</code>

<code> ],</code>

<code> ...</code>

<code>]</code>
|-
!style="color: green;width: 15%" |'''POST/corpus/import/{servicetype}'''
! colspan="3" style="width: 85%" |Метод для импорта корпуса данных. Возможен как из текстового файла со строками вида КЛАСС<TAB>ФРАЗА (доступно для smc и see), так и из логов работы системы (только для smc). Если на вход поступил файл csv, происходит импорт из файла, в противном случае — из логов.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''csv''' — файл данных
* '''startDate''' — дата начала выборки, YYYY-MM-DD
* '''stopDate''' — дата окончания выборки, YYYY-MM-DD
* '''model''' — имя модели, из логов которой будет произведен импорт
* '''limit''' — числовое ограничение строк импорта
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/list/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает список всех корпусов данных для указанного типа сервиса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |[ "корпус1",

"корпус2",

 ...]
|-
!style="color: green;width: 15%" |'''POST/corpus/put/{servicetype}'''
! colspan="3" style="width: 85%" |Перезаписывает корпус отправленным массивом данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''json''' — строка формата json с данными. Аналогична выводу метода GET /get/{servicetype}
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: green;width: 15%" |'''POST/corpus/rename/{servicetype}'''
! colspan="3" style="width: 85%" |Переименование корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|}

===== '''/marks: работа с наборами меток в smc''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/marks/add'''
! colspan="3" style="width: 85%" |Добавление набора менток
|-
| colspan="2" style="width: 50%" |
* '''json''' —список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''name''' — имя создаваемого набора
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "132310fa-98c7-4b12-896f-ff113827d077"

}
|-
!style="color:red;width: 15%" |'''DELETE/marks/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление набора меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }

|-
!style="color:blue;width: 15%" |'''GET/marks/export/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде строк
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

метка1 синоним1,синоним2,синоним3,синонимN 0.9

меткаN синоним11,синоним21,синоним31,синонимN1 0.9
|-
!style="color:blue;width: 15%" |'''GET/marks/get/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде json
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "data": [

 ["метка1", [ "синоним1", "синоним2", "синоним3", "синонимN" ],

 0.9

 ],

 ["меткаN", ["синоним11","синоним21", "синоним31","синонимN1"],

 0.9

 ] ] }
|-
!style="color:green;width: 15%" |'''POST/marks/import/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из файла. Набор будет переписан из файла
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл "метка"ТАБ"синонимы через запятую"ТАБ"достоверность(число от 0 до 1)"

* '''id''' — идентификатор набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/marks/list'''
! colspan="3" style="width: 85%" |Получение списка наборов меток
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "result": [ { "id": "416fbe08-19e9-453c-b140-37008a08a76c","name": "test" },

 {"id": "16e77fa2-7c4d-47f9-8644-6385876525d6","name": "Рыжик" },

 {"id": "132310fa-98c7-4b12-896f-ff113827d077", "name": "test" }

 ]}
|-
!style="color:green;width: 15%" |'''POST/marks/put/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из json строки. Набор будет переписан
|-
| colspan="2" style="width: 50%" |
* '''json''' — список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''id''' — идентификатор заменяемого набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:green;width: 15%" |'''POST/marks/rename/{id}'''
! colspan="3" style="width: 85%" |Присваивает новое наименование существующему набору меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
* '''name''' — новое имя набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|}

===== '''/spr: работа с сервисом SPR''' =====

{{:SPR. Руководство пользователя}}

===== '''/smc: работа с сервисом SMC''' =====

{{:SMC. Руководство пользователя}}

===== '''/see: работа с сервисом SEE''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/see/entities/{model}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* model — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |{ ID-модели: [

{ '''position''': 0, # позиция слова начала фрагмента, определяющего сущность

'''confidence''': 1, #вероятность правильного определения сущности

text: текст сущности,

'''calculated''': vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели }, {...}

] }
|-
!style="color:green;width: 15%" |'''POST/see/stop/{model}'''
! colspan="3" style="width: 85%" |Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color:green;width: 15%" |'''POST/see/train/{model}'''
! colspan="3" style="width: 85%" |Запуск обучения модели '''future'''
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели

* '''corpus''' — название корпуса с данными

* '''noise''' — уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 0
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|}

===== '''/sbs: работа с сервисом SBS''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 20%" |
* '''wav''' — файл для анализа
| colspan="2" style="width: 80%" |Пример:

{ age: {

 class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}

 confidence: 0.99 },

emotion: {

 class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", "NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}

 confidence: 0.99 },

gender: {

 class: FEMALE, # { "MALE", "FEMALE" }

 confidence: 0.99 } }
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:
<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для анализа
*'''threshold''' — порог похожести при поиске, от 0 до 1.
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |Пример ответа:

{ error: 0, speaker: Ivan, confidence: 0.79 }
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{

 "error": 0,

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"

}
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 20%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 80%" |{ error: INT, message: DESCRIPTION }
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |[ {

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",

 "name": "наименование слепка"

 }]
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для обучения
*'''id''' — идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0,

 "message": "Success"}
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0, "confidence": 0.78 }
|}

====='''/tts: методы работы с сервисом tts'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |Простой текст — строки со словом и его интерпретацией с ударением.
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ [ "слово", "замена слова с удар+ением"],

[ "слово2", "замена слова2 с удар+ением"],

...]
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
*'''csv file''' — файл строк со словом и его интерпретацией с ударением.
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "сообщение о статусе результата"}
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка json следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "сообщение о статусе результата"

}
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="3" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
*'''text''' — фраза для нормализации
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "text": "нормализованный текст" }
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="3" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
*'''wav''' — аудиофайл для обработки

*'''revoicer''' — модель модификации голоса
| colspan="2" style="width: 50%" |wav-файл с модифицированным (искаженным) голосом
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ "distortion" ]
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{model}'''
! colspan="3" style="width: 85%" |Синтез звукового файла из текста/
|-
| colspan="2" style="width: 50%" |
*'''ID''' — имя модели
*'''text''' — текст синтезируемой фразы
*'''rate''' — скорость речи
*'''pitch''' — высота (тон)
*'''volume''' — громкость
*'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
*'''format''' - формат файла результата (wav, opus, ogg, mp3)
*'''link''' - если 1, то вернуть только ссылку на файл
| colspan="2" style="width: 50%" |файл с синтезированой фразой
|}

====='''/qas: методы работы с сервисом qas'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/qas/ask'''
! colspan="2" style="width: 85%" |Метод генерирует ответ на поставленный вопрос на основе информации из документов в базе. Ответ на вопрос генерируется на основе информации, содержащейся в одном или нескольких документах. Документы должны быть в текстовом формате. Ответ возвращается в формате JSON, его можно скачать. Если метод не смог найти ответ, возвращается код ошибки и сообщение.
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст вопроса, на основе которого будут искаться фрагменты.
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''maxDocs''' — максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{

"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы*'''mode''' - режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' - генерирует кэш через разные ответы на каждый вопрос по документации
*'''mode''' — режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' — генерирует кэш через разные ответы на каждый вопрос по документации

*'''option''' - {all | empty} обработать все вопросы или только не содержащие ответов
*'''category''' - если указан код категории, то генерация только для этой категории

*'''variants''' - количество ответов, от 1 до 9
*'''replace''' - заменить ответы на сгенерированные
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/status'''
! colspan="2" style="width: 85%" |Состояние генерации ответов на вопросы в кэше. Статусы: '''started''', '''stopped''', если были ошибки, поле ответа '''error''' будет содержать код ошибки.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "started",

 "progress": 33.33}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/stop'''
! colspan="2" style="width: 85%" |Остановить генерацию ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/category/add'''
! colspan="2" style="width: 85%" |Добавить категорию с указанным именем. В ответе — id созданной категории или сообщение об ошибке:
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "id": "ad895085-2e48-439a-831e-b5f699b6a54a" }
|-
! style="color:red;width: 15%" |'''DELETE/qas/category/delete/{id}'''
! colspan="2" style="width: 85%" |Удалить категорию. В ответе или сообщении об успехе, или ошибке, если категория используется или не существует.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/category/list'''
! colspan="2" style="width: 85%" |Получить список категорий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |В ответе json с именами и id категорий
|-
! style="color:green;width: 15%" |'''POST/qas/category/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить категорию. У категории пока есть только наименование, поэтому метод только переименовывает категорию
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/add'''
! colspan="2" style="width: 85%" |Добавление канала. В ответе id созданного канала или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование канала
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "a46fb887-5d98-41e0-8299-bcc94f615e91"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/channel/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление канала
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/channel/list'''
! colspan="2" style="width: 85%" |Получить список всех каналов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": 0,

 "channels": [

 { "id": "1", "name": "voice" },

 { "id": "56442779-e871-43fd-ae4d-caf4ab6d09b9", "name": "канал++" },

 { "id": "0", "name": "default" }

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить канал. У канала пока есть только наименование, поэтому метод только переименовывает канал
|-
| colspan="2" style="width: 50%" |
*'''name''' — новое наименование канала

*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Пример ответа на вопрос "как пройти в библиотеку"{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc/start'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
* '''text -''' текст документа
* '''model''' - какую модель использовать для ответа, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM, необязательный параметр
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/stop'''
! colspan="2" |Остановка очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/status'''
! colspan="2" |Статус очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{
"error": 0,

"status": stopped | started,

"progress": 33.3,

"message": string,

"place": number, #место в очереди

"queue": True | False #состояния - в очереди или в процессе очистки

}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/result'''
! colspan="2" |Результат очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0,"status": "stopped","text": "очищенный текст","doc_id": "ID документа"}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/add'''
! colspan="2" style="width: 85%" |Загрузить текстовый документ. Добавляет документ в базу. В ответе — id созданного документа или сообщение об ошибке.
|-
| colspan="2" style="width: 50%" |
*'''title''' — заголовок документа
*'''category''' — категория документа
*'''text''' — файл документа
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "ebe2bc57551c2d17f892987d1f62306d"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/doc/delete/{id}'''
! colspan="2" style="width: 85%" | Удаление документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка текста документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{

 "error": 0,

 "text": "Здесь будет полный текст документа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/list'''
! colspan="2" style="width: 85%" |Получение списка имеющихся документов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |Пример:

{ "error": 0,

 "docs": [

 {id": "d4999cdee5ad1faf2cb3066ea1b5e96b",

 "title": "PVE. Установка сервисного пакета окружения",

 "category": "Техническая поддержка" },

 {"id": "759042575b965745b9d2af869bca1740",

 "title": "UPS. Руководство администратора",

 "category": "Техническая поддержка"} ]}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modify/{id}'''
! colspan="2" style="width: 85%" |Обновление документа. В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c изменяемыми параметрами документа

<code>{</code>

<code> title: string,</code>

<code> category: string,</code>

<code> text: string</code>

<code>}</code>

параметр который не меняется может отсутствовать в json

*'''id''' — идентификатор документа.
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/replace'''
! colspan="2" style="width: 85%" |Замена подстроки в текстах категории Будут заменены все найденные вхождения
|-
| colspan="2" style="width: 50%" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
| style="width: 50%" |{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modifyphrases'''
! colspan="2" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/gpt/list'''
! colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success", "models": ["default" ]}
|-
! style="color:green;width: 15%" |'''POST/qas/question/add'''
! colspan="2" style="width: 85%" |Добавление вопроса. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса

*'''category''' — id категории к которой относится вопрос

*'''answers''' — ответы в виде Json:

<code>[ { "checked": true, "channel": "0", "answer": "ответ" } ]</code>

*'''aliases''' — вопросы к которым подходят ответы из блока answers в виде json:

<code>["вопрос","еще вопрос"]</code>
| style="width: 50%" |{

 "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:green;width: 15%" |'''POST/qas/question/append/{id}'''
! colspan="2" style="width: 85%" |Добавляет алиасы/кандидаты к другому вопросу
|-
| colspan="2" style="width: 50%" |
*'''aliases''' — JSON list с синонимами

*'''candidates''' JSON list с кандидатами

*'''id''' — идентификатор вопроса к которому добавить синонимы и(или) кандидаты
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/approve/{destination_id}'''
! colspan="2" style="width: 85%" |Перемещает кандидаты в формулировки другого вопроса
|-
| colspan="2" style="width: 50%" |
*'''candidates''' — json массив c текстами кандидатов

*'''destination_id''' — идентификатор вопроса
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/delete/list'''
! colspan="2" style="width: 85%" |Удаление списка вопросов или ответов
|-
| colspan="2" style="width: 50%" |
*'''questions''' — json строка с перечнем id

*'''type''' — выбор, удалять вопросы или ответы ('''questions''', '''answers''')
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:red;width: 15%" |'''DELETE/qas/question/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/question/get/{id}'''
! colspan="2" style="width: 85%" | Получение вопроса вместе с ответами и синонимами вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{ "error": 0,

 "answers": [

 { "checked": true,

 "channel": "0",

 "answer": "ответ" } ],

 "aliases": [

 "вопрос",

 "синоним вопроса",

 "еще синоним вопроса" ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/question/list'''
! colspan="2" style="width: 85%" | Получение списка вопросов.
|-
| colspan="2" style="width: 50%" |
*'''question''' — фильтр вопросов, ограничение списка по вопросам
*'''category''' — фильтр категорий

*'''answer''' — фильтр ответов, ограничение списка по ответам
*'''created''' — фильтр по дате создания, оставляет вопросы, созданные '''не ранее''' указанной даты
*'''createdBefore''' — фильтр по дате создания, оставляет вопросы, созданные '''не позже''' указанной даты
*'''modified''' — фильтр по дате изменения, оставляет вопросы, '''изменённые в точности''' в указанную дату
*'''onlyNew''' - фильтр, оставляющий только новые (необработанные) вопросы
| style="width: 50%" |{ "error": 0,

 "questions": [

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0},

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0}

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/question/modify/{id}'''
! colspan="2" style="width: 85%" |Модификация вопроса. Позволяет заменить как все параметры так и отдельные
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c измененными параметрами, пример полного:

<code>{ "answers": [</code>

<code> {</code>

<code> "checked": true,</code>

<code> "channel": "0",</code>

<code> "answer": "новый ответ"</code>

<code> }</code>

<code> ],</code>

<code>"question":"новый вопрос",</code>

<code>"category": "a3801cc0-f8e5-4f3b-bb10-e42148cd772b",</code>

<code> "aliases": [</code>

<code> "новый вопрос",</code>

<code> "синоним",</code>

<code> "еще синоним"</code>

<code> ]</code>

<code>}</code>

*'''id''' — идентификатор вопроса
| style="width: 50%" |В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.

{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/question/replace'''
! colspan="2" |Поиск и замена подстроки. Будут заменены все найденные вхождения
|-
| colspan="2" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
|{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/question/modifyanswers'''
! colspan="2" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/paraphrase'''
! colspan="2" |Генерация фраз-синонимов для предложения.
|-
| colspan="2" |
*'''text -''' предложение
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "texts": [ "перефразированный текст 1", ... ]}
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/answers'''
! colspan="2" style="width: 85%" |Отображает лог массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |на выходе :
массив из объектов {

 error: number;

 question: string;

 answer: string;

 confidence: number | null;

}
|-
! style="color:green;width: 15%" |'''POST/qas/questionlist/start'''
! colspan="2" style="width: 85%" | Старт массовой обработки вопросов из файла
|-
| colspan="2" style="width: 50%" |
*'''questions''' - файл с вопросами
*'''format''' - в json или в text файл с вопросами
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

— "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''threshold''' - порог достоверности при обработке
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/status'''
! colspan="2" style="width: 85%" |Статус массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;

 status: 'started' | 'stopped';

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/stop'''
! colspan="2" style="width: 85%" |Остановка массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM для анализа на несоответствия, необязательный параметр
*'''asktemplate''' - ID шаблона запроса к LLM для генерации ответов по документу, необязательный параметр
*'''answers''' - тип вопросов, по которым осуществляется поиск несоответствий, необязательный параметр, по умолчанию «all»
|<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/status'''
! colspan="2" style="width: 85%" |Статус поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;<nowiki> status: 'started' | 'stopped';</nowiki>

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/stop'''
! colspan="2" style="width: 85%" |Остановка поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/mismatches'''
| colspan="2" |Статус получения результатов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": 0,"message": "success","mismatches": [{"question_id": "ID вопроса", "question": "вопрос", "category": "ID категории", "answer_id": "ID ответа", "answer": "ответ на вопрос {question}", "description": "результат поиска", "error" : string, "context": "фрагмент документа", "generatedText" : "Результат генерации" }, ... ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/start'''
| colspan="2" |Запуск генерации вопросов
|-
| colspan="2" |
*'''category''' - ID категории, по которой будет происходить генерация вопросов
*'''doc''' - ID документа, по которому будет происходить генерация вопросов
*'''generateAnswers''' - флаг для генерации ответов вместе с вопросами '''[yse|no]''', по умолчанию '''«no»'''
*'''model''' - имя модели GPT, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM для анализа генерации вопросов, необязательный параметр
|{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
| colspan="2" |Статус генерации вопросов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": string, <nowiki>"status": 'started' | 'stopped',</nowiki> "progress": 33.3 }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/stop'''
! colspan="2" style="width: 85%" |Прервать генерацию.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
* '''maxDocs''' - максимальное количество документов одной категории для формирования контекста при поиске ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{ "error": 0,

 "text": "

 Фрагмент 1:Здесь будет текст найденного фрагмента

 Фрагмент 2:Здесь будет текст найденного фрагмента",

 "fragments": [

 { "id": "3a386b0a9e0e19efb0870685e1d0b484",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" },

 { "id": "44fd73ea1ac63f32cf18d79c854dbfe2",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" } ] }
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/add'''
! colspan="2" style="width: 85%" |Добавление шаблона протокола. В случае успеха метод вернет id шаблона, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''name''' — название шаблона

* '''options''' — json словарь с именами разделов и их описанием
| style="width: 50%" |{ "error": 0, "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"}
|-
! style="color:red;width: 15%" |'''DELETEqas/summarization_template/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление шаблона.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/get/{id}'''
! colspan="2" style="width: 85%" |Получение json с шаблоном.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |На выходе словарь, основные элементы: data — словарь с шаблоном, остальные элементы этого уровня служебные. В data: id, name (идентификатор и наименование).И options — словарь с разделами шаблона.
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/list'''
! colspan="2" style="width: 85%" |Получение всех шаблонов.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |На выходе словарь, основной элемент — templates, содержит список шаблонов (каждый шаблон как в выдаче метода GET /qas/summarization_template/get/{id}).
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение шаблона.
|-
| colspan="2" style="width: 50%" |
*'''data''' — словарь как в выдаче метода GET/qas/summarization_template/get/{id}

*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/summarize'''
! colspan="2" style="width: 85%" |Построение протокола или краткого содержания совещания
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст совещания

*'''options''' — словарь с разделами протокола, где ключ — название раздела, значение - краткая инструкция к формированию раздела.
*'''model''' - какую GPT модель использовать для построения протокола, если кроме default используются другие модели

*'''file''' — файл с текстом (текст, csv, pdf или текстовые офисные документы)
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{ "error": 0,
 "message": "success",

 "summary": "здесь текст протокола"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replace'''
! colspan="2" |корректировка информации в тексте при помощи LLM
|-
| colspan="2" |
*'''text''' - текст
*'''oldinfo''' — старая информация
*'''newinfo''' — новая информация
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{ "error": 0, "message": "success",

 "text": "итоговый текст"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replacementlist'''
! colspan="2" |список всех фраз в документах и ответов в вопросах, подлежащих правке. Векторно ищет все фрагменты по указанному тексту.
|-
| colspan="2" |
*'''text''' - текст
*'''category''' — категория, в которой производится векторный поиск
*'''threshold''' — порог похожести, необязательный параметр, если не указан, берется из конфигурационного файла (fragments -> threshold)
*'''answers''' - тип вопросов, по которым осуществляется поиск для внесения правок, необязательный параметр, по умолчанию «all»
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/add'''
! colspan="2" |Добавление шаблона запроса к LLM. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" |
*'''type''' — тип шаблона - chat - произвольный чат, - ask - запрос к документам, - cleandoc - очистка документа, форматирование либо другое преобразование, - similars_generator - генерация синонимичных которотких фраз, - paraphrase - перефразировка текста, - summarize - суммаризация текста (формирование краткой выдержки из текста), - question_generator - генерация вопросов по тексту, - replace - замена информации в тексте, mismatch - поиск несоответствий

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
*'''params''' - параметры запроса к LLM"max_tokens": 4096, "top_k": 30, "top_p": 0.5, "temperature": 0.5, "repeat_penalty": 1.3
|{ "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:red;width: 15%" |'''DELETE/qas/prompt/delete/{id}'''
! colspan="2" |Удаление шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/get/{id}'''
! colspan="2" |Получение шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{ "error": 0, "prompt": {

 "id": "cleandoc",

 "type": "cleandoc",

 "isDefault": false,

 "name": "Чистка документа",

 "prompt": "Удали сноски, колонтитуры и мусорную информацию из текста ниже. Не удаляй ничего лишнего. Не добавляй ничего, только информация из текста. Выведи только конечный результат без отчета о результате.\n###Текст:\n{context}\n\n###Конечный результат:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/list'''
! colspan="2" |Получение списка шаблонов.
|-
| colspan="2" |
|{ "error": 0, "prompts": [

 {

 "id": "chat",

 "type": "chat",

 "isDefault": false,

 "name": "Чат",

 "prompt": "Ты спокойный вежливый консультант.[\n\n###История переписки:\n{history}]\n\n###Вопрос: {question}\n###Ответ:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

 ]

}
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/modify/{id}'''
! colspan="2" |Модификация шаблона. Позволяет заменить как все параметры, так и отдельные.
|-
| colspan="2" |
*'''data''' — json c измененными параметрами:
<code>{ "name": "новое имя" }</code>
*'''id''' — идентификатор вопроса
|В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.{"error": INT, "message": DESCRIPTION}
|}

====='''/ses: методы работы с роботом'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться к продовой версии - нужен постфикс "_prod", для бэкапа "_backup"
актуально для методов

- получения данных робота GET/ses/robot/get/{id}

- применение настроек робота GET/ses/robot/commit/{id}

- экспорт робота GET/ses/robot/export/{id}

- список скриптов GET/ses/robot/script/list/{robot}

- получение скрипта GET/ses/robot/script/get/{robot}/{id}

- список ЭД GET/ses/robot/data/list/{robot}

- получение ЭД GET/ses/robot/data/get/{robot}/{id}

- список КТ GET/ses/robot/endpoint/list/{robot}

- получение КТ GET/ses/robot/endpoint/get/{robot}/{id}

- метода ask (отладчика) POST/ses/ask/{robot_id}

- данные сессии (отладчика) GET/ses/session/{robot_id}/{session_id}
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/audio/{uuid}'''
! colspan="2" style="width: 85%" |Получение аудио-файла из архива диалогов
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |аудио-файл с расширением opus
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/dialog/{uuid}'''
! colspan="2" style="width: 85%" |Получение диалога из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |{ "error": 0, "message": "success",

 "dialog": [{"id": "...", "robot": "...", "channel": "...",

 "unknown": true/false, "closed": true/false, "endpoint": "...",

 "answered": true/false, "models": [...], "variables": {}, "current": {

 "id": "...", "qas": "", "category": "...", "entry": [...],

 "nearest": "...", "missingRunData": [...], "waitingRunData": "...",

 "answered": true/false, "lastreply": "..."},

 "request": {"datetime": "...", "message": "", "data": [...]},

 "reply": {"answers": [{"messages": [...], "voice": "...",

 "interruptible": true/false, "file": null}],

<nowiki> "datetime": "...", "answered": true/false}}]}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/list'''
! colspan="2" style="width: 85%" |Получение списка диалогов из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
*'''startdate''' - начало временного интервала в формате date %Y-%m-%d %H:%M
*'''enddate''' - конец временного интервала в формате date %Y-%m-%d %H:%M
*'''phone''' - номер телефона
*'''variable''' - переменная в формате variable=value
*'''robot''' - идентификатор робота (id)
*'''text''' - фрагмент текста в любом сообщении
*'''data''' - id элемента данных
*'''channel''' - название канала (коннектора)
| style="width: 50%" |[{"uuid": "...", "datetime": "...","phone": "", "channel": [...], "robot": ["..."]}]
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/waveform/{uuid}'''
! colspan="2" style="width: 85%" |Служебный метод для визуализации полученного из архива диалогов аудио-файла, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |[0.016,

0.015,

0.01]
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст запроса

*'''channel''' - id канала

*'''connector''' - имя коннектора

*'''session''' - uuid сессии, если это не первый запрос в сессии

*'''tts''' - вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' - словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''handler''' - python скрипт для изменения ответов метода под требования внешних систем, подробнее в следующем разделе. в поле имя файла без расширения.

*'''restartClosed''' - перезагрузить сессию при её закрытии с новым id (1 - перезагрузить, 0 - не перезагружать)

*'''audio''' - аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''document''' - документ для последующей обработки

*'''robot_id''' - id робота

*'''endpoint''' - id точки, в которую передать управление диалогом (необязательный параметр, используется для исходящих оповещений)
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="2" style="width: 85%" |Создание нового робота. На выходе id созданного робота или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя нового робота
| style="width: 50%" |{ "error": 0, "id": "2fd2f909-2069-4b20-a725-3a598c83f886"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/apply/{id}'''
! colspan="2" style="width: 85%" | Применение робота. Переводит черновик робота в статус prod. Если до этого был prod вариант — становится backup.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/cleardraft/{id}'''
! colspan="2" style="width: 85%" |Обнуление черновика рабочей версией робота

|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": { "id": "id ЭД", "name": "Имя ЭД", "comment": "",

 "type": "...", "rtype": "report", "model": "Имя модели",

 "param": "Ответ", "script": "", "weight": 3,

 "slaveData": [], "getOnlyAsNearest": true/false,

 "injectToMessage": true/false, "longWaiting": true/false,

 "dataWaiting": [], "actions": { "alone": {

<nowiki> "default": [{"action": "say", "type": "random", "text": ["....."]}]}},</nowiki>

<nowiki> "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[ { "id": "3ebfe38b-95bf-4927-a662-17f6e5da22ea",
 "name": "pve", "type": "smc", "rtype": "report",

 "weight": 3, "hasNearestAction": false } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение элемента данных. Формат '''data''' как на выходе метода '''GET/ses/robot/data/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
*'''id''' — идентификатор элемента данных
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление всех версий робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/add/{robot}'''
! colspan="2" style="width: 85%" | Создание конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами конечной точки

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "id": "8576593b-b0d8-4b03-a623-74f3132356ea"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/endpoint/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление конечной точки.
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек конечной точки
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "data": { "id": "...", "name": "...", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка конечных точек робота
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[{ "error": 0, "data": { "id": "...", "name": "точка 1", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "....", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор элемента данных
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="2" style="width: 85%" |Выгрузка робота в архив
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |zip файл с именем = идентификатор робота
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/files/download/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''id''' - идентификатор файла
| style="width: 50%" |файл
|-
! style="color:green;width: 15%" |'''POST/ses/robot/files/upload/{robot}'''
! colspan="2" style="width: 85%" |Отправка файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''file''' - файл
| style="width: 50%" |{"error": 0, "message": "success", "id": "Id файла"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="2" style="width: 85%" | Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": {

 "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78",

 "name": "test", "description": "", "voice": "",

 "session": { "lifetime": 600 },

 "models": {}, "servicedata": {},

 "exceptions": {}, "actions": {},

 "holidays": [], "timeintervals": {

 "name": { "weekdays": [ 1, 2, 3, 4, 5, 6, 7 ],

 "dates": [ 0, 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],

"months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],

<nowiki>"days": "all", "intervals": [ [ 0, 1440 ] ] }}}}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="2" style="width: 85%" |Загрузка архива робота в черновик существующего робота
|-
| colspan="2" style="width: 50%" |
*'''zip —''' файл с архивом робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="2" style="width: 85%" |Получение списка роботов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ { "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78", "name": "test",

 "hasProd": true,

 "hasBackup": true } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение основных настроек робота. Формат '''data''' как в ответе метода '''GET/ses/robot/get/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с новыми настройками робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление нового скрипта. Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/script/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление скрипта
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение текста скрипита
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "data": {

 "id": "6a9f91b6-9634-4079-ac2b-60a944922c61",

"type": "Тип скрипта",

 "name": "Наименование скрипта",

 "code": "Текст скрипта" }

}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка скриптов
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |[ { "id": "9b9d83b7-d5c3-49e6-9bd4-a123a9047939", "name": "наименование1",

 "type": "Тип скрипта"},

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2",

 "type": "Тип скрипта"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение скрипта.Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/test/{robot}/{id}'''
! colspan="2" style="width: 85%" |Тестирование скрипта. Формат '''data''' как в ответе метода '''GET/ses/session/{robot_id}/{session_id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка с параметрами сессии
*'''id''' - идентификатор скрипта
*'''robot''' - идентификатор робота
| style="width: 50%" |<nowiki>{"error": 0, "message": "success", "result": {.....}, "variables": {}}</nowiki>
|-
! style="color:blue;width: 15%" |'''POST/ses/robot/userdata/data/add/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление записи в пользовательский справочник.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "id": "id записи"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/data/delete/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Удаление записи из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/data/list/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Получение данных из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |[{ "колонка 1": "значение 1", "колонка n": "значение n", "id": "id записи"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}'''
! colspan="2" style="width: 85%" | Массовое изменение данных в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Изменение одной записи пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/put/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление данных с заменой в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code> Поле "id" опционально, при его добавлении данные в строке будут заменены.
*'''replace''' - замена всех данных в справочнике новыми данными. Возможные значения: yes/no. По-умолчанию - yes.
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"id": "id справочника", "name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code> Поле "id" опционально.
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |{"error": 0, "id": "id справочника"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/structure/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/structure/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка пользовательских справочников.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |<nowiki>[{"id": "id справочника", "name": "справочник", "fields": {"колонка1": "значение по умолчанию"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Модификация структуры пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code>
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="2" style="width: 85%" |Выдает параметры сессии. Для отображения на боковой панели тестирования в UPS. Основные блоки результата:
|-
| colspan="2" style="width: 50%" |
*'''robot_id''' — id робота

*'''session_id''' — id незакрытой сессии
| style="width: 50%" |{ "started": "", "modified": "",

 "robot": "",

 "session": "",

 "channel": "",

 "connector": "",

 "unknown": true/false,

 "current": {"id": "", "qas": "", "answered": true/false, "category": "",

 "nearest": "", "entry": [.....], "missingRunData": [],

 "passedRunData": [.....], "waitingRunData": null,

 "border": int, "preborder": int, "lastreply": ""},

 "models": [.....],

 "scripts": [.....],

<nowiki> "data": [{"request": {.....}, "reply": {.....}}],</nowiki>

 "timers": [],

 "variables": {},

 "error": "",

 "events": {.....},

 "closed": "" }
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/config'''
! colspan="3" style="width: 85%" |Выдает параметры виджета для web канала по запросу js скрипта
|-
| colspan="2" style="width: 50%" |
*'''token''' — уникальный код виджета, создается при внедрении
| colspan="2" style="width: 50%" |Состав конфига канала, для передачи виджету. Подробней в [https://wiki.connect2ai.net/index.php/SES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B0_%D0%B4%D0%BB%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%B0 Руководстве администратора]
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/js'''
! colspan="3" style="width: 85%" |Выдает код js скрипта виджета для web-канала
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |Код скрипта
|}

====='''/res: методы работы с сервисом отчетов'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/res/dashboards'''
! colspan="3" style="width: 85%" |Получить список рабочих столов kibana с наборами отчетов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |{ "error": 0, "message": "success",

 "dashboards": {

"Наименование1": "https://........",

<nowiki>"Наименование2": "https://........." }}</nowiki>
|}

====='''/transcription: методы работы со стенографией'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/transcription/audio/{id}'''
! colspan="3" style="width: 85%" | Получить аудиофайл по id стенограммы. Идентификатор нужной стенограммы можно получить методом
"GET /transcription/list"
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |wav файл сохраненной стенограммы
|-
! style="color:green;width: 15%" |'''POST/transcription/create'''
! colspan="3" style="width: 85%" |Создание стенограммы из завершенного задания в очереди распознавания. В ответ придет id созданной стенограммы
|-
| colspan="2" style="width: 50%" |
*'''taskID''' — идентификатор задания из очереди

*'''name''' — имя создаваемой стенограммы
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"id": "74721a3b-9055-4650-9afb-de4d103cafc7"}
|-
! style="color:red;width: 15%" |'''DELETE/transcription/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление стенограммы
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/get/{id}'''
! colspan="3" style="width: 85%" |Получение стенограммы. Используется для отображения стенограммы в веб интерфейсе
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |стенограмма в json формате
|-
! style="color:blue;width: 15%" |'''GET/transcription/list'''
! colspan="3" style="width: 85%" |Получение списка сохраненных стенограмм
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ { "id": "926e8d25-4275-4a78-906b-a1109cdacbea",

"name": "название",

"model": "big",

"created": "2024-03-29 12:37:42",

"modified": "2024-04-24 16:09:09",

"user": "0",

"dataset": "0" }, .... ]
|-
! style="color:green;width: 15%" |'''POST/transcription/save/{id}'''
! colspan="3" style="width: 85%" |Сохранение стенограмы. Используется для сохранения изменений по нажатию кнопки «Сохранить».
|-
| colspan="2" style="width: 50%" |
*'''data''' — стенограмма в json формате

*'''id''' стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/waveform/{id}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, ответ содержит пики сигнала
|-
| colspan="2" style="width: 50%" |
*'''id''' стенограммы
| colspan="2" style="width: 50%" |{ "error": 0,

"waveform": [

 0.016,

 ..........

 ..........

 0.015,

 0.01 ] }
|}

SMC. Руководство пользователя

2026-01-12T09:58:58Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short Message Classifier предназначен для классификации текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Message Classifier (SMC) - сервис классификации текстовых фрагментов.

Модель — предварительно обученная специализированная нейронная сеть классификации коротких фраз.

Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SMC.

===== '''Описание методов API SMC''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SMC. По умолчанию используется порт 6181/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6181</nowiki> будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

===== '''Постобработка''' =====
Модель может содержать постобработчик. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /smc/classify/{id}.

Пример пустой функции:

<code>def handler(classes=[],text=""):</code>

<code> returns classes</code>

На вход подается результат работы модели, а также начальный текст.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+

! style="color:blue;width: 15%" |'''GET/smc/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей. Выводит только пользовательские модели. Сервисные модели, корпуса, наборы меток не выводит.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/list'''
! colspan="3" style="width: 85%" |Список заданий на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "tasks": [</code>

<code> {</code>

<code> "id": "id-1",</code>

<code> "taskname": "name1",</code>

<code> "status": "finished"</code>

<code> },</code>

<code> {</code>

<code> "id": "id-nnnn",</code>

<code> "taskname": "name2",</code>

<code> "status": "finished"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/result/{id}'''
! colspan="3" style="width: 85%" |Получить результат задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "started": "2024-10-09 18:05:51",</code>

<code> "finished": "2024-10-09 18:05:51",</code>

<code> "corpus": [[ [], [ ["тэг"],"фраза 1"]],</code>

<code> [ [], [["тэг"],"фраза 2"]] ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''taskname''' - произвольное имя задания

*'''corpus''' - json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

*'''marks''' - json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

*'''appendMarks''' - "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "id": "уникальный id задания"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": "",</code>

<code> "status": "finished",</code>

<code> "started": "2024-10-09 13:49:46",</code>

<code> "finished": "2024-10-09 13:49:46",</code>

<code> "progress": 0</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "success"</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/classify/{id}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случает если модель была создана из меток в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

*'''classes''' - список , для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.

*'''groups''' - название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т.е. чем полнее группа, тем выше ее позиция в списке).

*'''nearest''' - отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели

*'''text''' - текст, подлежащий классификации
*'''correction''' - проверять правописание слов и исправлять ошибки

*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |<code>{</code>
<code> "classes": [</code>

<code> {</code>

<code> "class": "название класса",</code>

<code> "confidence": 1</code>

<code> },</code>

<code> {</code>

<code> "class": "название класса 2",</code>

<code> "confidence": 1</code>

<code> }</code>

<code> ],</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "название группы 1",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "название класса", "название класса 2" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "название группы 2",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 1"</code>

<code> },</code>

<code> {</code>

<code> "group": ""название группы 3",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 2"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.

|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для сжатия

*'''threshold''' - уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |<code>{</code>

<code> "text": "сжатый текст"</code>

<code>}</code>

|-
! style="color:green;width: 15%" |'''POST/smc/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели

|-
| colspan="2" style="width: 50%" |
* '''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> { error: INT, message: DESCRIPTION }</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернет текст неизменным.

|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> "text": "корректный текст"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |ZIP-файл с моделью, либо { error: 1, message: DESCRIPTION }
|-
! style="color:red;width: 15%" |'''DELETE/smc/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''zip-model''' - zip-архив с файлами модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/embedding'''
! colspan="3" style="width: 85%" |
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза
| colspan="2" style="width: 50%" | <code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов ''positive negative neutral.''
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза для анализа эмоций
| colspan="2" style="width: 50%" |<code>{ "emotion": "positive", "score": 0.9601 }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' - идентификатор модели
*'''type''' - тип ошибок, возможные варианты:
'''train''' - ошибки обучения

'''test''' - ошибки тестирования

'''mark''' - ошибки создания модели из меток
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:blue;width: 15%" |'''GET/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат - группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''classes''' — набор меток через запятую
| colspan="2" style="width: 50%" |Результат в виде json.<code>{</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "Группа 1",</code>

<code> "intersection": 3,</code>

<code> "classes": [ "метка1_о", "метка2_о", "метка3_о"]</code>

<code> },</code>

<code> {</code>

<code> "group": "Группа 2",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "метка1_о", "метка5_о" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "Группа до которой не хватило 1 метки",</code>

<code> "percent": 0.75,</code>

<code> "need": "недостающая метка_о"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
*'''groups''' - JSON с новыми группами

* '''csv-file''' - файл с группами
| colspan="2" style="width: 50%" |<code>{ "error": 0,</code><code>"message": "string"</code> <code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Получает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Файл программы обработчика на python
|-
! style="color:red;width: 15%" |'''DELETE/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Удаляет [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Устанавливает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели

*'''handler''' - файл постобработчика
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |На выходе будут следующие параметры:
'''id''' - идентификатор

'''status''' - статус

'''classes''' - список классов в модели

'''groups''' - список групп в модели

'''trainCorpusName''', '''testCorpusName''' - названия файлов, использованных при обучении и тестировании

'''trainAccuracy''', '''testAccuracy''' - точность обучения и тестирования

'''initCorpusLength''' - начальный размер корпуса обучения

'''trainCorpusLength''' - размер корпуса после нормализации и синтеза данных

'''testCorpusLength''' - размер тестового корпуса

'''trainConfusionMatrix''' - матрица ошибок обучения

'''testConfusionMatrix''' - матрица ошибок тестирования
|-
! style="color:blue;width: 15%" |'''GET/smc/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{ </code>

<code>"log": [</code>

<code> "training",</code>

<code> "normalization: 5, model size: 2",</code>

<code> ...</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу -> 25 апреля в 5-м часу
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{"text": "<строка после обратной нормализации>"}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{ "text": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/search'''
! colspan="3" style="width: 85%" |Семантический поиск фразы в тексте.
|-
| colspan="2" style="width: 50%" |
*'''phrase''' - искомая фраза

*'''text''' - текст в котором нужно найти фразу
| colspan="2" style="width: 50%" |<code>{</code> <code>"error": 0,</code>

<code> "message": "success",</code>

<code> "similarity": 1,</code>

<code> "fragment": "найденная фраза"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/test/{id}'''
! colspan="3" style="width: 85%" | Тестирование модели. Тестируется заранее подготовленным текстовым файлом со строками вида: КЛАСС<TAB>ФРАЗА

Метод асинхронный. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - файл для тестирования
*'''correction''' - исправлять ошибки правописания в файле для тестирования ('''0''' или '''1''')
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
*'''text''' - текстовая строка с высказыванием
| colspan="2" style="width: 50%" |<code>{</code> <code>"insult": 0.13, # оскорбление</code>

<code> "obscenity": 0, # брань</code>

<code> "threat": 0, # угрозы</code>

<code> "politeness": 0.53 вежливость</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''isMarks''' - если "1" то вместо csv файла корпуса метод ожидает json файл с меткам, формат файла csv-file:{"id": "уникальный идентификатор", "name": "имя набора", "data": [ ["метка1",["синоним1", "еще несколько синонимов через запятую"],порог достоверности], ["еще метка",["синоним", "еще несколько синонимов через запятую"],порог достоверности]]} модель созданная из меток при этом не обучается, созданный файл модели используется для расчетов векторов "на лету" и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|}
</onlyinclude>

SMC. Руководство пользователя

2026-01-12T09:57:53Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short Message Classifier предназначен для классификации текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Message Classifier (SMC) - сервис классификации текстовых фрагментов.

Модель — предварительно обученная специализированная нейронная сеть классификации коротких фраз.

Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SMC.

===== '''Описание методов API SMC''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SMC. По умолчанию используется порт 6181/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6181</nowiki> будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

===== '''Постобработка''' =====
Модель может содержать постобработчик. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /smc/classify/{id}.

Пример пустой функции:

<code>def handler(classes=[],text=""):</code>

<code> returns classes</code>

На вход подается результат работы модели, а также начальный текст.

<onlyinclude>
</onlyinclude><onlyinclude></onlyinclude>
<onlyinclude></onlyinclude>
{| class="wikitable" style="width: 110%"
|+

! style="color:blue;width: 15%" |'''GET/smc/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей. Выводит только пользовательские модели. Сервисные модели, корпуса, наборы меток не выводит.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/list'''
! colspan="3" style="width: 85%" |Список заданий на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "tasks": [</code>

<code> {</code>

<code> "id": "id-1",</code>

<code> "taskname": "name1",</code>

<code> "status": "finished"</code>

<code> },</code>

<code> {</code>

<code> "id": "id-nnnn",</code>

<code> "taskname": "name2",</code>

<code> "status": "finished"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/result/{id}'''
! colspan="3" style="width: 85%" |Получить результат задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "started": "2024-10-09 18:05:51",</code>

<code> "finished": "2024-10-09 18:05:51",</code>

<code> "corpus": [[ [], [ ["тэг"],"фраза 1"]],</code>

<code> [ [], [["тэг"],"фраза 2"]] ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''taskname''' - произвольное имя задания

*'''corpus''' - json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

*'''marks''' - json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

*'''appendMarks''' - "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "id": "уникальный id задания"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": "",</code>

<code> "status": "finished",</code>

<code> "started": "2024-10-09 13:49:46",</code>

<code> "finished": "2024-10-09 13:49:46",</code>

<code> "progress": 0</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "success"</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/classify/{id}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случает если модель была создана из меток в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

*'''classes''' - список , для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.

*'''groups''' - название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т.е. чем полнее группа, тем выше ее позиция в списке).

*'''nearest''' - отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели

*'''text''' - текст, подлежащий классификации
*'''correction''' - проверять правописание слов и исправлять ошибки

*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |<code>{</code>
<code> "classes": [</code>

<code> {</code>

<code> "class": "название класса",</code>

<code> "confidence": 1</code>

<code> },</code>

<code> {</code>

<code> "class": "название класса 2",</code>

<code> "confidence": 1</code>

<code> }</code>

<code> ],</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "название группы 1",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "название класса", "название класса 2" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "название группы 2",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 1"</code>

<code> },</code>

<code> {</code>

<code> "group": ""название группы 3",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 2"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.

|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для сжатия

*'''threshold''' - уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |<code>{</code>

<code> "text": "сжатый текст"</code>

<code>}</code>

|-
! style="color:green;width: 15%" |'''POST/smc/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели

|-
| colspan="2" style="width: 50%" |
* '''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> { error: INT, message: DESCRIPTION }</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернет текст неизменным.

|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> "text": "корректный текст"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |ZIP-файл с моделью, либо { error: 1, message: DESCRIPTION }
|-
! style="color:red;width: 15%" |'''DELETE/smc/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''zip-model''' - zip-архив с файлами модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/embedding'''
! colspan="3" style="width: 85%" |
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза
| colspan="2" style="width: 50%" | <code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов ''positive negative neutral.''
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза для анализа эмоций
| colspan="2" style="width: 50%" |<code>{ "emotion": "positive", "score": 0.9601 }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' - идентификатор модели
*'''type''' - тип ошибок, возможные варианты:
'''train''' - ошибки обучения

'''test''' - ошибки тестирования

'''mark''' - ошибки создания модели из меток
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:blue;width: 15%" |'''GET/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат - группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''classes''' — набор меток через запятую
| colspan="2" style="width: 50%" |Результат в виде json.<code>{</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "Группа 1",</code>

<code> "intersection": 3,</code>

<code> "classes": [ "метка1_о", "метка2_о", "метка3_о"]</code>

<code> },</code>

<code> {</code>

<code> "group": "Группа 2",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "метка1_о", "метка5_о" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "Группа до которой не хватило 1 метки",</code>

<code> "percent": 0.75,</code>

<code> "need": "недостающая метка_о"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
*'''groups''' - JSON с новыми группами

* '''csv-file''' - файл с группами
| colspan="2" style="width: 50%" |<code>{ "error": 0,</code><code>"message": "string"</code> <code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Получает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Файл программы обработчика на python
|-
! style="color:red;width: 15%" |'''DELETE/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Удаляет [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Устанавливает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели

*'''handler''' - файл постобработчика
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |На выходе будут следующие параметры:
'''id''' - идентификатор

'''status''' - статус

'''classes''' - список классов в модели

'''groups''' - список групп в модели

'''trainCorpusName''', '''testCorpusName''' - названия файлов, использованных при обучении и тестировании

'''trainAccuracy''', '''testAccuracy''' - точность обучения и тестирования

'''initCorpusLength''' - начальный размер корпуса обучения

'''trainCorpusLength''' - размер корпуса после нормализации и синтеза данных

'''testCorpusLength''' - размер тестового корпуса

'''trainConfusionMatrix''' - матрица ошибок обучения

'''testConfusionMatrix''' - матрица ошибок тестирования
|-
! style="color:blue;width: 15%" |'''GET/smc/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{ </code>

<code>"log": [</code>

<code> "training",</code>

<code> "normalization: 5, model size: 2",</code>

<code> ...</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу -> 25 апреля в 5-м часу
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{"text": "<строка после обратной нормализации>"}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{ "text": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/search'''
! colspan="3" style="width: 85%" |Семантический поиск фразы в тексте.
|-
| colspan="2" style="width: 50%" |
*'''phrase''' - искомая фраза

*'''text''' - текст в котором нужно найти фразу
| colspan="2" style="width: 50%" |<code>{</code> <code>"error": 0,</code>

<code> "message": "success",</code>

<code> "similarity": 1,</code>

<code> "fragment": "найденная фраза"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/test/{id}'''
! colspan="3" style="width: 85%" | Тестирование модели. Тестируется заранее подготовленным текстовым файлом со строками вида: КЛАСС<TAB>ФРАЗА

Метод асинхронный. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - файл для тестирования
*'''correction''' - исправлять ошибки правописания в файле для тестирования ('''0''' или '''1''')
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
*'''text''' - текстовая строка с высказыванием
| colspan="2" style="width: 50%" |<code>{</code> <code>"insult": 0.13, # оскорбление</code>

<code> "obscenity": 0, # брань</code>

<code> "threat": 0, # угрозы</code>

<code> "politeness": 0.53 вежливость</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''isMarks''' - если "1" то вместо csv файла корпуса метод ожидает json файл с меткам, формат файла csv-file:{"id": "уникальный идентификатор", "name": "имя набора", "data": [ ["метка1",["синоним1", "еще несколько синонимов через запятую"],порог достоверности], ["еще метка",["синоним", "еще несколько синонимов через запятую"],порог достоверности]]} модель созданная из меток при этом не обучается, созданный файл модели используется для расчетов векторов "на лету" и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|}

SMC. Руководство пользователя

2026-01-12T09:56:55Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short Message Classifier предназначен для классификации текстовых фрагментов (фраз естественной речи). Принимает на вход текстовую строку и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Message Classifier (SMC) - сервис классификации текстовых фрагментов.

Модель — предварительно обученная специализированная нейронная сеть классификации коротких фраз.

Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SMC.

===== '''Описание методов API SMC''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SMC. По умолчанию используется порт 6181/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке <nowiki>http://АДРЕС:6181</nowiki> будет отображен интерфейс swagger со всеми методами с возможностью их проверки.

===== '''Постобработка''' =====
Модель может содержать постобработчик. Это стандартный файл на языке Python, который выполняет произвольные действия с результатом работы модели. Обязательным условием является наличие функции handler, которая должна возвращать данные такого же вида, как и метод GET /smc/classify/{id}.

Пример пустой функции:

<code>def handler(classes=[],text=""):</code>

<code> returns classes</code>

На вход подается результат работы модели, а также начальный текст.

<onlyinclude>
</onlyinclude><onlyinclude></onlyinclude>
<onlyinclude></onlyinclude>
{| class="wikitable" style="width: 110%"
|+

! style="color:blue;width: 15%" |'''GET/smc/models'''
! colspan="3" style="width: 85%" |Вывод списка моделей. Выводит только пользовательские модели. Сервисные модели, корпуса, наборы меток не выводит.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/list'''
! colspan="3" style="width: 85%" |Список заданий на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |Без входных параметров
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "tasks": [</code>

<code> {</code>

<code> "id": "id-1",</code>

<code> "taskname": "name1",</code>

<code> "status": "finished"</code>

<code> },</code>

<code> {</code>

<code> "id": "id-nnnn",</code>

<code> "taskname": "name2",</code>

<code> "status": "finished"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/result/{id}'''
! colspan="3" style="width: 85%" |Получить результат задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "started": "2024-10-09 18:05:51",</code>

<code> "finished": "2024-10-09 18:05:51",</code>

<code> "corpus": [[ [], [ ["тэг"],"фраза 1"]],</code>

<code> [ [], [["тэг"],"фраза 2"]] ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''taskname''' - произвольное имя задания

*'''corpus''' - json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

*'''marks''' - json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

*'''appendMarks''' - "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": 0,</code>

<code> "message": "success",</code>

<code> "id": "уникальный id задания"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>

<code> "error": "",</code>

<code> "status": "finished",</code>

<code> "started": "2024-10-09 13:49:46",</code>

<code> "finished": "2024-10-09 13:49:46",</code>

<code> "progress": 0</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса. Метод для использования сервисом ups.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор задания
| colspan="2" style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "success"</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/classify/{id}'''
! colspan="3" style="width: 85%" |Классификация текстовой фразы. В случает если модель была создана из меток в ответе groups и nearest будут пустыми, а ответ будет построен без учета confidenceThreshold из запроса.
В ответе:

*'''classes''' - список , для каждого класса которого отображается название класса, к которому был отнесен текст, и вероятность его принадлежности к этому классу.

*'''groups''' - название группы и число совпавших классов. Если метки совпадают с несколькими группами, они отображаются в порядке убывания числа совпавших классов (т.е. чем полнее группа, тем выше ее позиция в списке).

*'''nearest''' - отображаются группы, до которых не хватает всего одной метки, с указанием процента заполненности и сортировкой по убыванию этого процента.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели

*'''text''' - текст, подлежащий классификации
*'''correction''' - проверять правописание слов и исправлять ошибки

*'''confidenceThreshold''', % - минимальный порог доверия.
| colspan="2" style="width: 50%" |<code>{</code>
<code> "classes": [</code>

<code> {</code>

<code> "class": "название класса",</code>

<code> "confidence": 1</code>

<code> },</code>

<code> {</code>

<code> "class": "название класса 2",</code>

<code> "confidence": 1</code>

<code> }</code>

<code> ],</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "название группы 1",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "название класса", "название класса 2" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "название группы 2",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 1"</code>

<code> },</code>

<code> {</code>

<code> "group": ""название группы 3",</code>

<code> "percent": 0.67,</code>

<code> "need": "название класса которого не хватило 2"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-

! style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.

|-
| colspan="2" style="width: 50%" |
* '''text''' - текст для сжатия

*'''threshold''' - уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |<code>{</code>

<code> "text": "сжатый текст"</code>

<code>}</code>

|-
! style="color:green;width: 15%" |'''POST/smc/copy'''
! colspan="3" style="width: 85%" |Копирование существующей модели

|-
| colspan="2" style="width: 50%" |
* '''source''' - исходная модель
*'''destination''' - целевая модель
*'''backup''' - путь для резервного копирования
*'''remove''' - флаг для удаления исходной модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> { error: INT, message: DESCRIPTION }</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернет текст неизменным.

|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |<code>{</code>
<code> "text": "корректный текст"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/export/{id}'''
! colspan="3" style="width: 85%" |Получение архива модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |ZIP-файл с моделью, либо { error: 1, message: DESCRIPTION }
|-
! style="color:red;width: 15%" |'''DELETE/smc/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/import/{id}'''
! colspan="3" style="width: 85%" |Добавление модели. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''zip-model''' - zip-архив с файлами модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/embedding'''
! colspan="3" style="width: 85%" |
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза
| colspan="2" style="width: 50%" | <code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов ''positive negative neutral.''
|-
| colspan="2" style="width: 50%" |
*'''text''' - фраза для анализа эмоций
| colspan="2" style="width: 50%" |<code>{ "emotion": "positive", "score": 0.9601 }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/errors/{id}'''
! colspan="3" style="width: 85%" |Получение файла с ошибками модели.
|-
| colspan="2" style="width: 50%" |
* '''id''' - идентификатор модели
*'''type''' - тип ошибок, возможные варианты:
'''train''' - ошибки обучения

'''test''' - ошибки тестирования

'''mark''' - ошибки создания модели из меток
| colspan="2" style="width: 50%" |текстовый файл со строками вида:
ИСТИНА<TAB>ОПРЕДЕЛЕНО<TAB>ФРАЗА
|-
! style="color:blue;width: 15%" |'''GET/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат - группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''classes''' — набор меток через запятую
| colspan="2" style="width: 50%" |Результат в виде json.<code>{</code>

<code> "groups": [</code>

<code> {</code>

<code> "group": "Группа 1",</code>

<code> "intersection": 3,</code>

<code> "classes": [ "метка1_о", "метка2_о", "метка3_о"]</code>

<code> },</code>

<code> {</code>

<code> "group": "Группа 2",</code>

<code> "intersection": 2,</code>

<code> "classes": [ "метка1_о", "метка5_о" ]</code>

<code> }</code>

<code> ],</code>

<code> "nearest": [</code>

<code> {</code>

<code> "group": "Группа до которой не хватило 1 метки",</code>

<code> "percent": 0.75,</code>

<code> "need": "недостающая метка_о"</code>

<code> }</code>

<code> ]</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{id}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
*'''groups''' - JSON с новыми группами

* '''csv-file''' - файл с группами
| colspan="2" style="width: 50%" |<code>{ "error": 0,</code><code>"message": "string"</code> <code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Получает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Файл программы обработчика на python
|-
! style="color:red;width: 15%" |'''DELETE/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Удаляет [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/handler/{id}'''
! colspan="3" style="width: 85%" |Устанавливает [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F#%D0%9F%D0%BE%D1%81%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0 постобработчик] модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели

*'''handler''' - файл постобработчика
| colspan="2" style="width: 50%" |<code>{ "error": 0,"message": "string" }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/info/{id}'''
! colspan="3" style="width: 85%" |Получение информации о модели. В результате выполнения будет возвращен массив с данными о модели. Матрица ошибок отдельно содержат классы, определяющие столбцы и строки матрицы, их количество может быть меньше, т.к. в матрицы попадают только те классы, по которым были ошибки.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |На выходе будут следующие параметры:
'''id''' - идентификатор

'''status''' - статус

'''classes''' - список классов в модели

'''groups''' - список групп в модели

'''trainCorpusName''', '''testCorpusName''' - названия файлов, использованных при обучении и тестировании

'''trainAccuracy''', '''testAccuracy''' - точность обучения и тестирования

'''initCorpusLength''' - начальный размер корпуса обучения

'''trainCorpusLength''' - размер корпуса после нормализации и синтеза данных

'''testCorpusLength''' - размер тестового корпуса

'''trainConfusionMatrix''' - матрица ошибок обучения

'''testConfusionMatrix''' - матрица ошибок тестирования
|-
! style="color:blue;width: 15%" |'''GET/smc/log/{id}'''
! colspan="3" style="width: 85%" |Лог всех действий во время обучения/тестирования модели.
|-
| colspan="2" style="width: 50%" |
*'''id''' - наименование модели
| colspan="2" style="width: 50%" |Лог содержится в переменной log в виде списка.

<code>{ </code>

<code>"log": [</code>

<code> "training",</code>

<code> "normalization: 5, model size: 2",</code>

<code> ...</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу -> 25 апреля в 5-м часу
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{"text": "<строка после обратной нормализации>"}</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для обработки
| colspan="2" style="width: 50%" |<code>{ "text": "string" }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/search'''
! colspan="3" style="width: 85%" |Семантический поиск фразы в тексте.
|-
| colspan="2" style="width: 50%" |
*'''phrase''' - искомая фраза

*'''text''' - текст в котором нужно найти фразу
| colspan="2" style="width: 50%" |<code>{</code> <code>"error": 0,</code>

<code> "message": "success",</code>

<code> "similarity": 1,</code>

<code> "fragment": "найденная фраза"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST/smc/stop/{id}'''
! colspan="3" style="width: 85%" | Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
'''id''' - идентификатор модели
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:green;width: 15%" |'''POST/smc/test/{id}'''
! colspan="3" style="width: 85%" | Тестирование модели. Тестируется заранее подготовленным текстовым файлом со строками вида: КЛАСС<TAB>ФРАЗА

Метод асинхронный. Окончание работы проверяется через метод /smc/info/{id}.
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - файл для тестирования
*'''correction''' - исправлять ошибки правописания в файле для тестирования ('''0''' или '''1''')
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
*'''text''' - текстовая строка с высказыванием
| colspan="2" style="width: 50%" |<code>{</code> <code>"insult": 0.13, # оскорбление</code>

<code> "obscenity": 0, # брань</code>

<code> "threat": 0, # угрозы</code>

<code> "politeness": 0.53 вежливость</code>

<code>}</code>
! style="color:green;width: 15%" |'''POST/smc/train/{id}'''
! colspan="3" style="width: 85%" | Обучение модели
|-
| colspan="2" style="width: 50%" |
*'''id''' - идентификатор модели
*'''csv-file''' - текстовый файл для обучения модели или json файл с метками
*'''isMarks''' - если "1" то вместо csv файла корпуса метод ожидает json файл с меткам, формат файла csv-file:{"id": "уникальный идентификатор", "name": "имя набора", "data": [ ["метка1",["синоним1", "еще несколько синонимов через запятую"],порог достоверности], ["еще метка",["синоним", "еще несколько синонимов через запятую"],порог достоверности]]} модель созданная из меток при этом не обучается, созданный файл модели используется для расчетов векторов "на лету" и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками
*'''corpusName''' - наименование имеющегося корпуса данных
*'''corpusData''' - json строка с корпусом данных
| colspan="2" style="width: 50%" |<code>{ error: INT, message: DESCRIPTION }</code>
|-
|}

SMC. Руководство администратора

2026-01-12T08:44:14Z

KorolkovS:

===== '''Общее описание''' =====
Сервис предназначен для анализа и классификации текстовой информации. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.

===== '''Термины и определения''' =====
Simple Message Classifier (SMC) – сервис анализа и классификации.

===== '''Системные требования для SMC''' =====
Для работы smc рекомендуется использовать видеокарту NVIDIA, поддерживающую технологию CUDA и имеющую в составе ядра CUDA.

В случае отсутствия видеокарты для нормальной работы сервиса необходимо обеспечить не менее 8 потоков CPU >= 2.20GHz с поддержкой инструкций AVX2 или новее. В конфигурации 8 потоков Intel(R) Xeon(R) Gold 6148 2.40GHz 6Гб ОЗУ фраза из 10 слов классифицируется 0.2с, соответственно за секунду может быть распознано до 5 фраз, отправленных на распознавание последовательно или одновременно. Увеличение количества ядер/потоков дает прирост производительности, но не прямо пропорциональный.

Оперативной памяти необходимо не менее 4Gb.

Для обучения моделей рекомендуется использовать видеокарту. Обучение модели на корпусе размером 7500 строк занимает на ВМ с 16 ядрами, 16Гб ОЗУ и видеокартой А16 (одном из 4-х ее ядер) около 20 минут. Недостаточная мощность CPU может увеличить время обучения за счет подготовки данных.

===== '''Установка/обновление сервиса SMC''' =====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/smc&fileid=560 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SMC осуществляется скриптом <code>chmod +x ./smc-<версия>-<релиз>.sh && ./smc-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./smc-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/smc</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SMC<code>/opt/smc/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/smc/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/smc/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/smc/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/smc/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/smc/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/smc/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/smc/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable smc.service && sudo systemctl start smc.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status smc.service</code>

Разрешите доступ к порту 6181 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/smc/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "smc", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start smc</code> и извлечь UUID, указанный в файле <code>/opt/smc/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка сервисных моделей SMC''' =====
Установка сервисных моделей возможна только копированием файла(файлов) модели в каталог с названием модели. Названия моделей предопределены и соответствуют их назначению (compressor, correction, embeddings, emotions, normalization, punctuation, toxicity). Установка сервисных моделей невозможна через API, в отличие от моделей классификации.

Модели располагаются в каталоге /opt/smc/pretrained/. Для установки модели необходимо создать каталог /opt/smc/pretrained/<название модели>/ и распаковать в неё архив модели, после чего перезагрузить сервис командой systemctl restart smc.

Проверить корректность работы модели пунктуации можно запросом к API с отправкой текста на распознавание:

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate?text=</nowiki><текст>"</code>

Список всех моделей представлен в таблице:
{| class="wikitable"
|+
!'''Модель'''
!'''Описание'''
!'''Пример запроса к модели'''
!'''Пример ответа от модели'''
|-
|'''embeddings'''
|Языковая, отвечает за вычисление векторов при обучении модели.
|Проверить работу напрямую запросом к API не получится, метод не предусмотрен.
| -
|-
|'''compressor'''
|Модель сжатия фраз. Убирает из фразы слова, не влияющие на ее смысл.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/compress?threshold=30</nowiki>" --data-urlencode "text=как можно было бы получить выплату мне бы" -H "accept: application/json"|jq</code>
|<code>{ "text": "получить выплату мне бы" }</code>
|-
|'''emotions'''
|Анализ эмоций.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/emotion</nowiki>" --data-urlencode "text=спасибо все хорошо" -H "accept: application/json"|jq</code>
|''<code>{ "emotion": "positive", "score": 0.9601 }</code>''
|-
|'''punctuation'''
|Пунктуация.
|Проверить работу можно через API запросом:
''<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/punctuate</nowiki>?" --data-urlencode "text=я пришел как мне получить услугу" -H "accept: application/json"|jq</code>''
|<code>{ "text": "Я пришел. Как мне получить услугу?" }</code>
|-
|'''normalization'''
|Обратная нормализация, заменяет числа прописью на цифры. <blockquote>''Внимание! У модели есть дополнительные требования к модулям Python в файле requirements.txt!''</blockquote>
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/normalize</nowiki>?" --data-urlencode "text=запишите меня к тринадцати" -H "accept: application/json"|jq</code>
|<code>{"text": "запишите меня к 13-ти"}</code>
|-
|'''correction'''
|Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели).
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/correct</nowiki>?" --data-urlencode "text=халодная вода" -H "accept: application/json"|jq</code>
|<code>{"text": "холодная вода"}</code>
|-
|'''toxicity'''
|Анализ текста на невежливость, угрозы, брань.
|Проверить работу можно через API запросом:
<code>curl -s -G -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6181/smc/toxicity</nowiki>?" --data-urlencode "text=нехороший человек" -H "accept: application/json"|jq</code>
Подробнее см в [[SMC. Руководство пользователя|руководстве пользователя]].

| -
|}

'''ВНИМАНИЕ!''' Модели '''punctuation, embeddings, correction''' обязательны для установки, остальные - в зависимости от сценария использования.

===== '''Установка моделей классификации''' =====
Модель классификации — это модель, обученная на определенном наборе данных (корпусе) и предназначенная непосредственно для классификации. Установка модели возможна запросом с помощью методов API. Методы описаны в [https://wiki.connect2ai.net/index.php/SMC._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F руководстве пользователя]. Также модель может быть установлена копированием содержимого каталога /opt/smc/nnets/<имя модели> с одного сервера smc на другой. Внимание! При этом способе UPS, в конфигурационном файле которого указан новый smc, не увидит скопированную модель.

===== '''Конфигурирование параметров сервиса''' =====

Настройка параметров сервиса smc производится в файле /opt/smc/config.json

Описание параметров приведено в таблице
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/smc/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|noise.enabled
|true
|Детекция мусора при классификации (фраз, которые не относятся ни к одному классу)
|-
|noise.threshold
|0.7
|Порог отсева
|-
|devices.productionModel
|cuda:0
| rowspan="9" |Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей. productionModel подразумевает все рабочие модели классификации, которые создаются в системе. Остальные модели — сервисные: embeddingModel — языковая, punctuationModel — пунктуация, emotionsModel — анализ эмоций, compressorModel — модель сжатия фраз, toxicityModel — модель анализа фразы на токсичность. Можно отдельно по названию сервисной модели включать/выключать ее загрузку в GPU. Рабочие модели можно включить в память GPU только все вместе.
|-
|devices.normalizationModel
|cuda:0
|-
|devices.embeddingModel
|cuda:0
|-
|devices.punctuationModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.compressorModel
|cuda:0
|-
|devices.emotionsModel
|cuda:0
|-
|devices.toxicityModel
|cuda:0
|-
|devices.correctionModel
|cuda:0
|-
|cluster.logfile
|logs/sync.log
|путь к логу синхронизации ноды кластера
|-
|cluster.statusFile
|logs/sync.status
|путь к файлу статуса ноды кластера
|-
|cluster.nodes
|[]
|список IP адресов нод кластера
|}

===== '''Работа сервиса через реверс-прокси''' =====
Сервис предполагает передачу больших объемов данных через HTTP. Рекомендуем соответствующим образом настроить конфигурацию сайта в реверс-прокси. Например, в nginx дополнительные параметры:
client_max_body_size 0;
proxy_read_timeout 3h;
large_client_header_buffers 8 256k;

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/smc/logs/log.txt

===== '''Удаление''' =====
Для удаления выполните команду: <code>/opt/smc/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

===== '''Практические рекомендации''' =====
Сервис SMC в работе использует большую языковую модель, которая формирует многомерное семантическое пространство. Смысл фразы для ее классификации вычисляется на основании вектора фразы в этом пространстве. Для производительности таких вычислений рекомендуется использовать GPU с 16 Гб видеопамяти. В случае отсутствия видеокарт рекомендуется использовать не менее 3 серверов по 8 ядер и 16 Гб оперативной памяти. При этом желательно в строке запуска gunicorn в файле сервиса добавить параметр '''«-w 2»'''. Это приведет к загрузке в память 2-х экземпляров приложения и моделей и позволит при высокой нагрузке полностью загрузить процессорные ядра.

В папке /opt/smc/cache/ находится кэш векторов фраз, которые были созданы моделью векторизации. При работе сервиса при наличии вектора в кэше, он берется из него, а не создается моделью заново. Причем остается в ОЗУ тоже, что значительно увеличивает производительность сервиса, однако при прохождении через сервис большого количества различных фраз может привести к потреблению нескольких гигабайт памяти. Необходимо либо увеличить количество ОЗУ, либо просто перезагружать сервис в нерабочее время. Папку cache при желании можно периодически чистить, но в данном случае кэш будет постепенно заполняться заново с использованием GPU.

SPR. Руководство администратора

2026-01-12T08:39:42Z

KorolkovS:

===== '''Общее описание сервиса распознавания речи (SPR)''' =====
Сервис предназначен для преобразования естественной речи в текст. Входными данными для сервиса являются аудиофайлы в формате *.wav, результатом работы выступают данные в текстовом формате.

====='''Термины и определения'''=====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — модель нейронной сети, описывает её архитектуру и конфигурацию, а также используемые алгоритмы обучения.

====='''Расчет нагрузки SPR'''=====
Для нормальной работы сервиса требуются CPU с поддержкой инструкций AVX2 или новее.

Сервис требует разных ресурсов в зависимости от сценария использования.

Распознавание для голосовых помощников — рекомендуется модель common и работа на GPU NVIDIA. Возможна работа на CPU. В этом случае приемлемую задержку распознавания для одиночных фраз можно получить на ВМ с 8 потоками, 6 Гб оперативной памяти с резервом по частоте 9600 МГц (соответствует 4 ядрам по 2,4 ГГц). В этом случае 8-секундная речь будет распознана ориентировочно за 0,8 с. 4 таких ВМ обеспечат распознавание голоса абонента в диалогах длительностью 60–80 с с количеством одновременных диалогов до 60.

В случае использования GPU A16 (одной из 4 голов на ВМ 8 потоков, 6 Гб) 8-секундная речь будет распознана примерно за 0,2 с. На такой ВМ можно распознавать до 100 одновременных диалогов. При расчетах и моделировании предполагалось, что за весь диалог длительностью 60–80 с будет распознано до 6 фраз длительностью до 8 с. GPU A16 содержит 1300 ядер CUDA в одной голове. На более мощных GPU возможности возрастают кратно количеству CUDA ядер.

При распознавании для голосовых помощников рекомендуется использовать от 2-х воркеров gunicorn (-w 2 в строке запуска в файле службы) в зависимости от наличия памяти.

Распознавание для диаризации (транскрибации) длительных переговоров — одновременное, используются модели common и big. Распознавание на CPU в этом режиме не поддерживается. Для распознавания рекомендуется минимум ВМ 8 ядер 16 Гб GPU A16. На такой ВМ время распознавания в 2,5 раза меньше длительности аудио. На GPU V100 время распознавания меньше длительности аудио ориентировочно в 5 раз. Пример распознавания одного и того же файла на разных GPU:
{| class="wikitable" style="text-align: center"
|+
!Карта
!Видеопамять
!Количество ядер CUDA
!Время распознавания
(минут)
!Примечание
|-
|'''<big>A100</big>'''
|80
|6912
|12
|
|-
|'''<big>V100</big>'''
|16
|5120
|16
|
|-
|'''<big>RTX 3060</big>'''
|12
|3584
|24
|
|-
|'''<big>A16</big>'''
|'''16'''
|1280
|33
|1/4 карты
|}

Переключение между режимами распознавания — в зависимости от длительности аудио. Аудио короче 30 с распознаются для голосовых помощников. Остальные аудио разбиваются на фразы и выделяются фрагменты речи, принадлежащие разным лицам, то есть формат вывода тоже изменяется.

Требования к загружаемому аудио

Для преобразования фрагментов речи в текст используйте аудио в форматах, поддерживаемых ffmpeg.

====='''Установка/обновление SPR'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr&fileid=519 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SPR осуществляется скриптом <code>chmod +x ./spr-<версия>-<релиз>.sh && ./spr-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./spr-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/spr</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SPR <code>/opt/spr/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/spr/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/spr/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/spr/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/spr/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/spr/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей),
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/spr/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету),

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable spr.service && sudo systemctl start spr.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status spr.service</code>

Разрешите доступ к порту 6183 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/spr/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "spr", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start spr</code> и извлечь UUID, указанный в файле <code>/opt/spr/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка моделей SPR'''=====
Установка моделей возможна прямым копированием файла модели или загрузкой через API сервиса (метод POST /spr/data/{id}).

Модели располагаются в каталоге /opt/spr/nnets/. Для установки модели необходимо создать каталог /opt/spr/nnets/<название модели>/ и скопировать в него содержимое архива модели, после чего перезагрузить сервис командой systemctl restart spr.

Чтобы убедиться, что модели доступны, выполните запрос

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>"</code>

В ответе должно содержаться название новой модели или перечень названий моделей в формате json.

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/common</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code>

Некоторые модели работают только на GPU. На данный момент такая модель только одна — «big». 

===== '''Внешние модули распознавания''' =====
Сервис SPR поддерживает установку произвольных модулей распознавания. Для этого папка external должна содержать директорию с нужным модулем, в которой обязательным является наличие файла handler.py с функцией recognize(data, sr). Сервис передаст в данную функцию аудиоданные в переменную data, в формате pydub.AudioSegment, а также значение sample rate в переменной sr. Готовые внешние модули распознавания доступны по [https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr ссылке].

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/Имя_Модуля</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code> Со списком методов можно ознакомиться в [[SPR. Руководство пользователя|руководстве пользователя]]. Метод на загрузку модели <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/data/Имя_Модуля</nowiki>" -H "accept: application/json"</code> не работает с модулями в целях безопасности. Также модули не отображаются в списке моделей по запросу <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>" -H "accept: application/json"</code>. В некоторых модулях конфигурация может быть вынесена в отдельный файл. Например, для модуля yandex это - /opt/spr/external/config.json.

===== '''Конфигурирование параметров сервиса SPR'''=====
Настройка параметров сервиса spr производится в файле /opt/spr/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Вычислительное устройство (cpu/cuda:N, где N — номер графического ускорителя), в ОЗУ которого осуществляется загрузка моделей.
|-
|max_gpu_memory
|0.99
|Лимит использования ОЗУ видеокарты.
|-
|punctuation
|false
|Расстановка знаков препинания через [[SMC. Руководство пользователя|сервис SMC]].
|-
|normalization
|false
|Обратная нормализация текста через [[SMC. Руководство пользователя|сервис SMC]].
|-
|toxicity
|false
|Анализ текста на токсичность через [[SMC. Руководство пользователя|сервис SMC]].
|-
|emotions
|false
|Анализ текста на эмоции через [[SMC. Руководство пользователя|сервис SMC]].
|-
|voice_analyzer
|false
|Анализ голоса спикера на эмоции, возраст, пол через [[SBS. Руководство пользователя.|сервис SBS]].
|-
|save_audio_requests
|false
|Записывать аудио получаемые для распознавания в синхронном режиме. Будут сохраняться в /tmp/spr/. Только для диагностики. Не применять в нагруженных серверах.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|cache.lifetime
|604800
|Время жизни кэша результатов отложенного распознавания.
|-
| sbs.url
|<nowiki>http://127.0.0.1:6185</nowiki>
|Путь к [[SBS. Руководство пользователя|сервису биометрии]] для получения метаданных голосового фрагмента.
|-
|sbs.conn_timeout
|2
|Таймаут на подключение к API SBS.
|-
|sbs.read_timeout
|30
|Таймаут на получение ответа от API SBS.
|-
|smc.url
|<nowiki>http://127.0.0.1:6181</nowiki>
|Путь к [[SMC. Руководство пользователя|сервису классификации]] для дополнительной работы с распознанным текстом.
|-
|smc.conn_timeout
|2
|Таймаут на подключение к API SMC.
|-
|smc.read_timeout
|30
|Таймаут на получение ответа от API SMC.
|-
|see.url
|<nowiki>http://127.0.0.1:6184</nowiki>
|Путь к [[SEE. Руководство пользователя|сервису поиска сущностей]] для дополнительной работы с распознанным текстом.
|-
|see.conn_timeout
|2
|Таймаут на подключение к API SEE.
|-
|see.read_timeout
|30
|Таймаут на получение ответа от API SEE.
|-
|vad.default
|webrtc
|Тип VAD по умолчанию для разбивки аудиофайлов. Возможные значения — пока только webrtc.
|-
|vad.maxSilence
|2000
|Длительность паузы в речи в миллисекундах для разбивки длинных аудиофайлов на фрагменты.
|-
|speakers.similarityThreshold
|0.7
|Порог различия для разделения говорящих.
|-
|speakers.maxSpeechLength
|10000
|Максимальная длительность фрагмента для сравнения говорящих в миллисекундах.
|-
|speakers.wordMinLimit
|5
|Минимальный размер фразы при определении говорящих.
|-
|speakers.timeMinLimit
|3000
|Минимальная длительность аудио, чтобы оно могло быть использовано для добавления нового говорящего.
|-
|speakers.batch
|4
|Количество одновременного анализируемых аудиофрагментов при разделении говорящих.
|-
|speakers.concatEqual
|true
|Позволяет склеивать последовательные фразы одного и того же говорящего.
|-
|speakers.defaultModel
|call
|Модель определения говорящего.
|-
|blacklist
|[]
|Список моделей распознавания в папках nnets и external, которые не должны быть загружены при старте сервиса SPR.
|-
|corrections
|{ "big": "common" }
|Добавление модели коррекции для стенографирования.
|-
|garbage
|[ "—", "[*]" ]
|Массив фраз, которые считаются мусорными и откидываются из распознанного текста.
|-
|cluster.logfile
|logs/sync.log
|путь к логу синхронизации ноды кластера
|-
|cluster.statusFile
|logs/sync.status
|путь к файлу статуса ноды кластера
|-
|cluster.nodes
|[]
|список IP адресов нод кластера
|}

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/spr/logs/log.txt 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/spr/uninstall</code>. Команда удалит сервис и рабочий каталог, включая все установленные модели.

====='''Практические рекомендации'''=====
Сервис spr на системах с видеокартой на большой нагрузке может не полностью использовать ресурсы GPU, при этом могут быть задержки в распознавании. Для более полного использования ресурсов рекомендуется в строке запуска gunicorn в файле сервиса добавить параметр «'''-w 2'''». Это приведет к загрузке в видеопамять 2-х экземпляров приложения и моделей. Таким образом приложение сможет более эффективно использовать ресурсы GPU, но при этом возрастет потребность в памяти GPU.

В случае если в системе обработки речи используется несколько несимметричных по ресурсам серверов spr, регулировать нагрузку на них можно указывая адрес сервера, в котором больше ресурсов, большее количество раз в разделе «spr.cluster» конфигурационного файла ups.

UPS. Описание API

2026-01-12T08:08:55Z

KorolkovS:

===== '''Описание часто используемых параметров''' =====
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
|-
|'''servicetype'''
|запрос
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts.
|-
|'''servertype'''
|запрос
|Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы).
|-
|'''model'''
|запрос
|Название модели.
|-
|'''modeltype'''
|запрос
|Тип модели. Возможные значения: '''future''' — планируемая/черновик, '''current''' — текущая/рабочая, '''previous''' — архивная.
|-
|'''error'''
|ответ
|Флаг ошибки.
|-
|'''message'''
|ответ
|Информационное сообщение.
|}

===== '''"/external modules" методы внешних модулей''' =====

В этом разделе будут методы соответствующим образом оформленных [[UPS. Руководство администратора#Установка модулей для UPS|внешних модулей]]

===== '''/auth: методы авторизации''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/auth/access'''
! colspan="3" style="width: 85%" |Получение токенов доступа. Токен доступа определяет, какие из методов будут доступны конкретному пользователю. Формируется на основании роли. Дополнительный входной параметр во всех методах, кроме перечисленных в разделе «nopassword» конфигурационного файла. Время действия токена определяется параметром auth.accessLifeTime конфигурационного файла.
|-
|colspan="2" style="width: 50%" |
* '''username''' — логин

* '''password''' — пароль
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/add'''
! colspan="3" style="width: 85%" |Добавление dataset (набора данных). Dataset (набор данных) используется для ограничения доступа к данным. В ответе метод вернет id созданного набора данных.
|-
|colspan="2" style="width: 50%" |
* data — json строка вида: { "name": "название нового набора" }
|colspan="2" style="width: 50%" |{

"error": 0

"message": "success",

"dataset_id": "XXXXXXXXXXXXX"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/dataset/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление dataset (набора данных).
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/modify/{id}'''
! colspan="3" style="width: 85%" |Переименование dataset (набора данных). Метод меняет все параметры набора данных, но на данный момент времени у набора данных, кроме id, только один параметр — наименование.
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
* '''data''' — JSON c новыми параметрами
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/datasets'''
! colspan="3" style="width: 85%" |Получение списка наборов данных.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXXXXXXXXXX",

"name": "XXX"},

{"id": "0",

"name": "По умолчанию"}

]
|-
!style="color:blue;width: 15%" |'''GET/auth/refresh'''
! colspan="3" style="width: 85%" |Обновление токенов доступа. Время, в течение которого можно обновить доступ, регулируется параметром auth.refreshLifeTime конфигурационного файла. Служебный метод, используется в основном в веб-интерфейсе, чтобы не запрашивать лишний раз пароль.
|-
|colspan="2" style="width: 50%" |
* '''x-refresh-token''' — токен обновления доступа
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/rights'''
! colspan="3" style="width: 85%" |Получение списка прав доступа. Служебный метод — по токену получает название роли и все права доступа этой роли, а также общедоступные методы.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |<<<{ "РОЛЬ": [

 "GET:/......" ],

 "nopassword": [ "GET:/.......",

...............

<<<...............

 "POST:/......." ] }
|-
!style="color:green;width: 15%" |'''POST/auth/role/add'''
! colspan="3" style="width: 85%" |Создание роли. Служебный метод — используется веб-интерфейсом при создании роли.
|-
|colspan="2" style="width: 50%" |
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{

"error": 0, "message": "success", "role_id": "a7e68bb83169f864c2fc868401b5250c"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/role/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление роли.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/role/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение роли. Параметры как при создании роли. Роль будет переписана.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/roles'''
! colspan="3" style="width: 85%" |Получение списка ролей.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[{

"id": "XXXXXXXXXXX",

"name": "имя роли",

"rights": [ "набор прав через запятую" ]

},............]
|-
!style="color:green;width: 15%" |'''POST/auth/user/add'''
! colspan="3" style="width: 85%" |Создание нового пользователя. Метод вернет или id нового пользователя или описание ошибки
|-
|colspan="2" style="width: 50%" |
* '''data''' — json строка {

"username": "login_name", "fullname": "Отображаемое Имя","password": "XXXXX","role": "role_id",

"dataset": "default dataset id", "datasets": [ "dataset id", ................. ] }
|colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"user_id": "XXXXXXXXXXXXXXXX"}
|-
!style="color:red;width: 15%" |'''DELETE/auth/user/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' - идентификатор пользователя
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/user/get/{id}'''
! colspan="3" style="width: 85%" |Получение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2" ] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/info'''
! colspan="3" style="width: 85%" |Получение параметров пользователя по его токену доступа. Служебный метод - для предоставления прав текущему пользователю по его токену
|-
|colspan="2" style="width: 50%" |
* '''x-access-token'''
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/list'''
! colspan="3" style="width: 85%" |Получение списка пользователей с их параметрами. Тоже самое что и в методе GET /auth/user/info, только для всех пользователей
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] },

......

]
|-
!style="color:green;width: 15%" |'''POST/auth/user/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''data''' — параметры пользователя как при создании
* '''id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{ "error": 0,

"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/user/password'''
! colspan="3" style="width: 85%" |Смена пароля пользователя по его токену доступа.
|-
|colspan="2" style="width: 50%" |
* '''password'''
|colspan="2" style="width: 50%" |{ "error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/userlog'''
! colspan="3" style="width: 85%" |Получение действий пользователя за период времени по его токену
|-
|colspan="2" style="width: 50%" |
* '''from''' — начало периода в формате "%Y-%m-%d %H:%M"

* '''to''' — конец периода в формате "%Y-%m-%d %H:%M"
|colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "data": [

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 .........

}
|-
!style="color:blue;width: 15%" |'''GET/auth/version'''
! colspan="3" style="width: 85%" |Получение версии сервиса ups
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |{

 "version": "4.082 release"

}
|}

===== '''/lang: методы мультиязычности''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/lang/'''
! colspan="3" style="width: 85%" |Выводит информацию о переводе элементов интерфейса на текущий язык
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "see":"Сущности",

"smc":"Классификатор",

... }
|-
!style="color:blue;width: 15%" |'''GET/lang/wallpaper'''
! colspan="3" style="width: 85%" |Отдает случайный фон рабочего стола в виде jpeg из каталога «wallpapers» на сервере ups
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |image/jpeg
|}

===== '''/server: получение информации о серверах''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |GET/server/get/addresses/{servicetype}
! colspan="3" style="width: 85%" |Вывод информации о серверах, обслуживающих данный сервис, а также настроенных параметров обращения к данным серверам.
'''trainer''' — сервер обучения, '''cluster''' — рабочие серверы, '''connect''' — время на подключение, '''read''' — время на ответ,

'''failed''' — время пребывания в сбойных, '''install''' — время на установку модели, '''info''' — время на получение информации о модели,

'''counter''' — счетчик запросов, '''current''' — индекс последнего опрошенного cluster-сервера

'''fail''' — массив сбойных серверов со временем постановки в сбой.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",

 "cluster": [ "<nowiki>http://127.0.0.1:6181</nowiki>" ],

 "timers": { "connect": 0.5,

 "read": 1,

 "failed": 600,

 "install": 60,

 "info": 3 },

 "counter": 0,

 "current": 0,

 "fail": {"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678} }
|-
!style="color:blue;width: 15%" |GET/server/get/models/{servicetype}/{servertype}
! colspan="3" style="width: 85%" |Вывод информации о моделях указанного сервиса на каждом сервере указанного типа. Вывод представляет собой массив URL-серверов, для каждого из которых указан список моделей.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса

* '''servertype''' — тип серверов
| colspan="2" style="width: 50%" |{ "<nowiki>http://127.0.0.1:6181</nowiki>": [

 "model1",

 ...

 "modelN"

 ], ... }
|}

===== '''/model: методы работы с моделями''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/model/add/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Создание пустой модели в указанном сервисе. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 30%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 70%" |{

"error":0,

"message":"success"

}
|-
!style="color:green;width: 15%" |'''POST/model/apply/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Применение установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:red;width: 15%" |'''DELETE/model/delete/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/errors/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Запрос на получение списка ошибок модели после тестирования/обучения. Доступен для сервисов see и smc. Ответ содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза).
|-
| colspan="2" style="width: 50%" |
* '''type''' — тип ошибок в выводе
'''- train''' ошибки обучения

'''- test''' ошибки тестирования

'''- mark''' ошибки авторазметки
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[ [true, predicted, phrase],

... ]
|-
!style="color:blue;width: 15%" |'''GET/model/export/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Экспорт модели, модель скачивается в виде zip-архива.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл model.zip, где model — название модели
|-
! style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Удаление постобработчика из модели типа future. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель типа future. Обработчик становится активным сразу после успешной отправки. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из модели типа future.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Удаление постобработчика в указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель указанного типа. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''modeltype''' — тип модели
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:green;width: 15%" |'''POST/model/import/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Импортирует модель в черновик (modeltype=future)
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''zip-model''' — zip с файлами модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}'''
! colspan="3" style="width: 85%" |Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "model1": {

 "previous": null,

 "current": null,

 "future": {

 "status": "empty",

 ...

 } }, ... }
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение информации о каждом типе (modeltype) указанной модели. Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{ "previous": null,

 "current": {

 "status": "trained",

 ... },

 "future": {

 "status": "trained",

 ... } }
|-
!style="color:green;width: 15%" |'''POST/model/install/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Установка импортированной или обученной модели на рабочих серверах.
Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/log/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: '''smc''', '''see'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[

 "training",

 "preparing data",

 "tokenizing",

 ...

]
|-
!style="color:green;width: 15%" |'''POST/model/restore/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так:
* '''current -> future'''
* '''previous -> current'''
* '''null -> previous'''
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|}

===== '''/corpus: работа с данными для обучения моделей''' =====
Методы данного класса предназначены только для сервисов smc и see

{| class="wikitable" style="width: 110%"
|+
!style="color: blue;width: 15%" |'''GET/corpus/automark/list'''
! colspan="3" style="width: 85%" |Перечень заданий автоматической маркировки корпусов.
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "tasks": [ {

 "id": "29d9da98-d6c1-4dc1-bbc9-111309816002",

 "taskname": "test_doc",

 "status": "finished" },

 { "id": "1a5e9bdc-9f98-49d2-84de-1a9bde8fc37c",

 "taskname": "sssss",

 "status": "finished" } ] }
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/result/{id}'''
! colspan="3" style="width: 85%" |Результат выполнения задания на автомаркировку корпуса. Если задание завершено в ответе придет маркированый корпус и время старта и финиша задания
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{
"error": 0,

"message": "success",

"started": "2024-10-09 18:05:51",

"finished": "2024-10-09 18:05:51",

"corpus": [[ [], [ ["тэг"],"фраза 1"]],

[ [], [["тэг"],"фраза 2"]] ]
}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''taskname''' — произвольное имя задания

* '''corpus''' — json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

* '''marks''' — json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

* '''appendMarks''' — "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "уникальный id задания"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — уникальный id задания
| colspan="2" style="width: 50%" |{

 "error": "",

 "status": "finished",

 "started": "2024-10-09 13:49:46",

 "finished": "2024-10-09 13:49:46",

 "progress": 0

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: green;width: 15%" |'''POST/corpus/copy/{servicetype}'''
! colspan="3" style="width: 85%" |Копирование корпуса данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: red;width: 15%" |'''DELETE/corpus/delete/{servicetype}'''
! colspan="3" style="width: 85%" |Удаляет корпус с данными
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: blue;width: 15%" |'''GET/corpus/export/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает текстовый файл с корпусом, содержащий строки вида КЛАСС<TAB>ФРАЗА
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |Файл name.txt
|-
!style="color: blue;width: 15%" |'''GET/corpus/get/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает JSON с данными корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |<code>[</code>
<code> [ "тэг",</code>

<code> "фраза"</code>

<code> ],</code>

<code> ...</code>

<code>]</code>
|-
!style="color: green;width: 15%" |'''POST/corpus/import/{servicetype}'''
! colspan="3" style="width: 85%" |Метод для импорта корпуса данных. Возможен как из текстового файла со строками вида КЛАСС<TAB>ФРАЗА (доступно для smc и see), так и из логов работы системы (только для smc). Если на вход поступил файл csv, происходит импорт из файла, в противном случае — из логов.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''csv''' — файл данных
* '''startDate''' — дата начала выборки, YYYY-MM-DD
* '''stopDate''' — дата окончания выборки, YYYY-MM-DD
* '''model''' — имя модели, из логов которой будет произведен импорт
* '''limit''' — числовое ограничение строк импорта
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/list/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает список всех корпусов данных для указанного типа сервиса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |[ "корпус1",

"корпус2",

 ...]
|-
!style="color: green;width: 15%" |'''POST/corpus/put/{servicetype}'''
! colspan="3" style="width: 85%" |Перезаписывает корпус отправленным массивом данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''json''' — строка формата json с данными. Аналогична выводу метода GET /get/{servicetype}
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: green;width: 15%" |'''POST/corpus/rename/{servicetype}'''
! colspan="3" style="width: 85%" |Переименование корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|}

===== '''/marks: работа с наборами меток в smc''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/marks/add'''
! colspan="3" style="width: 85%" |Добавление набора менток
|-
| colspan="2" style="width: 50%" |
* '''json''' —список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''name''' — имя создаваемого набора
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "132310fa-98c7-4b12-896f-ff113827d077"

}
|-
!style="color:red;width: 15%" |'''DELETE/marks/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление набора меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }

|-
!style="color:blue;width: 15%" |'''GET/marks/export/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде строк
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

метка1 синоним1,синоним2,синоним3,синонимN 0.9

меткаN синоним11,синоним21,синоним31,синонимN1 0.9
|-
!style="color:blue;width: 15%" |'''GET/marks/get/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде json
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "data": [

 ["метка1", [ "синоним1", "синоним2", "синоним3", "синонимN" ],

 0.9

 ],

 ["меткаN", ["синоним11","синоним21", "синоним31","синонимN1"],

 0.9

 ] ] }
|-
!style="color:green;width: 15%" |'''POST/marks/import/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из файла. Набор будет переписан из файла
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл "метка"ТАБ"синонимы через запятую"ТАБ"достоверность(число от 0 до 1)"

* '''id''' — идентификатор набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/marks/list'''
! colspan="3" style="width: 85%" |Получение списка наборов меток
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "result": [ { "id": "416fbe08-19e9-453c-b140-37008a08a76c","name": "test" },

 {"id": "16e77fa2-7c4d-47f9-8644-6385876525d6","name": "Рыжик" },

 {"id": "132310fa-98c7-4b12-896f-ff113827d077", "name": "test" }

 ]}
|-
!style="color:green;width: 15%" |'''POST/marks/put/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из json строки. Набор будет переписан
|-
| colspan="2" style="width: 50%" |
* '''json''' — список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''id''' — идентификатор заменяемого набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:green;width: 15%" |'''POST/marks/rename/{id}'''
! colspan="3" style="width: 85%" |Присваивает новое наименование существующему набору меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
* '''name''' — новое имя набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|}

===== '''/spr: работа с сервисом SPR''' =====

{{:SPR. Руководство пользователя}}

===== '''/smc: работа с сервисом SMC''' =====
{{:SMC. Руководство пользователя}}

!style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для сжатия

* '''threshold''' — уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |{ "text": "сжатый текст"}
|-
!style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернёт текст неизменным.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |{ "text": "корректный текст" }
|-
!style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов: positive, negative, neutral.
|-
| colspan="2" style="width: 50%" |'''text''' — фраза для анализа эмоций
| colspan="2" style="width: 50%" |{ "emotion": "positive", "score": 0.9601 }
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{model}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы из корпуса. Группы в модели будут перезаписаны
|-
| colspan="2" style="width: 50%" |
* '''id''' — наименование модели

* '''corpus''' — наименование корпуса- источника групп
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "string"}
|-
!style="color:blue;width: 15%" |'''GET/smc/groups/{model}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат — группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
* '''classes''' — набор меток через запятую

* '''model''' — имя модели
| colspan="2" style="width: 50%" |{"groups": [

 { "group": "Группа 1",

 "intersection": 3,

 "classes": [

 "метка1_о",

 "метка2_о",

 "метка3_о" ] },

 { "group": "Группа 2",

 "intersection": 2,

 "classes": [

 "метка1_о",

 "метка5_о" ] }],

"nearest": [

 { "group": "Группа до которой не хватило 1 метки",

 "percent": 0.75,

 "need": "недостающая метка_о" } ] }
|-
!style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу — 25 апреля в 5-м часу.
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для обработки.
| colspan="2" style="width: 50%" |{"text": "<строка после обратной нормализации>"}
|-
!style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для обработки.
| colspan="2" style="width: 50%" |{ "text": "string" }
|-
!style="color:green;width: 15%" |'''POST/smc/stop/{model}'''
! colspan="3" style="width: 85%" |Остановка обучения модели. Удаляет тестовую версию модели с сервера обучения, тем самым прерывает обучение.
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "string"}
|-
!style="color:green;width: 15%" |'''POST/smc/test/{model}'''
! colspan="3" style="width: 85%" |Запуск тестирования модели smc. Метод асинхронный, статус тестирования можно запросить методом GET/info/{servicetype}/{model}
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
* '''corpus''' — название корпуса с тестовыми данными
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
* '''text''' — текстовая строка с высказыванием
| colspan="2" style="width: 50%" |{ "insult": 0.13, # оскорбление

 "obscenity": 0, # брань

 "threat": 0, # угрозы

 "politeness": 0.53 вежливость}
|-
!style="color:green;width: 15%" |'''POST/smc/train/{model}'''
! colspan="3" style="width: 85%" |Добавление модели.
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
* '''corpus''' — имя текстового корпуса для обучения модели или имя набора меток
* '''isMarks''' — если «1», то вместо корпуса метод ожидает набор меток. Модель, созданная из меток, при этом не обучается, созданный файл модели используется для расчетов векторов «на лету» и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками.
| colspan="2" style="width: 50%" |{ error: INT, message: DESCRIPTION }
|}

===== '''/see: работа с сервисом SEE''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/see/entities/{model}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* model — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |{ ID-модели: [

{ '''position''': 0, # позиция слова начала фрагмента, определяющего сущность

'''confidence''': 1, #вероятность правильного определения сущности

text: текст сущности,

'''calculated''': vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели }, {...}

] }
|-
!style="color:green;width: 15%" |'''POST/see/stop/{model}'''
! colspan="3" style="width: 85%" |Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color:green;width: 15%" |'''POST/see/train/{model}'''
! colspan="3" style="width: 85%" |Запуск обучения модели '''future'''
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели

* '''corpus''' — название корпуса с данными

* '''noise''' — уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 0
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|}

===== '''/sbs: работа с сервисом SBS''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 20%" |
* '''wav''' — файл для анализа
| colspan="2" style="width: 80%" |Пример:

{ age: {

 class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}

 confidence: 0.99 },

emotion: {

 class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", "NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}

 confidence: 0.99 },

gender: {

 class: FEMALE, # { "MALE", "FEMALE" }

 confidence: 0.99 } }
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:
<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для анализа
*'''threshold''' — порог похожести при поиске, от 0 до 1.
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |Пример ответа:

{ error: 0, speaker: Ivan, confidence: 0.79 }
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{

 "error": 0,

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"

}
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 20%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 80%" |{ error: INT, message: DESCRIPTION }
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |[ {

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",

 "name": "наименование слепка"

 }]
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для обучения
*'''id''' — идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0,

 "message": "Success"}
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0, "confidence": 0.78 }
|}

====='''/tts: методы работы с сервисом tts'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |Простой текст — строки со словом и его интерпретацией с ударением.
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ [ "слово", "замена слова с удар+ением"],

[ "слово2", "замена слова2 с удар+ением"],

...]
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
*'''csv file''' — файл строк со словом и его интерпретацией с ударением.
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "сообщение о статусе результата"}
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка json следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "сообщение о статусе результата"

}
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="3" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
*'''text''' — фраза для нормализации
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "text": "нормализованный текст" }
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="3" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
*'''wav''' — аудиофайл для обработки

*'''revoicer''' — модель модификации голоса
| colspan="2" style="width: 50%" |wav-файл с модифицированным (искаженным) голосом
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ "distortion" ]
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{model}'''
! colspan="3" style="width: 85%" |Синтез звукового файла из текста/
|-
| colspan="2" style="width: 50%" |
*'''ID''' — имя модели
*'''text''' — текст синтезируемой фразы
*'''rate''' — скорость речи
*'''pitch''' — высота (тон)
*'''volume''' — громкость
*'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
*'''format''' - формат файла результата (wav, opus, ogg, mp3)
*'''link''' - если 1, то вернуть только ссылку на файл
| colspan="2" style="width: 50%" |файл с синтезированой фразой
|}

====='''/qas: методы работы с сервисом qas'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/qas/ask'''
! colspan="2" style="width: 85%" |Метод генерирует ответ на поставленный вопрос на основе информации из документов в базе. Ответ на вопрос генерируется на основе информации, содержащейся в одном или нескольких документах. Документы должны быть в текстовом формате. Ответ возвращается в формате JSON, его можно скачать. Если метод не смог найти ответ, возвращается код ошибки и сообщение.
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст вопроса, на основе которого будут искаться фрагменты.
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''maxDocs''' — максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{

"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы*'''mode''' - режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' - генерирует кэш через разные ответы на каждый вопрос по документации
*'''mode''' — режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' — генерирует кэш через разные ответы на каждый вопрос по документации

*'''option''' - {all | empty} обработать все вопросы или только не содержащие ответов
*'''category''' - если указан код категории, то генерация только для этой категории

*'''variants''' - количество ответов, от 1 до 9
*'''replace''' - заменить ответы на сгенерированные
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/status'''
! colspan="2" style="width: 85%" |Состояние генерации ответов на вопросы в кэше. Статусы: '''started''', '''stopped''', если были ошибки, поле ответа '''error''' будет содержать код ошибки.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "started",

 "progress": 33.33}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/stop'''
! colspan="2" style="width: 85%" |Остановить генерацию ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/category/add'''
! colspan="2" style="width: 85%" |Добавить категорию с указанным именем. В ответе — id созданной категории или сообщение об ошибке:
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "id": "ad895085-2e48-439a-831e-b5f699b6a54a" }
|-
! style="color:red;width: 15%" |'''DELETE/qas/category/delete/{id}'''
! colspan="2" style="width: 85%" |Удалить категорию. В ответе или сообщении об успехе, или ошибке, если категория используется или не существует.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/category/list'''
! colspan="2" style="width: 85%" |Получить список категорий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |В ответе json с именами и id категорий
|-
! style="color:green;width: 15%" |'''POST/qas/category/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить категорию. У категории пока есть только наименование, поэтому метод только переименовывает категорию
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/add'''
! colspan="2" style="width: 85%" |Добавление канала. В ответе id созданного канала или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование канала
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "a46fb887-5d98-41e0-8299-bcc94f615e91"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/channel/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление канала
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/channel/list'''
! colspan="2" style="width: 85%" |Получить список всех каналов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": 0,

 "channels": [

 { "id": "1", "name": "voice" },

 { "id": "56442779-e871-43fd-ae4d-caf4ab6d09b9", "name": "канал++" },

 { "id": "0", "name": "default" }

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить канал. У канала пока есть только наименование, поэтому метод только переименовывает канал
|-
| colspan="2" style="width: 50%" |
*'''name''' — новое наименование канала

*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Пример ответа на вопрос "как пройти в библиотеку"{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc/start'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
* '''text -''' текст документа
* '''model''' - какую модель использовать для ответа, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM, необязательный параметр
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/stop'''
! colspan="2" |Остановка очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/status'''
! colspan="2" |Статус очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{
"error": 0,

"status": stopped | started,

"progress": 33.3,

"message": string,

"place": number, #место в очереди

"queue": True | False #состояния - в очереди или в процессе очистки

}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/result'''
! colspan="2" |Результат очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0,"status": "stopped","text": "очищенный текст","doc_id": "ID документа"}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/add'''
! colspan="2" style="width: 85%" |Загрузить текстовый документ. Добавляет документ в базу. В ответе — id созданного документа или сообщение об ошибке.
|-
| colspan="2" style="width: 50%" |
*'''title''' — заголовок документа
*'''category''' — категория документа
*'''text''' — файл документа
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "ebe2bc57551c2d17f892987d1f62306d"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/doc/delete/{id}'''
! colspan="2" style="width: 85%" | Удаление документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка текста документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{

 "error": 0,

 "text": "Здесь будет полный текст документа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/list'''
! colspan="2" style="width: 85%" |Получение списка имеющихся документов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |Пример:

{ "error": 0,

 "docs": [

 {id": "d4999cdee5ad1faf2cb3066ea1b5e96b",

 "title": "PVE. Установка сервисного пакета окружения",

 "category": "Техническая поддержка" },

 {"id": "759042575b965745b9d2af869bca1740",

 "title": "UPS. Руководство администратора",

 "category": "Техническая поддержка"} ]}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modify/{id}'''
! colspan="2" style="width: 85%" |Обновление документа. В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c изменяемыми параметрами документа

<code>{</code>

<code> title: string,</code>

<code> category: string,</code>

<code> text: string</code>

<code>}</code>

параметр который не меняется может отсутствовать в json

*'''id''' — идентификатор документа.
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/replace'''
! colspan="2" style="width: 85%" |Замена подстроки в текстах категории Будут заменены все найденные вхождения
|-
| colspan="2" style="width: 50%" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
| style="width: 50%" |{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modifyphrases'''
! colspan="2" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/gpt/list'''
! colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success", "models": ["default" ]}
|-
! style="color:green;width: 15%" |'''POST/qas/question/add'''
! colspan="2" style="width: 85%" |Добавление вопроса. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса

*'''category''' — id категории к которой относится вопрос

*'''answers''' — ответы в виде Json:

<code>[ { "checked": true, "channel": "0", "answer": "ответ" } ]</code>

*'''aliases''' — вопросы к которым подходят ответы из блока answers в виде json:

<code>["вопрос","еще вопрос"]</code>
| style="width: 50%" |{

 "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:green;width: 15%" |'''POST/qas/question/append/{id}'''
! colspan="2" style="width: 85%" |Добавляет алиасы/кандидаты к другому вопросу
|-
| colspan="2" style="width: 50%" |
*'''aliases''' — JSON list с синонимами

*'''candidates''' JSON list с кандидатами

*'''id''' — идентификатор вопроса к которому добавить синонимы и(или) кандидаты
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/approve/{destination_id}'''
! colspan="2" style="width: 85%" |Перемещает кандидаты в формулировки другого вопроса
|-
| colspan="2" style="width: 50%" |
*'''candidates''' — json массив c текстами кандидатов

*'''destination_id''' — идентификатор вопроса
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/delete/list'''
! colspan="2" style="width: 85%" |Удаление списка вопросов или ответов
|-
| colspan="2" style="width: 50%" |
*'''questions''' — json строка с перечнем id

*'''type''' — выбор, удалять вопросы или ответы ('''questions''', '''answers''')
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:red;width: 15%" |'''DELETE/qas/question/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/question/get/{id}'''
! colspan="2" style="width: 85%" | Получение вопроса вместе с ответами и синонимами вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{ "error": 0,

 "answers": [

 { "checked": true,

 "channel": "0",

 "answer": "ответ" } ],

 "aliases": [

 "вопрос",

 "синоним вопроса",

 "еще синоним вопроса" ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/question/list'''
! colspan="2" style="width: 85%" | Получение списка вопросов.
|-
| colspan="2" style="width: 50%" |
*'''question''' — фильтр вопросов, ограничение списка по вопросам
*'''category''' — фильтр категорий

*'''answer''' — фильтр ответов, ограничение списка по ответам
*'''created''' — фильтр по дате создания, оставляет вопросы, созданные '''не ранее''' указанной даты
*'''createdBefore''' — фильтр по дате создания, оставляет вопросы, созданные '''не позже''' указанной даты
*'''modified''' — фильтр по дате изменения, оставляет вопросы, '''изменённые в точности''' в указанную дату
*'''onlyNew''' - фильтр, оставляющий только новые (необработанные) вопросы
| style="width: 50%" |{ "error": 0,

 "questions": [

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0},

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0}

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/question/modify/{id}'''
! colspan="2" style="width: 85%" |Модификация вопроса. Позволяет заменить как все параметры так и отдельные
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c измененными параметрами, пример полного:

<code>{ "answers": [</code>

<code> {</code>

<code> "checked": true,</code>

<code> "channel": "0",</code>

<code> "answer": "новый ответ"</code>

<code> }</code>

<code> ],</code>

<code>"question":"новый вопрос",</code>

<code>"category": "a3801cc0-f8e5-4f3b-bb10-e42148cd772b",</code>

<code> "aliases": [</code>

<code> "новый вопрос",</code>

<code> "синоним",</code>

<code> "еще синоним"</code>

<code> ]</code>

<code>}</code>

*'''id''' — идентификатор вопроса
| style="width: 50%" |В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.

{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/question/replace'''
! colspan="2" |Поиск и замена подстроки. Будут заменены все найденные вхождения
|-
| colspan="2" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
|{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/question/modifyanswers'''
! colspan="2" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/paraphrase'''
! colspan="2" |Генерация фраз-синонимов для предложения.
|-
| colspan="2" |
*'''text -''' предложение
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "texts": [ "перефразированный текст 1", ... ]}
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/answers'''
! colspan="2" style="width: 85%" |Отображает лог массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |на выходе :
массив из объектов {

 error: number;

 question: string;

 answer: string;

 confidence: number | null;

}
|-
! style="color:green;width: 15%" |'''POST/qas/questionlist/start'''
! colspan="2" style="width: 85%" | Старт массовой обработки вопросов из файла
|-
| colspan="2" style="width: 50%" |
*'''questions''' - файл с вопросами
*'''format''' - в json или в text файл с вопросами
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

— "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''threshold''' - порог достоверности при обработке
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/status'''
! colspan="2" style="width: 85%" |Статус массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;

 status: 'started' | 'stopped';

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/stop'''
! colspan="2" style="width: 85%" |Остановка массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM для анализа на несоответствия, необязательный параметр
*'''asktemplate''' - ID шаблона запроса к LLM для генерации ответов по документу, необязательный параметр
*'''answers''' - тип вопросов, по которым осуществляется поиск несоответствий, необязательный параметр, по умолчанию «all»
|<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/status'''
! colspan="2" style="width: 85%" |Статус поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;<nowiki> status: 'started' | 'stopped';</nowiki>

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/stop'''
! colspan="2" style="width: 85%" |Остановка поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/mismatches'''
| colspan="2" |Статус получения результатов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": 0,"message": "success","mismatches": [{"question_id": "ID вопроса", "question": "вопрос", "category": "ID категории", "answer_id": "ID ответа", "answer": "ответ на вопрос {question}", "description": "результат поиска", "error" : string, "context": "фрагмент документа", "generatedText" : "Результат генерации" }, ... ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/start'''
| colspan="2" |Запуск генерации вопросов
|-
| colspan="2" |
*'''category''' - ID категории, по которой будет происходить генерация вопросов
*'''doc''' - ID документа, по которому будет происходить генерация вопросов
*'''generateAnswers''' - флаг для генерации ответов вместе с вопросами '''[yse|no]''', по умолчанию '''«no»'''
*'''model''' - имя модели GPT, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM для анализа генерации вопросов, необязательный параметр
|{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
| colspan="2" |Статус генерации вопросов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": string, <nowiki>"status": 'started' | 'stopped',</nowiki> "progress": 33.3 }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/stop'''
! colspan="2" style="width: 85%" |Прервать генерацию.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
* '''maxDocs''' - максимальное количество документов одной категории для формирования контекста при поиске ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{ "error": 0,

 "text": "

 Фрагмент 1:Здесь будет текст найденного фрагмента

 Фрагмент 2:Здесь будет текст найденного фрагмента",

 "fragments": [

 { "id": "3a386b0a9e0e19efb0870685e1d0b484",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" },

 { "id": "44fd73ea1ac63f32cf18d79c854dbfe2",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" } ] }
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/add'''
! colspan="2" style="width: 85%" |Добавление шаблона протокола. В случае успеха метод вернет id шаблона, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''name''' — название шаблона

* '''options''' — json словарь с именами разделов и их описанием
| style="width: 50%" |{ "error": 0, "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"}
|-
! style="color:red;width: 15%" |'''DELETEqas/summarization_template/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление шаблона.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/get/{id}'''
! colspan="2" style="width: 85%" |Получение json с шаблоном.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |На выходе словарь, основные элементы: data — словарь с шаблоном, остальные элементы этого уровня служебные. В data: id, name (идентификатор и наименование).И options — словарь с разделами шаблона.
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/list'''
! colspan="2" style="width: 85%" |Получение всех шаблонов.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |На выходе словарь, основной элемент — templates, содержит список шаблонов (каждый шаблон как в выдаче метода GET /qas/summarization_template/get/{id}).
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение шаблона.
|-
| colspan="2" style="width: 50%" |
*'''data''' — словарь как в выдаче метода GET/qas/summarization_template/get/{id}

*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/summarize'''
! colspan="2" style="width: 85%" |Построение протокола или краткого содержания совещания
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст совещания

*'''options''' — словарь с разделами протокола, где ключ — название раздела, значение - краткая инструкция к формированию раздела.
*'''model''' - какую GPT модель использовать для построения протокола, если кроме default используются другие модели

*'''file''' — файл с текстом (текст, csv, pdf или текстовые офисные документы)
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{ "error": 0,
 "message": "success",

 "summary": "здесь текст протокола"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replace'''
! colspan="2" |корректировка информации в тексте при помощи LLM
|-
| colspan="2" |
*'''text''' - текст
*'''oldinfo''' — старая информация
*'''newinfo''' — новая информация
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{ "error": 0, "message": "success",

 "text": "итоговый текст"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replacementlist'''
! colspan="2" |список всех фраз в документах и ответов в вопросах, подлежащих правке. Векторно ищет все фрагменты по указанному тексту.
|-
| colspan="2" |
*'''text''' - текст
*'''category''' — категория, в которой производится векторный поиск
*'''threshold''' — порог похожести, необязательный параметр, если не указан, берется из конфигурационного файла (fragments -> threshold)
*'''answers''' - тип вопросов, по которым осуществляется поиск для внесения правок, необязательный параметр, по умолчанию «all»
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/add'''
! colspan="2" |Добавление шаблона запроса к LLM. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" |
*'''type''' — тип шаблона - chat - произвольный чат, - ask - запрос к документам, - cleandoc - очистка документа, форматирование либо другое преобразование, - similars_generator - генерация синонимичных которотких фраз, - paraphrase - перефразировка текста, - summarize - суммаризация текста (формирование краткой выдержки из текста), - question_generator - генерация вопросов по тексту, - replace - замена информации в тексте, mismatch - поиск несоответствий

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
*'''params''' - параметры запроса к LLM"max_tokens": 4096, "top_k": 30, "top_p": 0.5, "temperature": 0.5, "repeat_penalty": 1.3
|{ "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:red;width: 15%" |'''DELETE/qas/prompt/delete/{id}'''
! colspan="2" |Удаление шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/get/{id}'''
! colspan="2" |Получение шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{ "error": 0, "prompt": {

 "id": "cleandoc",

 "type": "cleandoc",

 "isDefault": false,

 "name": "Чистка документа",

 "prompt": "Удали сноски, колонтитуры и мусорную информацию из текста ниже. Не удаляй ничего лишнего. Не добавляй ничего, только информация из текста. Выведи только конечный результат без отчета о результате.\n###Текст:\n{context}\n\n###Конечный результат:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/list'''
! colspan="2" |Получение списка шаблонов.
|-
| colspan="2" |
|{ "error": 0, "prompts": [

 {

 "id": "chat",

 "type": "chat",

 "isDefault": false,

 "name": "Чат",

 "prompt": "Ты спокойный вежливый консультант.[\n\n###История переписки:\n{history}]\n\n###Вопрос: {question}\n###Ответ:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

 ]

}
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/modify/{id}'''
! colspan="2" |Модификация шаблона. Позволяет заменить как все параметры, так и отдельные.
|-
| colspan="2" |
*'''data''' — json c измененными параметрами:
<code>{ "name": "новое имя" }</code>
*'''id''' — идентификатор вопроса
|В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.{"error": INT, "message": DESCRIPTION}
|}

====='''/ses: методы работы с роботом'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться к продовой версии - нужен постфикс "_prod", для бэкапа "_backup"
актуально для методов

- получения данных робота GET/ses/robot/get/{id}

- применение настроек робота GET/ses/robot/commit/{id}

- экспорт робота GET/ses/robot/export/{id}

- список скриптов GET/ses/robot/script/list/{robot}

- получение скрипта GET/ses/robot/script/get/{robot}/{id}

- список ЭД GET/ses/robot/data/list/{robot}

- получение ЭД GET/ses/robot/data/get/{robot}/{id}

- список КТ GET/ses/robot/endpoint/list/{robot}

- получение КТ GET/ses/robot/endpoint/get/{robot}/{id}

- метода ask (отладчика) POST/ses/ask/{robot_id}

- данные сессии (отладчика) GET/ses/session/{robot_id}/{session_id}
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/audio/{uuid}'''
! colspan="2" style="width: 85%" |Получение аудио-файла из архива диалогов
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |аудио-файл с расширением opus
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/dialog/{uuid}'''
! colspan="2" style="width: 85%" |Получение диалога из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |{ "error": 0, "message": "success",

 "dialog": [{"id": "...", "robot": "...", "channel": "...",

 "unknown": true/false, "closed": true/false, "endpoint": "...",

 "answered": true/false, "models": [...], "variables": {}, "current": {

 "id": "...", "qas": "", "category": "...", "entry": [...],

 "nearest": "...", "missingRunData": [...], "waitingRunData": "...",

 "answered": true/false, "lastreply": "..."},

 "request": {"datetime": "...", "message": "", "data": [...]},

 "reply": {"answers": [{"messages": [...], "voice": "...",

 "interruptible": true/false, "file": null}],

<nowiki> "datetime": "...", "answered": true/false}}]}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/list'''
! colspan="2" style="width: 85%" |Получение списка диалогов из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
*'''startdate''' - начало временного интервала в формате date %Y-%m-%d %H:%M
*'''enddate''' - конец временного интервала в формате date %Y-%m-%d %H:%M
*'''phone''' - номер телефона
*'''variable''' - переменная в формате variable=value
*'''robot''' - идентификатор робота (id)
*'''text''' - фрагмент текста в любом сообщении
*'''data''' - id элемента данных
*'''channel''' - название канала (коннектора)
| style="width: 50%" |[{"uuid": "...", "datetime": "...","phone": "", "channel": [...], "robot": ["..."]}]
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/waveform/{uuid}'''
! colspan="2" style="width: 85%" |Служебный метод для визуализации полученного из архива диалогов аудио-файла, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |[0.016,

0.015,

0.01]
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст запроса

*'''channel''' - id канала

*'''connector''' - имя коннектора

*'''session''' - uuid сессии, если это не первый запрос в сессии

*'''tts''' - вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' - словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''handler''' - python скрипт для изменения ответов метода под требования внешних систем, подробнее в следующем разделе. в поле имя файла без расширения.

*'''restartClosed''' - перезагрузить сессию при её закрытии с новым id (1 - перезагрузить, 0 - не перезагружать)

*'''audio''' - аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''document''' - документ для последующей обработки

*'''robot_id''' - id робота

*'''endpoint''' - id точки, в которую передать управление диалогом (необязательный параметр, используется для исходящих оповещений)
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="2" style="width: 85%" |Создание нового робота. На выходе id созданного робота или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя нового робота
| style="width: 50%" |{ "error": 0, "id": "2fd2f909-2069-4b20-a725-3a598c83f886"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/apply/{id}'''
! colspan="2" style="width: 85%" | Применение робота. Переводит черновик робота в статус prod. Если до этого был prod вариант — становится backup.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/cleardraft/{id}'''
! colspan="2" style="width: 85%" |Обнуление черновика рабочей версией робота

|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": { "id": "id ЭД", "name": "Имя ЭД", "comment": "",

 "type": "...", "rtype": "report", "model": "Имя модели",

 "param": "Ответ", "script": "", "weight": 3,

 "slaveData": [], "getOnlyAsNearest": true/false,

 "injectToMessage": true/false, "longWaiting": true/false,

 "dataWaiting": [], "actions": { "alone": {

<nowiki> "default": [{"action": "say", "type": "random", "text": ["....."]}]}},</nowiki>

<nowiki> "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[ { "id": "3ebfe38b-95bf-4927-a662-17f6e5da22ea",
 "name": "pve", "type": "smc", "rtype": "report",

 "weight": 3, "hasNearestAction": false } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение элемента данных. Формат '''data''' как на выходе метода '''GET/ses/robot/data/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
*'''id''' — идентификатор элемента данных
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление всех версий робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/add/{robot}'''
! colspan="2" style="width: 85%" | Создание конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами конечной точки

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "id": "8576593b-b0d8-4b03-a623-74f3132356ea"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/endpoint/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление конечной точки.
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек конечной точки
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "data": { "id": "...", "name": "...", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка конечных точек робота
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[{ "error": 0, "data": { "id": "...", "name": "точка 1", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "....", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор элемента данных
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="2" style="width: 85%" |Выгрузка робота в архив
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |zip файл с именем = идентификатор робота
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/files/download/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''id''' - идентификатор файла
| style="width: 50%" |файл
|-
! style="color:green;width: 15%" |'''POST/ses/robot/files/upload/{robot}'''
! colspan="2" style="width: 85%" |Отправка файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''file''' - файл
| style="width: 50%" |{"error": 0, "message": "success", "id": "Id файла"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="2" style="width: 85%" | Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": {

 "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78",

 "name": "test", "description": "", "voice": "",

 "session": { "lifetime": 600 },

 "models": {}, "servicedata": {},

 "exceptions": {}, "actions": {},

 "holidays": [], "timeintervals": {

 "name": { "weekdays": [ 1, 2, 3, 4, 5, 6, 7 ],

 "dates": [ 0, 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],

"months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],

<nowiki>"days": "all", "intervals": [ [ 0, 1440 ] ] }}}}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="2" style="width: 85%" |Загрузка архива робота в черновик существующего робота
|-
| colspan="2" style="width: 50%" |
*'''zip —''' файл с архивом робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="2" style="width: 85%" |Получение списка роботов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ { "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78", "name": "test",

 "hasProd": true,

 "hasBackup": true } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение основных настроек робота. Формат '''data''' как в ответе метода '''GET/ses/robot/get/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с новыми настройками робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление нового скрипта. Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/script/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление скрипта
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение текста скрипита
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "data": {

 "id": "6a9f91b6-9634-4079-ac2b-60a944922c61",

"type": "Тип скрипта",

 "name": "Наименование скрипта",

 "code": "Текст скрипта" }

}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка скриптов
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |[ { "id": "9b9d83b7-d5c3-49e6-9bd4-a123a9047939", "name": "наименование1",

 "type": "Тип скрипта"},

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2",

 "type": "Тип скрипта"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение скрипта.Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/test/{robot}/{id}'''
! colspan="2" style="width: 85%" |Тестирование скрипта. Формат '''data''' как в ответе метода '''GET/ses/session/{robot_id}/{session_id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка с параметрами сессии
*'''id''' - идентификатор скрипта
*'''robot''' - идентификатор робота
| style="width: 50%" |<nowiki>{"error": 0, "message": "success", "result": {.....}, "variables": {}}</nowiki>
|-
! style="color:blue;width: 15%" |'''POST/ses/robot/userdata/data/add/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление записи в пользовательский справочник.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "id": "id записи"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/data/delete/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Удаление записи из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/data/list/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Получение данных из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |[{ "колонка 1": "значение 1", "колонка n": "значение n", "id": "id записи"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}'''
! colspan="2" style="width: 85%" | Массовое изменение данных в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Изменение одной записи пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/put/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление данных с заменой в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code> Поле "id" опционально, при его добавлении данные в строке будут заменены.
*'''replace''' - замена всех данных в справочнике новыми данными. Возможные значения: yes/no. По-умолчанию - yes.
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"id": "id справочника", "name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code> Поле "id" опционально.
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |{"error": 0, "id": "id справочника"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/structure/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/structure/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка пользовательских справочников.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |<nowiki>[{"id": "id справочника", "name": "справочник", "fields": {"колонка1": "значение по умолчанию"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Модификация структуры пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code>
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="2" style="width: 85%" |Выдает параметры сессии. Для отображения на боковой панели тестирования в UPS. Основные блоки результата:
|-
| colspan="2" style="width: 50%" |
*'''robot_id''' — id робота

*'''session_id''' — id незакрытой сессии
| style="width: 50%" |{ "started": "", "modified": "",

 "robot": "",

 "session": "",

 "channel": "",

 "connector": "",

 "unknown": true/false,

 "current": {"id": "", "qas": "", "answered": true/false, "category": "",

 "nearest": "", "entry": [.....], "missingRunData": [],

 "passedRunData": [.....], "waitingRunData": null,

 "border": int, "preborder": int, "lastreply": ""},

 "models": [.....],

 "scripts": [.....],

<nowiki> "data": [{"request": {.....}, "reply": {.....}}],</nowiki>

 "timers": [],

 "variables": {},

 "error": "",

 "events": {.....},

 "closed": "" }
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/config'''
! colspan="3" style="width: 85%" |Выдает параметры виджета для web канала по запросу js скрипта
|-
| colspan="2" style="width: 50%" |
*'''token''' — уникальный код виджета, создается при внедрении
| colspan="2" style="width: 50%" |Состав конфига канала, для передачи виджету. Подробней в [https://wiki.connect2ai.net/index.php/SES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B0_%D0%B4%D0%BB%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%B0 Руководстве администратора]
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/js'''
! colspan="3" style="width: 85%" |Выдает код js скрипта виджета для web-канала
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |Код скрипта
|}

====='''/res: методы работы с сервисом отчетов'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/res/dashboards'''
! colspan="3" style="width: 85%" |Получить список рабочих столов kibana с наборами отчетов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |{ "error": 0, "message": "success",

 "dashboards": {

"Наименование1": "https://........",

<nowiki>"Наименование2": "https://........." }}</nowiki>
|}

====='''/transcription: методы работы со стенографией'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/transcription/audio/{id}'''
! colspan="3" style="width: 85%" | Получить аудиофайл по id стенограммы. Идентификатор нужной стенограммы можно получить методом
"GET /transcription/list"
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |wav файл сохраненной стенограммы
|-
! style="color:green;width: 15%" |'''POST/transcription/create'''
! colspan="3" style="width: 85%" |Создание стенограммы из завершенного задания в очереди распознавания. В ответ придет id созданной стенограммы
|-
| colspan="2" style="width: 50%" |
*'''taskID''' — идентификатор задания из очереди

*'''name''' — имя создаваемой стенограммы
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"id": "74721a3b-9055-4650-9afb-de4d103cafc7"}
|-
! style="color:red;width: 15%" |'''DELETE/transcription/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление стенограммы
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/get/{id}'''
! colspan="3" style="width: 85%" |Получение стенограммы. Используется для отображения стенограммы в веб интерфейсе
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |стенограмма в json формате
|-
! style="color:blue;width: 15%" |'''GET/transcription/list'''
! colspan="3" style="width: 85%" |Получение списка сохраненных стенограмм
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ { "id": "926e8d25-4275-4a78-906b-a1109cdacbea",

"name": "название",

"model": "big",

"created": "2024-03-29 12:37:42",

"modified": "2024-04-24 16:09:09",

"user": "0",

"dataset": "0" }, .... ]
|-
! style="color:green;width: 15%" |'''POST/transcription/save/{id}'''
! colspan="3" style="width: 85%" |Сохранение стенограмы. Используется для сохранения изменений по нажатию кнопки «Сохранить».
|-
| colspan="2" style="width: 50%" |
*'''data''' — стенограмма в json формате

*'''id''' стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/waveform/{id}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, ответ содержит пики сигнала
|-
| colspan="2" style="width: 50%" |
*'''id''' стенограммы
| colspan="2" style="width: 50%" |{ "error": 0,

"waveform": [

 0.016,

 ..........

 ..........

 0.015,

 0.01 ] }
|}

UPS. Описание API

2026-01-12T08:07:44Z

KorolkovS:

===== '''Описание часто используемых параметров''' =====
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
|-
|'''servicetype'''
|запрос
|Тип сервиса. Возможные значения: spr, smc, see, sbs, tts.
|-
|'''servertype'''
|запрос
|Тип группы серверов. Возможные значения: trainer (серверы обучения), cluster (рабочие серверы).
|-
|'''model'''
|запрос
|Название модели.
|-
|'''modeltype'''
|запрос
|Тип модели. Возможные значения: '''future''' — планируемая/черновик, '''current''' — текущая/рабочая, '''previous''' — архивная.
|-
|'''error'''
|ответ
|Флаг ошибки.
|-
|'''message'''
|ответ
|Информационное сообщение.
|}

===== '''"/external modules" методы внешних модулей''' =====

В этом разделе будут методы соответствующим образом оформленных [[UPS. Руководство администратора#Установка модулей для UPS|внешних модулей]]

===== '''/auth: методы авторизации''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/auth/access'''
! colspan="3" style="width: 85%" |Получение токенов доступа. Токен доступа определяет, какие из методов будут доступны конкретному пользователю. Формируется на основании роли. Дополнительный входной параметр во всех методах, кроме перечисленных в разделе «nopassword» конфигурационного файла. Время действия токена определяется параметром auth.accessLifeTime конфигурационного файла.
|-
|colspan="2" style="width: 50%" |
* '''username''' — логин

* '''password''' — пароль
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/add'''
! colspan="3" style="width: 85%" |Добавление dataset (набора данных). Dataset (набор данных) используется для ограничения доступа к данным. В ответе метод вернет id созданного набора данных.
|-
|colspan="2" style="width: 50%" |
* data — json строка вида: { "name": "название нового набора" }
|colspan="2" style="width: 50%" |{

"error": 0

"message": "success",

"dataset_id": "XXXXXXXXXXXXX"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/dataset/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление dataset (набора данных).
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:green;width: 15%" |'''POST/auth/dataset/modify/{id}'''
! colspan="3" style="width: 85%" |Переименование dataset (набора данных). Метод меняет все параметры набора данных, но на данный момент времени у набора данных, кроме id, только один параметр — наименование.
|-
|colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора данных
* '''data''' — JSON c новыми параметрами
|colspan="2" style="width: 50%" |{

"error": 0,

"message": "success"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/datasets'''
! colspan="3" style="width: 85%" |Получение списка наборов данных.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXXXXXXXXXX",

"name": "XXX"},

{"id": "0",

"name": "По умолчанию"}

]
|-
!style="color:blue;width: 15%" |'''GET/auth/refresh'''
! colspan="3" style="width: 85%" |Обновление токенов доступа. Время, в течение которого можно обновить доступ, регулируется параметром auth.refreshLifeTime конфигурационного файла. Служебный метод, используется в основном в веб-интерфейсе, чтобы не запрашивать лишний раз пароль.
|-
|colspan="2" style="width: 50%" |
* '''x-refresh-token''' — токен обновления доступа
|colspan="2" style="width: 50%" |{

"x-access-token": "XXXXXXXXXXXXXXXXXXXX",

"x-refresh-token": "XXXXXXXXXXXXXXXXXXXX"

}
|-
!style="color:blue;width: 15%" |'''GET/auth/rights'''
! colspan="3" style="width: 85%" |Получение списка прав доступа. Служебный метод — по токену получает название роли и все права доступа этой роли, а также общедоступные методы.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |<<<{ "РОЛЬ": [

 "GET:/......" ],

 "nopassword": [ "GET:/.......",

...............

<<<...............

 "POST:/......." ] }
|-
!style="color:green;width: 15%" |'''POST/auth/role/add'''
! colspan="3" style="width: 85%" |Создание роли. Служебный метод — используется веб-интерфейсом при создании роли.
|-
|colspan="2" style="width: 50%" |
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{

"error": 0, "message": "success", "role_id": "a7e68bb83169f864c2fc868401b5250c"

}
|-
!style="color:red;width: 15%" |'''DELETE/auth/role/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление роли.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/role/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение роли. Параметры как при создании роли. Роль будет переписана.
|-
|colspan="2" style="width: 50%" |
* '''id''' роли
* '''data''' — JSON с параметрами роли:{

"name": "проверка создания",

"rights": [ "набор прав через запятую" ]

}
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/roles'''
! colspan="3" style="width: 85%" |Получение списка ролей.
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[{

"id": "XXXXXXXXXXX",

"name": "имя роли",

"rights": [ "набор прав через запятую" ]

},............]
|-
!style="color:green;width: 15%" |'''POST/auth/user/add'''
! colspan="3" style="width: 85%" |Создание нового пользователя. Метод вернет или id нового пользователя или описание ошибки
|-
|colspan="2" style="width: 50%" |
* '''data''' — json строка {

"username": "login_name", "fullname": "Отображаемое Имя","password": "XXXXX","role": "role_id",

"dataset": "default dataset id", "datasets": [ "dataset id", ................. ] }
|colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"user_id": "XXXXXXXXXXXXXXXX"}
|-
!style="color:red;width: 15%" |'''DELETE/auth/user/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' - идентификатор пользователя
|colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/auth/user/get/{id}'''
! colspan="3" style="width: 85%" |Получение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''user_id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2" ] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/info'''
! colspan="3" style="width: 85%" |Получение параметров пользователя по его токену доступа. Служебный метод - для предоставления прав текущему пользователю по его токену
|-
|colspan="2" style="width: 50%" |
* '''x-access-token'''
|colspan="2" style="width: 50%" |{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] }
|-
!style="color:blue;width: 15%" |'''GET/auth/user/list'''
! colspan="3" style="width: 85%" |Получение списка пользователей с их параметрами. Тоже самое что и в методе GET /auth/user/info, только для всех пользователей
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |[

{"id": "XXXXXXXXXX",

"username": "loginname",

"fullname": "Full Name",

"role": "0",

"dataset": "0",

"datasets": [ "0", "2dc34d3454243522e5407d3a170815a2"] }, "rights": [..........] },

......

]
|-
!style="color:green;width: 15%" |'''POST/auth/user/modify/{id}'''
! colspan="3" style="width: 85%" |Изменение параметров пользователя
|-
|colspan="2" style="width: 50%" |
* '''data''' — параметры пользователя как при создании
* '''id''' — идентификатор пользователя
|colspan="2" style="width: 50%" |{ "error": 0,

"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/user/password'''
! colspan="3" style="width: 85%" |Смена пароля пользователя по его токену доступа.
|-
|colspan="2" style="width: 50%" |
* '''password'''
|colspan="2" style="width: 50%" |{ "error": 0,"message": "success"}
|-
!style="color:green;width: 15%" |'''POST/auth/userlog'''
! colspan="3" style="width: 85%" |Получение действий пользователя за период времени по его токену
|-
|colspan="2" style="width: 50%" |
* '''from''' — начало периода в формате "%Y-%m-%d %H:%M"

* '''to''' — конец периода в формате "%Y-%m-%d %H:%M"
|colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "data": [

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 [

 "время",

 "id",

 "метод",

 {измененные данные в формате метода}

 ],

 .........

}
|-
!style="color:blue;width: 15%" |'''GET/auth/version'''
! colspan="3" style="width: 85%" |Получение версии сервиса ups
|-
|colspan="2" style="width: 50%" |Нет входных параметров
|colspan="2" style="width: 50%" |{

 "version": "4.082 release"

}
|}

===== '''/lang: методы мультиязычности''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/lang/'''
! colspan="3" style="width: 85%" |Выводит информацию о переводе элементов интерфейса на текущий язык
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "see":"Сущности",

"smc":"Классификатор",

... }
|-
!style="color:blue;width: 15%" |'''GET/lang/wallpaper'''
! colspan="3" style="width: 85%" |Отдает случайный фон рабочего стола в виде jpeg из каталога «wallpapers» на сервере ups
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |image/jpeg
|}

===== '''/server: получение информации о серверах''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |GET/server/get/addresses/{servicetype}
! colspan="3" style="width: 85%" |Вывод информации о серверах, обслуживающих данный сервис, а также настроенных параметров обращения к данным серверам.
'''trainer''' — сервер обучения, '''cluster''' — рабочие серверы, '''connect''' — время на подключение, '''read''' — время на ответ,

'''failed''' — время пребывания в сбойных, '''install''' — время на установку модели, '''info''' — время на получение информации о модели,

'''counter''' — счетчик запросов, '''current''' — индекс последнего опрошенного cluster-сервера

'''fail''' — массив сбойных серверов со временем постановки в сбой.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "trainer": "<nowiki>http://127.0.0.1:6181</nowiki>",

 "cluster": [ "<nowiki>http://127.0.0.1:6181</nowiki>" ],

 "timers": { "connect": 0.5,

 "read": 1,

 "failed": 600,

 "install": 60,

 "info": 3 },

 "counter": 0,

 "current": 0,

 "fail": {"<nowiki>http://127.0.0.1:6181</nowiki>":1686295678} }
|-
!style="color:blue;width: 15%" |GET/server/get/models/{servicetype}/{servertype}
! colspan="3" style="width: 85%" |Вывод информации о моделях указанного сервиса на каждом сервере указанного типа. Вывод представляет собой массив URL-серверов, для каждого из которых указан список моделей.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса

* '''servertype''' — тип серверов
| colspan="2" style="width: 50%" |{ "<nowiki>http://127.0.0.1:6181</nowiki>": [

 "model1",

 ...

 "modelN"

 ], ... }
|}

===== '''/model: методы работы с моделями''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/model/add/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Создание пустой модели в указанном сервисе. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 30%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 70%" |{

"error":0,

"message":"success"

}
|-
!style="color:green;width: 15%" |'''POST/model/apply/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Применение установленной на рабочих серверах модели. После применения модель становится доступна для штатного режима работы. Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:red;width: 15%" |'''DELETE/model/delete/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Полностью удаляет модель из системы и со всех управляемых серверов. Доступно для следующих сервисов: smc, see, spr.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/errors/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Запрос на получение списка ошибок модели после тестирования/обучения. Доступен для сервисов see и smc. Ответ содержит список вложенных списков. В каждом три значения: правильное значение, предсказанное моделью значение и начальные данные (фраза).
|-
| colspan="2" style="width: 50%" |
* '''type''' — тип ошибок в выводе
'''- train''' ошибки обучения

'''- test''' ошибки тестирования

'''- mark''' ошибки авторазметки
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[ [true, predicted, phrase],

... ]
|-
!style="color:blue;width: 15%" |'''GET/model/export/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Экспорт модели, модель скачивается в виде zip-архива.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл model.zip, где model — название модели
|-
! style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Удаление постобработчика из модели типа future. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель типа future. Обработчик становится активным сразу после успешной отправки. Более подробно об обработчике см. руководства пользователя [[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из модели типа future.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:red;width: 15%" |'''DELETE/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Удаление постобработчика в указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:green;width: 15%" |'''POST/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Отправка файла-постобработчика в указанную модель указанного типа. Становится активным сразу после успешной отправки.
|-
| colspan="2" style="width: 50%" |
* '''modeltype''' — тип модели
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''handler''' — файл, содержащий программный код python постобработчика
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
! style="color:blue;width: 15%" |'''GET/model/handler/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Получение файла-постобработчика из указанной модели указанного типа.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |Файл handler.py
|-
!style="color:green;width: 15%" |'''POST/model/import/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Импортирует модель в черновик (modeltype=future)
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''zip-model''' — zip с файлами модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}'''
! colspan="3" style="width: 85%" |Получение информации о всех моделях указанного сервиса. Аналогичен методу GET /info/{servicetype}/{model}, но выводит информацию обо всех моделях.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |{ "model1": {

 "previous": null,

 "current": null,

 "future": {

 "status": "empty",

 ...

 } }, ... }
|-
!style="color:blue;width: 15%" |'''GET/model/info/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Получение информации о каждом типе (modeltype) указанной модели. Итоговый массив содержит переменные типа modeltype, в каждой из который содержится информация о модели.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{ "previous": null,

 "current": {

 "status": "trained",

 ... },

 "future": {

 "status": "trained",

 ... } }
|-
!style="color:green;width: 15%" |'''POST/model/install/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Установка импортированной или обученной модели на рабочих серверах.
Доступно для следующих сервисов: '''smc''', '''see''', '''spr'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{

"error":0,

"message":"success"

}
|-
!style="color:blue;width: 15%" |'''GET/model/log/{servicetype}/{model}/{modeltype}'''
! colspan="3" style="width: 85%" |Выводит лог обучения и тестирования модели. Доступно для следующих сервисов: '''smc''', '''see'''.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
* '''modeltype''' — тип модели
| colspan="2" style="width: 50%" |[

 "training",

 "preparing data",

 "tokenizing",

 ...

]
|-
!style="color:green;width: 15%" |'''POST/model/restore/{servicetype}/{model}'''
! colspan="3" style="width: 85%" |Откат модели. Делает текущую рабочую модель черновиком (future), рабочие серверы после выполнения данного метода продолжают уже с возвращенной моделью. Схематично действия над modeltype в результате выполнения данного метода можно представить так:
* '''current -> future'''
* '''previous -> current'''
* '''null -> previous'''
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''model''' — название модели
| colspan="2" style="width: 50%" |{"error":0,

"message":"success"

}
|}

===== '''/corpus: работа с данными для обучения моделей''' =====
Методы данного класса предназначены только для сервисов smc и see

{| class="wikitable" style="width: 110%"
|+
!style="color: blue;width: 15%" |'''GET/corpus/automark/list'''
! colspan="3" style="width: 85%" |Перечень заданий автоматической маркировки корпусов.
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "tasks": [ {

 "id": "29d9da98-d6c1-4dc1-bbc9-111309816002",

 "taskname": "test_doc",

 "status": "finished" },

 { "id": "1a5e9bdc-9f98-49d2-84de-1a9bde8fc37c",

 "taskname": "sssss",

 "status": "finished" } ] }
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/result/{id}'''
! colspan="3" style="width: 85%" |Результат выполнения задания на автомаркировку корпуса. Если задание завершено в ответе придет маркированый корпус и время старта и финиша задания
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{
"error": 0,

"message": "success",

"started": "2024-10-09 18:05:51",

"finished": "2024-10-09 18:05:51",

"corpus": [[ [], [ ["тэг"],"фраза 1"]],

[ [], [["тэг"],"фраза 2"]] ]
}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/start'''
! colspan="3" style="width: 85%" |Начать автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''taskname''' — произвольное имя задания

* '''corpus''' — json строка с размечаемым корпусом[[ [класс1,... классН], текст ],

[ [класс1,... классН], текст ]]

* '''marks''' — json строка с набором меток [ [ метка, [синоним, синоним2 ... синоним Н], порог ],

[ метка, [синоним, синоним2 ... синоним Н], порог ]]

* '''appendMarks''' — "yes" - дополнить разметку, "no" -заменить разметку
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "уникальный id задания"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/status/{id}'''
! colspan="3" style="width: 85%" |Получить статус задания на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — уникальный id задания
| colspan="2" style="width: 50%" |{

 "error": "",

 "status": "finished",

 "started": "2024-10-09 13:49:46",

 "finished": "2024-10-09 13:49:46",

 "progress": 0

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/automark/stop/{id}'''
! colspan="3" style="width: 85%" |Прервать задание на автоматическую разметку корпуса.
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор задания
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: green;width: 15%" |'''POST/corpus/copy/{servicetype}'''
! colspan="3" style="width: 85%" |Копирование корпуса данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: red;width: 15%" |'''DELETE/corpus/delete/{servicetype}'''
! colspan="3" style="width: 85%" |Удаляет корпус с данными
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color: blue;width: 15%" |'''GET/corpus/export/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает текстовый файл с корпусом, содержащий строки вида КЛАСС<TAB>ФРАЗА
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |Файл name.txt
|-
!style="color: blue;width: 15%" |'''GET/corpus/get/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает JSON с данными корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
| colspan="2" style="width: 50%" |<code>[</code>
<code> [ "тэг",</code>

<code> "фраза"</code>

<code> ],</code>

<code> ...</code>

<code>]</code>
|-
!style="color: green;width: 15%" |'''POST/corpus/import/{servicetype}'''
! colspan="3" style="width: 85%" |Метод для импорта корпуса данных. Возможен как из текстового файла со строками вида КЛАСС<TAB>ФРАЗА (доступно для smc и see), так и из логов работы системы (только для smc). Если на вход поступил файл csv, происходит импорт из файла, в противном случае — из логов.
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''csv''' — файл данных
* '''startDate''' — дата начала выборки, YYYY-MM-DD
* '''stopDate''' — дата окончания выборки, YYYY-MM-DD
* '''model''' — имя модели, из логов которой будет произведен импорт
* '''limit''' — числовое ограничение строк импорта
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: blue;width: 15%" |'''GET/corpus/list/{servicetype}'''
! colspan="3" style="width: 85%" |Возвращает список всех корпусов данных для указанного типа сервиса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
| colspan="2" style="width: 50%" |[ "корпус1",

"корпус2",

 ...]
|-
!style="color: green;width: 15%" |'''POST/corpus/put/{servicetype}'''
! colspan="3" style="width: 85%" |Перезаписывает корпус отправленным массивом данных
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''name''' — название корпуса
* '''json''' — строка формата json с данными. Аналогична выводу метода GET /get/{servicetype}
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|-
!style="color: green;width: 15%" |'''POST/corpus/rename/{servicetype}'''
! colspan="3" style="width: 85%" |Переименование корпуса
|-
| colspan="2" style="width: 50%" |
* '''servicetype''' — тип сервиса
* '''srcname''' — текущее имя
* '''dstname''' — новое имя
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success"

}
|}

===== '''/marks: работа с наборами меток в smc''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/marks/add'''
! colspan="3" style="width: 85%" |Добавление набора менток
|-
| colspan="2" style="width: 50%" |
* '''json''' —список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''name''' — имя создаваемого набора
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "success",

 "id": "132310fa-98c7-4b12-896f-ff113827d077"

}
|-
!style="color:red;width: 15%" |'''DELETE/marks/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление набора меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }

|-
!style="color:blue;width: 15%" |'''GET/marks/export/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде строк
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

метка1 синоним1,синоним2,синоним3,синонимN 0.9

меткаN синоним11,синоним21,синоним31,синонимN1 0.9
|-
!style="color:blue;width: 15%" |'''GET/marks/get/{id}'''
! colspan="3" style="width: 85%" |Получение набора меток в виде json
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "data": [

 ["метка1", [ "синоним1", "синоним2", "синоним3", "синонимN" ],

 0.9

 ],

 ["меткаN", ["синоним11","синоним21", "синоним31","синонимN1"],

 0.9

 ] ] }
|-
!style="color:green;width: 15%" |'''POST/marks/import/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из файла. Набор будет переписан из файла
|-
| colspan="2" style="width: 50%" |
* '''csv''' — файл "метка"ТАБ"синонимы через запятую"ТАБ"достоверность(число от 0 до 1)"

* '''id''' — идентификатор набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/marks/list'''
! colspan="3" style="width: 85%" |Получение списка наборов меток
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" |Пример:

{ "error": 0,

 "message": "success",

 "result": [ { "id": "416fbe08-19e9-453c-b140-37008a08a76c","name": "test" },

 {"id": "16e77fa2-7c4d-47f9-8644-6385876525d6","name": "Рыжик" },

 {"id": "132310fa-98c7-4b12-896f-ff113827d077", "name": "test" }

 ]}
|-
!style="color:green;width: 15%" |'''POST/marks/put/{id}'''
! colspan="3" style="width: 85%" |Импорт в существующий набор меток из json строки. Набор будет переписан
|-
| colspan="2" style="width: 50%" |
* '''json''' — список меток в формате: [ [ "метка1",

 ["синоним1", "синоним2", "синоним3", "синонимN" ], 0.9 # достоверность для метки (0 - 1)

 ], [ "меткаN",

 ["синоним11", "синоним21","синоним31", "синонимN1"], 0.9 # достоверность для метки (0 - 1)

 ] ]

* '''id''' — идентификатор заменяемого набора меток
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:green;width: 15%" |'''POST/marks/rename/{id}'''
! colspan="3" style="width: 85%" |Присваивает новое наименование существующему набору меток
|-
| colspan="2" style="width: 50%" |
* '''id''' — идентификатор набора меток
* '''name''' — новое имя набора
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|}

===== '''/spr: работа с сервисом SPR''' =====

{{:SPR. Руководство пользователя}}

{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/spr/audio/{taskID}'''
! colspan="3" style="width: 85%" |Получение аудиофайла отложенного задания
|-
| colspan="2" style="width: 50%" |
* '''taskID''' — идентификатор задания в очереди/small>
| colspan="2" style="width: 50%" |Wav файл
|-
!style="color:blue;width: 15%" |'''GET/spr/queue'''
! colspan="3" style="width: 85%" |Получение очереди отложенных заданий. Выводит очередь со статусами выполнения заданий. Статусы: '''ready''' — готово, '''waiting''' — ожидание, '''failed''' — сбой
|-
| colspan="2" style="width: 50%" |Нет входных параметров
| colspan="2" style="width: 50%" | { "id задания": {

 "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ",

 "status": "waiting",

 "filename": "wav"}
|-
!style="color:red;width: 15%" |'''DELETE/spr/queue/{taskID}'''
! colspan="3" style="width: 85%" |Удаление задания из очереди
|-
| colspan="2" style="width: 50%" |
* '''taskID''' — идентификатор задания в очереди/small>
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success"}
|-
!style="color:blue;width: 15%" |'''GET/spr/result/{taskID}'''
! colspan="3" style="width: 85%" |получениеПезультатов распознавания отложенного задания. Статусы: '''ready''' — готово, '''waiting''' — ожидание, '''failed''' — сбой, '''not found''' — не найдена
|-
| colspan="2" style="width: 50%" |
* '''taskID''' — идентификатор задания в очереди/small>
| colspan="2" style="width: 50%" |Вывод аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи
|-
!style="color:green;width: 15%" |'''POST/spr/stt/{model}'''
! colspan="3" style="width: 85%" |Отправка файла на распознавание речи. Моно-файлы до 30 секунд распознаются без разбивки на фрагменты. Многоканальные файлы и файлы длиннее 30 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в [[SPR. Руководство администратора.|руководстве администратора]] spr.
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
* '''wav''' — файл для распознавания
* '''speakers''' — опция поиска говорящих по базе SBS. Если 1, то дополнительно производится поиск говорящих и получение метаданных по каждому говорящему (используется сервис SBS с предварительно обученными слепками метаданных говорящих)
* '''punctuation''' — опция для расстановки знаков препинания. Если 1, то дополнительно вызывает метод punctuate в SMC и расставляет знаки препинания в распознанном тексте, значение по умолчанию берётся из файла конфигурации (для модели big пунктуация выполняется в любом случае).
* '''normalization''' — опция обратной нормализации текста, если 1, то выполняется обратная нормализация текста текста (для модели big выполняется в любом случае).
* '''vad''' — используемый VAD, по умолчанию webrtc
* '''toxicity''' — анализировать распознанный текст на токсичность через smc (GET/smc/toxicity).Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:"оскорбление": 0.13, "непристойность": 0, "угроза": 0, "вежливость": 0.53
* '''emotion''' — выявить эмоции из распознанного текста через smc (GET/smc/emotion). Возможные ответы: negative, neutral, positive.
* '''voice_analyzer''' — анализировать аудиофрагменты каждого из говорящих на эмоции, возраст и пол, запрашивается в sbs метод POST/sbs/analyze.Аудио говорящего анализируется на возраст (child, adult, old).Эмоции (ANGER, BORE, DISAPPOINTMENT, DISGUST, EXCITEMENT, FEAR, NEUTRAL, PAIN, PLEASURE, SADNESS, SUPRISE). Пол (male, female).
* '''speaker_counter''' — количество докладчиков, по умолчанию 0, автоматическое определение количества. При отправке значения -1 разделение на докладчиков будет отключено.
* '''async''' — отложенный запуск распознавания
* '''classifiers'''<nowiki> - дополнительно проанализировать все распознанные фразы через модели smc и/или see. отправляется в виде {"smс":"название модели":{ параметры запроса }}. Подробнее о параметрах запроса см. в документации по сервисам </nowiki>[[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].
| colspan="2" style="width: 50%" |В случае '''async=1''' возвращается только '''taskID''', результат по taskID смотреть в методе /spr/result.
'''Для коротких файлов''':

<code>{</code>

<code> "model": "call",</code>

<code> "text": "текст фрагмента",</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "words": [</code>

<code>{ "word": "текст",</code>

<code> "start": 520,</code>

<code> "stop": 1240 },</code>

<code> { "word": "фрагмента",</code>

<code> "start": 1240,</code>

<code> "stop": 1920 }</code>

<code>]</code>

<code>}</code>

'''Для транскрибации больших файлов:'''

<code>{</code>

<code>"speakers": [</code>

<code> {</code>

<code>"id": null,</code>

<code> "duration": 18980,</code>

<code> "fragments": 3,</code>

<code> "age": "old", # только для voice_analyzer=1</code>

<code> "gender": "female" # только для voice_analyzer=1</code>

<code>}</code>

<code>],</code>

<code>"splitted": [</code>

<code> {</code>

<code>"start": "00:00:01.870",</code>

<code> "text": "текст.",</code>

<code> "words": [</code>

<code> {</code>

<code>"word": "текст.",</code>

<code> "start": 1870,</code>

<code> "stop": 2710,</code>

<code> "confidence": 0.95263671875</code>

<code>}</code>

<code>],</code>

<code> "stop": "00:00:05.510",</code>

<code> "channel": 0,</code>

<code> "duration": "00:00:03.640",</code>

<code> "start_ms": 1870,</code>

<code> "stop_ms": 5510,</code>

<code> "duration_ms": 3640,</code>

<code> "speaker": 4,</code>

<code> "speakerConfidence": 0.87,</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "toxicity": { # только для toxicity=1</code>

<code> "insult": 0,</code>

<code> "obscenity": 0,</code>

<code> "threat": 0,</code>

<code> "politeness": 0.99</code>

<code>},</code>

<code> "emotion": { "neutral": -0.3315 }, # только для emotion=1</code>

<code> "voice_analysis": { # только для voice_analyzer=1</code>

<code> "emotion": {</code>

<code> "class": "NEUTRAL",</code>

<code> "confidence": 0.7554781436920166 }</code>

<code>}</code>

<code>}</code>

<code>]</code>

<code>}</code>
|-
!style="color:blue;width: 15%" |'''GET/spr/waveform/{taskID}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
* '''taskID''' — идентификатор задания
| colspan="2" style="width: 50%" |{"error": 0,

"waveform": [

0.016,

 0.015,

 0.01 ] }
|}

===== '''/smc: работа с сервисом SMC''' =====
{{:SMC. Руководство пользователя}}

!style="color:blue;width: 15%" |'''GET/smc/compress'''
! colspan="3" style="width: 85%" |Убирает из фразы слова не влияющие на ее смысл.
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для сжатия

* '''threshold''' — уровень компрессии от 1 до 100. Чем меньше число тем меньше слов будет в итоговой фразе
| colspan="2" style="width: 50%" |{ "text": "сжатый текст"}
|-
!style="color:blue;width: 15%" |'''GET/smc/correct'''
! colspan="3" style="width: 85%" |Коррекция правописания. Изменяет неправильно написанные слова, меняя их на наиболее близкие правильные (из знакомых модели). Если модель коррекции не смогла предложить правильное написание текста, метод вернёт текст неизменным.
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст для коррекции
*'''correction''' - уровень коррекции, от 1 до 3. По умолчанию 1.
*'''model''' - если указано, то при коррекции дополнительно используется словарь модели
| colspan="2" style="width: 50%" |{ "text": "корректный текст" }
|-
!style="color:blue;width: 15%" |'''GET/smc/emotion'''
! colspan="3" style="width: 85%" |Анализ эмоций. На выходе один из вариантов: positive, negative, neutral.
|-
| colspan="2" style="width: 50%" |'''text''' — фраза для анализа эмоций
| colspan="2" style="width: 50%" |{ "emotion": "positive", "score": 0.9601 }
|-
! style="color:green;width: 15%" |'''POST/smc/groups/{model}'''
! colspan="3" style="width: 85%" |Добавляет к модели группы из корпуса. Группы в модели будут перезаписаны
|-
| colspan="2" style="width: 50%" |
* '''id''' — наименование модели

* '''corpus''' — наименование корпуса- источника групп
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "string"}
|-
!style="color:blue;width: 15%" |'''GET/smc/groups/{model}'''
! colspan="3" style="width: 85%" |Поиск групп по ранее полученным меткам. Ищет группы по набору меток. Результат — группы (если найдены) и ближайшие группы с указанием недостающих меток. Позволяет сохранять контекст в виде меток и дозапрашивать группы с учетом контекста.
|-
| colspan="2" style="width: 50%" |
* '''classes''' — набор меток через запятую

* '''model''' — имя модели
| colspan="2" style="width: 50%" |{"groups": [

 { "group": "Группа 1",

 "intersection": 3,

 "classes": [

 "метка1_о",

 "метка2_о",

 "метка3_о" ] },

 { "group": "Группа 2",

 "intersection": 2,

 "classes": [

 "метка1_о",

 "метка5_о" ] }],

"nearest": [

 { "group": "Группа до которой не хватило 1 метки",

 "percent": 0.75,

 "need": "недостающая метка_о" } ] }
|-
!style="color:blue;width: 15%" |'''GET/smc/normalize'''
! colspan="3" style="width: 85%" |Обратная нормализация текста. Пример: двадцать пятого апреля в пятом часу — 25 апреля в 5-м часу.
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для обработки.
| colspan="2" style="width: 50%" |{"text": "<строка после обратной нормализации>"}
|-
!style="color:blue;width: 15%" |'''GET/smc/punctuate'''
! colspan="3" style="width: 85%" |Расстановка знаков препинания
|-
| colspan="2" style="width: 50%" |
* '''text''' — текст для обработки.
| colspan="2" style="width: 50%" |{ "text": "string" }
|-
!style="color:green;width: 15%" |'''POST/smc/stop/{model}'''
! colspan="3" style="width: 85%" |Остановка обучения модели. Удаляет тестовую версию модели с сервера обучения, тем самым прерывает обучение.
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "string"}
|-
!style="color:green;width: 15%" |'''POST/smc/test/{model}'''
! colspan="3" style="width: 85%" |Запуск тестирования модели smc. Метод асинхронный, статус тестирования можно запросить методом GET/info/{servicetype}/{model}
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
* '''corpus''' — название корпуса с тестовыми данными
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
!style="color:blue;width: 15%" |'''GET/smc/toxicity'''
! colspan="3" style="width: 85%" |Определение токсичности высказывания. Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:
|-
| colspan="2" style="width: 50%" |
* '''text''' — текстовая строка с высказыванием
| colspan="2" style="width: 50%" |{ "insult": 0.13, # оскорбление

 "obscenity": 0, # брань

 "threat": 0, # угрозы

 "politeness": 0.53 вежливость}
|-
!style="color:green;width: 15%" |'''POST/smc/train/{model}'''
! colspan="3" style="width: 85%" |Добавление модели.
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
* '''corpus''' — имя текстового корпуса для обучения модели или имя набора меток
* '''isMarks''' — если «1», то вместо корпуса метод ожидает набор меток. Модель, созданная из меток, при этом не обучается, созданный файл модели используется для расчетов векторов «на лету» и выдачи результатов на основании сравнения векторов текста и синонимов из файла с метками.
| colspan="2" style="width: 50%" |{ error: INT, message: DESCRIPTION }
|}

===== '''/see: работа с сервисом SEE''' =====
{| class="wikitable" style="width: 110%"
|+
!style="color:blue;width: 15%" |'''GET/see/entities/{model}'''
! colspan="3" style="width: 85%" |Поиск сущностей. Вернется массив со всеми моделями, в которых были найдены сущности (модели для поиска указываются в поле id). Каждая переменная с названием модели будет содержать список всех найденных сущностей.
|-
| colspan="2" style="width: 50%" |
* model — идентификатор[ы] модели. Может быть указано несколько через запятую, тогда запрос будет обработан всеми указанными моделями.
* text — текст для анализа.
* similarity — порог похожести найденной сущности на эталонные, %. По умолчанию 70.
| colspan="2" style="width: 50%" |{ ID-модели: [

{ '''position''': 0, # позиция слова начала фрагмента, определяющего сущность

'''confidence''': 1, #вероятность правильного определения сущности

text: текст сущности,

'''calculated''': vaktsinatsiya # поле, содержащее значение сущности, использованный при обучении модели }, {...}

] }
|-
!style="color:green;width: 15%" |'''POST/see/stop/{model}'''
! colspan="3" style="width: 85%" |Остановка обучения модели
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|-
!style="color:green;width: 15%" |'''POST/see/train/{model}'''
! colspan="3" style="width: 85%" |Запуск обучения модели '''future'''
|-
| colspan="2" style="width: 50%" |
* '''model''' — идентификатор модели

* '''corpus''' — название корпуса с данными

* '''noise''' — уровень шума для генерации синтезированных данных для обучения модели, от 1 до 5, по умолчанию 0
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success"}
|}

===== '''/sbs: работа с сервисом SBS''' =====

{| class="wikitable" style="width: 110%"
|+
!style="color:green;width: 15%" |'''POST/sbs/analyze'''
! colspan="3" style="width: 85%" |Получение аналитических метаданных из голосового фрагмента. Вернется массив с метаданными голосового фрагмента.
|-
| colspan="2" style="width: 20%" |
* '''wav''' — файл для анализа
| colspan="2" style="width: 80%" |Пример:

{ age: {

 class: 20-29, # {"00-05", "06-12", "13-19", "20-29", "30-39", "40-49", "50-59", "60+"}

 confidence: 0.99 },

emotion: {

 class: SADNESS, # { "ANGER", "BORE", "DISAPPOINTMENT", "DISGUST", "EXCITEMENT", "FEAR", "NEUTRAL", "PAIN", "PLEASURE", "SADNESS", "SUPRISE"}

 confidence: 0.99 },

gender: {

 class: FEMALE, # { "MALE", "FEMALE" }

 confidence: 0.99 } }
|-
! style="color:green;width: 15%" |'''POST/sbs/noiselevel'''
! colspan="3" |Возвращает процент зашумленности аудио
|-
| colspan="2" |
*'''wav''' — файл для анализа
| colspan="2" |Пример ответа:
<code>{ error: 0, message: 'success', 'noise': 0.79 }</code>
|-
! style="color:green;width: 15%" |'''POST/sbs/search'''
! colspan="3" style="width: 85%" |Поиск говорящего по базе слепков.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для анализа
*'''threshold''' — порог похожести при поиске, от 0 до 1.
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |Пример ответа:

{ error: 0, speaker: Ivan, confidence: 0.79 }
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/add'''
! colspan="3" style="width: 85%" |Добавление слепка в базу.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то поиск не будет осуществлен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{

 "error": 0,

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433"

}
|-
! style="color:red;width: 15%" |'''DELETE/sbs/speakers/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление слепка из базы.
|-
| colspan="2" style="width: 20%" |
*'''id''' — идентификатор говорящего
| colspan="2" style="width: 80%" |{ error: INT, message: DESCRIPTION }
|-
! style="color:blue;width: 15%" |'''GET/sbs/speakers/list'''
! colspan="3" style="width: 85%" |Получение списка всех слепков.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |[ {

 "id": "251f78d7-ee50-4ba1-a669-ee89fdaf5433",

 "name": "наименование слепка"

 }]
|-
! style="color:green;width: 15%" |'''POST/sbs/speakers/modify/{id}'''
! colspan="3" style="width: 85%" |Дообучение слепка.
|-
| colspan="2" style="width: 20%" |
*'''wav''' — файл для обучения
*'''id''' — идентификатор слепка
*'''text''' — текст для сравнения с распознанным текстом из wav, необязательный параметр. Если указан, то слепок не будет дообучен, если распознанный текст будет сильно отличаться от text. Для использования необходим сервис spr.
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0,

 "message": "Success"}
|-
! style="color:green;width: 15%" |'''POST/sbs/verify/{id}'''
! colspan="3" style="width: 85%" |Сравнение wav-файла cо слепком в базе. В ответе - вероятность совпадения от 0 до 1.
|-
| colspan="2" style="width: 20%" |
*'''name''' — имя говорящего
*'''wav''' — файл для создания оцифрованного представления говорящего
*'''text''' — текст для сравнения с распознанным текстом из '''wav''', необязательный параметр. Если указан, но слепок не будет создан, если распознанный текст будет сильно отличаться от '''text.'''
*'''textSimilarity''' - порог похожести текста и распознанного аудио
| colspan="2" style="width: 80%" |{ "error": 0, "confidence": 0.78 }
|}

====='''/tts: методы работы с сервисом tts'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений.
|-
| colspan="2" style="width: 20%" |Входные параметры отсутствуют
| colspan="2" style="width: 80%" |Простой текст — строки со словом и его интерпретацией с ударением.
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! colspan="3" style="width: 85%" |Выгрузка пользовательского словаря ударений в виде json.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ [ "слово", "замена слова с удар+ением"],

[ "слово2", "замена слова2 с удар+ением"],

...]
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
*'''csv file''' — файл строк со словом и его интерпретацией с ударением.
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "сообщение о статусе результата"}
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="width: 85%" |Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.
|-
| colspan="2" style="width: 50%" |
* '''json''' — строка json следующего вида:

<code>[</code>

<code>[ "слово", "замена слова с удар+ением" ],</code>

<code>[ "слово2", "замена слова2 с удар+ением" ],</code>

<code>...</code>

<code>]</code>
| colspan="2" style="width: 50%" |{

 "error": 0,

 "message": "сообщение о статусе результата"

}
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! colspan="3" style="width: 85%" |Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».
|-
| colspan="2" style="width: 50%" |
*'''text''' — фраза для нормализации
| colspan="2" style="width: 50%" |{ "error": 0,

 "message": "success",

 "text": "нормализованный текст" }
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! colspan="3" style="width: 85%" |Модификация или искажение голоса
|-
| colspan="2" style="width: 50%" |
*'''wav''' — аудиофайл для обработки

*'''revoicer''' — модель модификации голоса
| colspan="2" style="width: 50%" |wav-файл с модифицированным (искаженным) голосом
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="width: 85%" |Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ "distortion" ]
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{model}'''
! colspan="3" style="width: 85%" |Синтез звукового файла из текста/
|-
| colspan="2" style="width: 50%" |
*'''ID''' — имя модели
*'''text''' — текст синтезируемой фразы
*'''rate''' — скорость речи
*'''pitch''' — высота (тон)
*'''volume''' — громкость
*'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)
*'''format''' - формат файла результата (wav, opus, ogg, mp3)
*'''link''' - если 1, то вернуть только ссылку на файл
| colspan="2" style="width: 50%" |файл с синтезированой фразой
|}

====='''/qas: методы работы с сервисом qas'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/qas/ask'''
! colspan="2" style="width: 85%" |Метод генерирует ответ на поставленный вопрос на основе информации из документов в базе. Ответ на вопрос генерируется на основе информации, содержащейся в одном или нескольких документах. Документы должны быть в текстовом формате. Ответ возвращается в формате JSON, его можно скачать. Если метод не смог найти ответ, возвращается код ошибки и сообщение.
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст вопроса, на основе которого будут искаться фрагменты.
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

- "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''maxDocs''' — максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{

"error": 0,

"text": "Здесь будет текст ответа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/start'''
! colspan="2" style="width: 85%" |Генерация ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |
*'''category''' - категория для которой генерируются ответы*'''mode''' - режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' - генерирует кэш через разные ответы на каждый вопрос по документации
*'''mode''' — режим генерации ответов, возможные значения:'''- paraphrase''' - генерирует вариации ответов перефразированием уже проверенных ответов, если таковые имеются на вопросе'''- generate''' — генерирует кэш через разные ответы на каждый вопрос по документации

*'''option''' - {all | empty} обработать все вопросы или только не содержащие ответов
*'''category''' - если указан код категории, то генерация только для этой категории

*'''variants''' - количество ответов, от 1 до 9
*'''replace''' - заменить ответы на сгенерированные
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/status'''
! colspan="2" style="width: 85%" |Состояние генерации ответов на вопросы в кэше. Статусы: '''started''', '''stopped''', если были ошибки, поле ответа '''error''' будет содержать код ошибки.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": "",

 "status": "started",

 "progress": 33.33}
|-
! style="color:blue;width: 15%" |'''GET/qas/cachemaker/stop'''
! colspan="2" style="width: 85%" |Остановить генерацию ответов на вопросы в кэше.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/category/add'''
! colspan="2" style="width: 85%" |Добавить категорию с указанным именем. В ответе — id созданной категории или сообщение об ошибке:
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success",

 "id": "ad895085-2e48-439a-831e-b5f699b6a54a" }
|-
! style="color:red;width: 15%" |'''DELETE/qas/category/delete/{id}'''
! colspan="2" style="width: 85%" |Удалить категорию. В ответе или сообщении об успехе, или ошибке, если категория используется или не существует.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/category/list'''
! colspan="2" style="width: 85%" |Получить список категорий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |В ответе json с именами и id категорий
|-
! style="color:green;width: 15%" |'''POST/qas/category/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить категорию. У категории пока есть только наименование, поэтому метод только переименовывает категорию
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор категории
*'''name''' — наименование категории
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/add'''
! colspan="2" style="width: 85%" |Добавление канала. В ответе id созданного канала или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — наименование канала
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "a46fb887-5d98-41e0-8299-bcc94f615e91"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/channel/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление канала
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/channel/list'''
! colspan="2" style="width: 85%" |Получить список всех каналов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ "error": 0,

 "channels": [

 { "id": "1", "name": "voice" },

 { "id": "56442779-e871-43fd-ae4d-caf4ab6d09b9", "name": "канал++" },

 { "id": "0", "name": "default" }

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/channel/modify/{id}'''
! colspan="2" style="width: 85%" |Изменить канал. У канала пока есть только наименование, поэтому метод только переименовывает канал
|-
| colspan="2" style="width: 50%" |
*'''name''' — новое наименование канала

*'''id''' — идентификатор канала
| style="width: 50%" |{ "error": 0,

 "message": "success" }
|-
! style="color:green;width: 15%" |'''POST/qas/chat'''
! colspan="2" | Поиск ответа за пределами документов. На стадии разработки, не используется.
|-
| colspan="2" |
*'''text -''' текст вопроса
*'''history''' - история вопросов, будет склеена с text при запросе
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''useInternalTemplate''' - использовать ли шаблон запроса. '''no''' - не использовать, либо код шаблона запроса к LLM. Необязательный параметр. Если не указан, используется шаблон по умолчанию.
*'''params''' - необязательный параметр. JSON с произвольными параметрами запроса к LLM. Описание параметров см. в [[QAS. Руководство администратора|руководстве администратора]].
|Пример ответа на вопрос "как пройти в библиотеку"{"error": 0,

"text": "1. Проверить время работы библиотеки (обычно от 9 до 20)\n2. Проверить местоположение библиотеки на карте или с помощью сервиса Google Maps\n3. Убедиться, что у вас есть необходимые документы для входа (паспорт, карта члена библиотеки и т.д.)\n4. Посетить библиотеку по адресу: [адрес библиотеки]\n5. Проверить правила поведения в библиотеке перед входом" }
|-
! style="color:green;width: 15%" |'''POST/qas/cleandoc/start'''
! colspan="2" |Очистка документа от лишней информации
|-
| colspan="2" |
* '''text -''' текст документа
* '''model''' - какую модель использовать для ответа, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM, необязательный параметр
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/stop'''
! colspan="2" |Остановка очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/status'''
! colspan="2" |Статус очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''user_id''' - ID пользователя
|{
"error": 0,

"status": stopped | started,

"progress": 33.3,

"message": string,

"place": number, #место в очереди

"queue": True | False #состояния - в очереди или в процессе очистки

}
|-
! style="color:blue;width: 15%" | '''GET/qas/cleandoc/result'''
! colspan="2" |Результат очистки документа для конкретного пользователя
|-
| colspan="2" |
* '''doc_id''' - необязательный параметр, ID документа
* '''user_id''' - ID пользователя
|{"error": 0,"status": "stopped","text": "очищенный текст","doc_id": "ID документа"}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/add'''
! colspan="2" style="width: 85%" |Загрузить текстовый документ. Добавляет документ в базу. В ответе — id созданного документа или сообщение об ошибке.
|-
| colspan="2" style="width: 50%" |
*'''title''' — заголовок документа
*'''category''' — категория документа
*'''text''' — файл документа
| style="width: 50%" |{"error": 0,

"message": "success",

"id": "ebe2bc57551c2d17f892987d1f62306d"}
|-
! style="color:red;width: 15%" |'''DELETE/qas/doc/delete/{id}'''
! colspan="2" style="width: 85%" | Удаление документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/get/{id}'''
! colspan="2" style="width: 85%" |Выгрузка текста документа
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор документа
| style="width: 50%" |{

 "error": 0,

 "text": "Здесь будет полный текст документа"

}
|-
! style="color:blue;width: 15%" |'''GET/qas/doc/list'''
! colspan="2" style="width: 85%" |Получение списка имеющихся документов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |Пример:

{ "error": 0,

 "docs": [

 {id": "d4999cdee5ad1faf2cb3066ea1b5e96b",

 "title": "PVE. Установка сервисного пакета окружения",

 "category": "Техническая поддержка" },

 {"id": "759042575b965745b9d2af869bca1740",

 "title": "UPS. Руководство администратора",

 "category": "Техническая поддержка"} ]}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modify/{id}'''
! colspan="2" style="width: 85%" |Обновление документа. В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c изменяемыми параметрами документа

<code>{</code>

<code> title: string,</code>

<code> category: string,</code>

<code> text: string</code>

<code>}</code>

параметр который не меняется может отсутствовать в json

*'''id''' — идентификатор документа.
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/replace'''
! colspan="2" style="width: 85%" |Замена подстроки в текстах категории Будут заменены все найденные вхождения
|-
| colspan="2" style="width: 50%" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
| style="width: 50%" |{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/doc/modifyphrases'''
! colspan="2" |Массовая замена текста в указанных фразах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым фразами следующего вида:
[

{

'doc_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'phrase_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/gpt/list'''
! colspan="2" |Получение списка доступных(установленных) GPT моделей
|-
| colspan="2" |Входные параметры отсутствуют
|{ "error": 0, "message": "success", "models": ["default" ]}
|-
! style="color:green;width: 15%" |'''POST/qas/question/add'''
! colspan="2" style="width: 85%" |Добавление вопроса. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''question''' — текст вопроса

*'''category''' — id категории к которой относится вопрос

*'''answers''' — ответы в виде Json:

<code>[ { "checked": true, "channel": "0", "answer": "ответ" } ]</code>

*'''aliases''' — вопросы к которым подходят ответы из блока answers в виде json:

<code>["вопрос","еще вопрос"]</code>
| style="width: 50%" |{

 "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:green;width: 15%" |'''POST/qas/question/append/{id}'''
! colspan="2" style="width: 85%" |Добавляет алиасы/кандидаты к другому вопросу
|-
| colspan="2" style="width: 50%" |
*'''aliases''' — JSON list с синонимами

*'''candidates''' JSON list с кандидатами

*'''id''' — идентификатор вопроса к которому добавить синонимы и(или) кандидаты
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/approve/{destination_id}'''
! colspan="2" style="width: 85%" |Перемещает кандидаты в формулировки другого вопроса
|-
| colspan="2" style="width: 50%" |
*'''candidates''' — json массив c текстами кандидатов

*'''destination_id''' — идентификатор вопроса
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/question/delete/list'''
! colspan="2" style="width: 85%" |Удаление списка вопросов или ответов
|-
| colspan="2" style="width: 50%" |
*'''questions''' — json строка с перечнем id

*'''type''' — выбор, удалять вопросы или ответы ('''questions''', '''answers''')
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:red;width: 15%" |'''DELETE/qas/question/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/question/get/{id}'''
! colspan="2" style="width: 85%" | Получение вопроса вместе с ответами и синонимами вопроса
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор вопроса
| style="width: 50%" |{ "error": 0,

 "answers": [

 { "checked": true,

 "channel": "0",

 "answer": "ответ" } ],

 "aliases": [

 "вопрос",

 "синоним вопроса",

 "еще синоним вопроса" ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/question/list'''
! colspan="2" style="width: 85%" | Получение списка вопросов.
|-
| colspan="2" style="width: 50%" |
*'''question''' — фильтр вопросов, ограничение списка по вопросам
*'''category''' — фильтр категорий

*'''answer''' — фильтр ответов, ограничение списка по ответам
*'''created''' — фильтр по дате создания, оставляет вопросы, созданные '''не ранее''' указанной даты
*'''createdBefore''' — фильтр по дате создания, оставляет вопросы, созданные '''не позже''' указанной даты
*'''modified''' — фильтр по дате изменения, оставляет вопросы, '''изменённые в точности''' в указанную дату
*'''onlyNew''' - фильтр, оставляющий только новые (необработанные) вопросы
| style="width: 50%" |{ "error": 0,

 "questions": [

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0},

{"id": "","question": "","incomplete": "",

 "aliases": [],"candidates": [],"category": "",

 "checked": 0,"unchecked": 0}

 ] }
|-
! style="color:green;width: 15%" |'''POST/qas/question/modify/{id}'''
! colspan="2" style="width: 85%" |Модификация вопроса. Позволяет заменить как все параметры так и отдельные
|-
| colspan="2" style="width: 50%" |
*'''data''' — json c измененными параметрами, пример полного:

<code>{ "answers": [</code>

<code> {</code>

<code> "checked": true,</code>

<code> "channel": "0",</code>

<code> "answer": "новый ответ"</code>

<code> }</code>

<code> ],</code>

<code>"question":"новый вопрос",</code>

<code>"category": "a3801cc0-f8e5-4f3b-bb10-e42148cd772b",</code>

<code> "aliases": [</code>

<code> "новый вопрос",</code>

<code> "синоним",</code>

<code> "еще синоним"</code>

<code> ]</code>

<code>}</code>

*'''id''' — идентификатор вопроса
| style="width: 50%" |В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.

{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/question/replace'''
! colspan="2" |Поиск и замена подстроки. Будут заменены все найденные вхождения
|-
| colspan="2" |
*'''search''' - искомая подстрока, будет заменена

*'''replace''' - текст замены

*'''category''' - в какой категории искать
|{"error": INT, "message": DESCRIPTION,"replacements":INT}
|-
! style="color:green;width: 15%" |'''POST/qas/question/modifyanswers'''
! colspan="2" |Массовая замена текста в указанных ответах.
|-
| colspan="2" |
*'''phrases''' - JSON массив с изменяемым ответами следующего вида:
[

{

'question_id': 'ad895085-2e48-439a-831e-b5f699b6a54a',

'answer_id': 5,

'text': 'новый текст'

}

]
|{"error": 0,"message": "success"}
|-
! style="color:green;width: 15%" |'''POST/qas/paraphrase'''
! colspan="2" |Генерация фраз-синонимов для предложения.
|-
| colspan="2" |
*'''text -''' предложение
*'''model''' - какую модель использовать для ответа, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{"error": 0, "message": "success", "texts": [ "перефразированный текст 1", ... ]}
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/answers'''
! colspan="2" style="width: 85%" |Отображает лог массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |на выходе :
массив из объектов {

 error: number;

 question: string;

 answer: string;

 confidence: number | null;

}
|-
! style="color:green;width: 15%" |'''POST/qas/questionlist/start'''
! colspan="2" style="width: 85%" | Старт массовой обработки вопросов из файла
|-
| colspan="2" style="width: 50%" |
*'''questions''' - файл с вопросами
*'''format''' - в json или в text файл с вопросами
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''channel''' — id канала
*'''useCache''' — использовать кешированные ответы
возможные варианты:

— "'''no'''" не использовать

- "'''all'''" использовать все

- "'''checked'''" использовать только проверенные
*'''useGPT''' — использовать генеративную сеть для поиска ответов в документах. возможные варианты "'''yes'''" "'''no'''"
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
*'''maxDocs''' - максимальное количество документов одной категории для формирования контекста при генерации ответа на вопрос, по умолчанию 1

*'''addAlias''' — добавлять похожие вопросы к синонимам, не создавая отдельного вопроса. возможные варианты "'''yes'''" "'''no'''"
*'''threshold''' - порог достоверности при обработке
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/status'''
! colspan="2" style="width: 85%" |Статус массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;

 status: 'started' | 'stopped';

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionlist/stop'''
! colspan="2" style="width: 85%" |Остановка массовой обработки вопросов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/qas/mismatchsearcher/start'''
! colspan="2" |Старт поиска несоответствий
|-
| colspan="2" |
*'''category''' — id категории документа. Если не указать категорию, метод вернет ответ на основе всех документов в базе данных. Допускается указание нескольких категорий через разделитель "|".
*'''model''' - имя модели GPT, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM для анализа на несоответствия, необязательный параметр
*'''asktemplate''' - ID шаблона запроса к LLM для генерации ответов по документу, необязательный параметр
*'''answers''' - тип вопросов, по которым осуществляется поиск несоответствий, необязательный параметр, по умолчанию «all»
|<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/status'''
! colspan="2" style="width: 85%" |Статус поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{ error: string;<nowiki> status: 'started' | 'stopped';</nowiki>

 progress: number; }
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/stop'''
! colspan="2" style="width: 85%" |Остановка поиска несоответствий
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |<nowiki>{error: 0 | 1, message: string}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/qas/mismatchsearcher/mismatches'''
| colspan="2" |Статус получения результатов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": 0,"message": "success","mismatches": [{"question_id": "ID вопроса", "question": "вопрос", "category": "ID категории", "answer_id": "ID ответа", "answer": "ответ на вопрос {question}", "description": "результат поиска", "error" : string, "context": "фрагмент документа", "generatedText" : "Результат генерации" }, ... ] }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/start'''
| colspan="2" |Запуск генерации вопросов
|-
| colspan="2" |
*'''category''' - ID категории, по которой будет происходить генерация вопросов
*'''doc''' - ID документа, по которому будет происходить генерация вопросов
*'''generateAnswers''' - флаг для генерации ответов вместе с вопросами '''[yse|no]''', по умолчанию '''«no»'''
*'''model''' - имя модели GPT, если кроме default используются другие модели
* '''template''' - ID шаблона запроса к LLM для анализа генерации вопросов, необязательный параметр
|{ "error": 0, "message": "success" }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/status'''
| colspan="2" |Статус генерации вопросов
|-
| colspan="2" |Входные параметры отсутствуют
|{"error": string, <nowiki>"status": 'started' | 'stopped',</nowiki> "progress": 33.3 }
|-
! style="color:blue;width: 15%" |'''GET/qas/questionmaker/stop'''
! colspan="2" style="width: 85%" |Прервать генерацию.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/qas/search'''
! colspan="2" style="width: 85%" |Поиск фрагментов содержащих ответ
|-
| colspan="2" style="width: 50%" |
*'''text''' — текст запроса

*'''category''' — категория (раздел) знаний. Допускается указание нескольких категорий через разделитель "|".
* '''maxDocs''' - максимальное количество документов одной категории для формирования контекста при поиске ответа на вопрос, по умолчанию 1
*'''similarityArea -''' определяет допустимую разницу между максимальной и минимальной релевантностью фрагментов при фильтрации результатов
| style="width: 50%" |{ "error": 0,

 "text": "

 Фрагмент 1:Здесь будет текст найденного фрагмента

 Фрагмент 2:Здесь будет текст найденного фрагмента",

 "fragments": [

 { "id": "3a386b0a9e0e19efb0870685e1d0b484",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" },

 { "id": "44fd73ea1ac63f32cf18d79c854dbfe2",

 "title": "Заголовок документа",

 "category": "Категория документа",

 "text": "Здесь будет текст найденного фрагмента" } ] }
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/add'''
! colspan="2" style="width: 85%" |Добавление шаблона протокола. В случае успеха метод вернет id шаблона, в случае неудачи — код ошибки.
|-
| colspan="2" style="width: 50%" |
*'''name''' — название шаблона

* '''options''' — json словарь с именами разделов и их описанием
| style="width: 50%" |{ "error": 0, "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"}
|-
! style="color:red;width: 15%" |'''DELETEqas/summarization_template/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление шаблона.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/get/{id}'''
! colspan="2" style="width: 85%" |Получение json с шаблоном.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор шаблона
| style="width: 50%" |На выходе словарь, основные элементы: data — словарь с шаблоном, остальные элементы этого уровня служебные. В data: id, name (идентификатор и наименование).И options — словарь с разделами шаблона.
|-
! style="color:blue;width: 15%" |'''GET/qas/summarization_template/list'''
! colspan="2" style="width: 85%" |Получение всех шаблонов.
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |На выходе словарь, основной элемент — templates, содержит список шаблонов (каждый шаблон как в выдаче метода GET /qas/summarization_template/get/{id}).
|-
! style="color:green;width: 15%" |'''POST/qas/summarization_template/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение шаблона.
|-
| colspan="2" style="width: 50%" |
*'''data''' — словарь как в выдаче метода GET/qas/summarization_template/get/{id}

*'''id''' — идентификатор шаблона
| style="width: 50%" |{"error": INT, "message": DESCRIPTION}
|-
! style="color:green;width: 15%" |'''POST/qas/summarize'''
! colspan="2" style="width: 85%" |Построение протокола или краткого содержания совещания
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст совещания

*'''options''' — словарь с разделами протокола, где ключ — название раздела, значение - краткая инструкция к формированию раздела.
*'''model''' - какую GPT модель использовать для построения протокола, если кроме default используются другие модели

*'''file''' — файл с текстом (текст, csv, pdf или текстовые офисные документы)
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
| style="width: 50%" |{ "error": 0,
 "message": "success",

 "summary": "здесь текст протокола"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replace'''
! colspan="2" |корректировка информации в тексте при помощи LLM
|-
| colspan="2" |
*'''text''' - текст
*'''oldinfo''' — старая информация
*'''newinfo''' — новая информация
*'''model''' - какую модель использовать для генерации, если кроме default используются другие модели
*'''template''' - ID шаблона запроса к LLM, необязательный параметр
|{ "error": 0, "message": "success",

 "text": "итоговый текст"

}
|-
! style="color:green;width: 15%" |'''POST/qas/replacementlist'''
! colspan="2" |список всех фраз в документах и ответов в вопросах, подлежащих правке. Векторно ищет все фрагменты по указанному тексту.
|-
| colspan="2" |
*'''text''' - текст
*'''category''' — категория, в которой производится векторный поиск
*'''threshold''' — порог похожести, необязательный параметр, если не указан, берется из конфигурационного файла (fragments -> threshold)
*'''answers''' - тип вопросов, по которым осуществляется поиск для внесения правок, необязательный параметр, по умолчанию «all»
|[ "error": 0,
"message": "success",
"docs": [],
"answers": []
]
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/add'''
! colspan="2" |Добавление шаблона запроса к LLM. В случае успеха метод вернет id вопроса, в случае неудачи — код ошибки.
|-
| colspan="2" |
*'''type''' — тип шаблона - chat - произвольный чат, - ask - запрос к документам, - cleandoc - очистка документа, форматирование либо другое преобразование, - similars_generator - генерация синонимичных которотких фраз, - paraphrase - перефразировка текста, - summarize - суммаризация текста (формирование краткой выдержки из текста), - question_generator - генерация вопросов по тексту, - replace - замена информации в тексте, mismatch - поиск несоответствий

*'''name''' — название шаблона

*'''prompt''' — текст шаблона

*'''postprompt''' - текст шаблона постобработки результатов (нужен только для summarize)
*'''params''' - параметры запроса к LLM"max_tokens": 4096, "top_k": 30, "top_p": 0.5, "temperature": 0.5, "repeat_penalty": 1.3
|{ "error": 0,

 "id": "527be9f0-f773-4a3e-bd0b-81b40a061d0d"

}
|-
! style="color:red;width: 15%" |'''DELETE/qas/prompt/delete/{id}'''
! colspan="2" |Удаление шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{"error": INT, "message": DESCRIPTION}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/get/{id}'''
! colspan="2" |Получение шаблона.
|-
| colspan="2" |
*'''id''' — идентификатор вопроса
|{ "error": 0, "prompt": {

 "id": "cleandoc",

 "type": "cleandoc",

 "isDefault": false,

 "name": "Чистка документа",

 "prompt": "Удали сноски, колонтитуры и мусорную информацию из текста ниже. Не удаляй ничего лишнего. Не добавляй ничего, только информация из текста. Выведи только конечный результат без отчета о результате.\n###Текст:\n{context}\n\n###Конечный результат:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

}
|-
! style="color:blue;width: 15%" |'''GET/qas/prompt/list'''
! colspan="2" |Получение списка шаблонов.
|-
| colspan="2" |
|{ "error": 0, "prompts": [

 {

 "id": "chat",

 "type": "chat",

 "isDefault": false,

 "name": "Чат",

 "prompt": "Ты спокойный вежливый консультант.[\n\n###История переписки:\n{history}]\n\n###Вопрос: {question}\n###Ответ:",

 "postprompt": "",

 "_modified": 1751475766.7460272,

 "_created": 1751475766.7460272,

 "_modified_date": "2025-07-02",

 "_created_date": "2025-07-02"

 }

 ]

}
|-
! style="color:green;width: 15%" |'''POST/qas/prompt/modify/{id}'''
! colspan="2" |Модификация шаблона. Позволяет заменить как все параметры, так и отдельные.
|-
| colspan="2" |
*'''data''' — json c измененными параметрами:
<code>{ "name": "новое имя" }</code>
*'''id''' — идентификатор вопроса
|В случае успеха метод вернет статус выполнения операции (например, «success»), в случае неудачи — код ошибки.{"error": INT, "message": DESCRIPTION}
|}

====='''/ses: методы работы с роботом'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |для некоторых путей, где используется {robot_id} - это обращение к версии черновика, чтобы обращаться к продовой версии - нужен постфикс "_prod", для бэкапа "_backup"
актуально для методов

- получения данных робота GET/ses/robot/get/{id}

- применение настроек робота GET/ses/robot/commit/{id}

- экспорт робота GET/ses/robot/export/{id}

- список скриптов GET/ses/robot/script/list/{robot}

- получение скрипта GET/ses/robot/script/get/{robot}/{id}

- список ЭД GET/ses/robot/data/list/{robot}

- получение ЭД GET/ses/robot/data/get/{robot}/{id}

- список КТ GET/ses/robot/endpoint/list/{robot}

- получение КТ GET/ses/robot/endpoint/get/{robot}/{id}

- метода ask (отладчика) POST/ses/ask/{robot_id}

- данные сессии (отладчика) GET/ses/session/{robot_id}/{session_id}
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/audio/{uuid}'''
! colspan="2" style="width: 85%" |Получение аудио-файла из архива диалогов
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |аудио-файл с расширением opus
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/dialog/{uuid}'''
! colspan="2" style="width: 85%" |Получение диалога из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |{ "error": 0, "message": "success",

 "dialog": [{"id": "...", "robot": "...", "channel": "...",

 "unknown": true/false, "closed": true/false, "endpoint": "...",

 "answered": true/false, "models": [...], "variables": {}, "current": {

 "id": "...", "qas": "", "category": "...", "entry": [...],

 "nearest": "...", "missingRunData": [...], "waitingRunData": "...",

 "answered": true/false, "lastreply": "..."},

 "request": {"datetime": "...", "message": "", "data": [...]},

 "reply": {"answers": [{"messages": [...], "voice": "...",

 "interruptible": true/false, "file": null}],

<nowiki> "datetime": "...", "answered": true/false}}]}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/list'''
! colspan="2" style="width: 85%" |Получение списка диалогов из архива
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
*'''startdate''' - начало временного интервала в формате date %Y-%m-%d %H:%M
*'''enddate''' - конец временного интервала в формате date %Y-%m-%d %H:%M
*'''phone''' - номер телефона
*'''variable''' - переменная в формате variable=value
*'''robot''' - идентификатор робота (id)
*'''text''' - фрагмент текста в любом сообщении
*'''data''' - id элемента данных
*'''channel''' - название канала (коннектора)
| style="width: 50%" |[{"uuid": "...", "datetime": "...","phone": "", "channel": [...], "robot": ["..."]}]
|-
! style="color:blue;width: 15%" |'''GET/ses/archive/waveform/{uuid}'''
! colspan="2" style="width: 85%" |Служебный метод для визуализации полученного из архива диалогов аудио-файла, содержит пики сигнала.
|-
| colspan="2" style="width: 50%" |
*'''uuid''' - идентификатор диалога
| style="width: 50%" |[0.016,

0.015,

0.01]
|-
! style="color:green;width: 15%" |'''POST/ses/ask/{robot_id}'''
! colspan="2" style="width: 85%" |Получение ответа на запрос пользователя. Метод для отладки робота
|-
| colspan="2" style="width: 50%" |
*'''text''' - текст запроса

*'''channel''' - id канала

*'''connector''' - имя коннектора

*'''session''' - uuid сессии, если это не первый запрос в сессии

*'''tts''' - вернуть результат синтеза (1- вернуть, 0 - не выполнять синтез)

*'''variables''' - словарик с переменными {"переменная1":"значение","переменнаяN":"значение"}

*'''handler''' - python скрипт для изменения ответов метода под требования внешних систем, подробнее в следующем разделе. в поле имя файла без расширения.

*'''restartClosed''' - перезагрузить сессию при её закрытии с новым id (1 - перезагрузить, 0 - не перезагружать)

*'''audio''' - аудиофайл с запросом, текст запроса будет получен распознаванием audio

*'''document''' - документ для последующей обработки

*'''robot_id''' - id робота

*'''endpoint''' - id точки, в которую передать управление диалогом (необязательный параметр, используется для исходящих оповещений)
| style="width: 50%" |{ "error": 0, "question": "Вопрос",

 "answer": [

 { "messages": [

 "ответ" ],

 "voice": "",

 "interruptible": true/false,

"file": "" } ],

 "session": "",

"uuid": "" }
|-
! style="color:green;width: 15%" |'''POST/ses/robot/add'''
! colspan="2" style="width: 85%" |Создание нового робота. На выходе id созданного робота или сообщение об ошибке
|-
| colspan="2" style="width: 50%" |
*'''name''' — имя нового робота
| style="width: 50%" |{ "error": 0, "id": "2fd2f909-2069-4b20-a725-3a598c83f886"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/apply/{id}'''
! colspan="2" style="width: 85%" | Применение робота. Переводит черновик робота в статус prod. Если до этого был prod вариант — становится backup.
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/cleardraft/{id}'''
! colspan="2" style="width: 85%" |Обнуление черновика рабочей версией робота

|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/commit/{id}'''
! colspan="2" style="width: 85%" |Применение текущих изменений настроек робота. Применимо ко всем версиям (черновик, рабочая, резервная копия)
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/data/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек элемента данных
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор элемента данных

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": { "id": "id ЭД", "name": "Имя ЭД", "comment": "",

 "type": "...", "rtype": "report", "model": "Имя модели",

 "param": "Ответ", "script": "", "weight": 3,

 "slaveData": [], "getOnlyAsNearest": true/false,

 "injectToMessage": true/false, "longWaiting": true/false,

 "dataWaiting": [], "actions": { "alone": {

<nowiki> "default": [{"action": "say", "type": "random", "text": ["....."]}]}},</nowiki>

<nowiki> "exceptions": {}}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/data/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка элементов данных
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[ { "id": "3ebfe38b-95bf-4927-a662-17f6e5da22ea",
 "name": "pve", "type": "smc", "rtype": "report",

 "weight": 3, "hasNearestAction": false } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/data/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение элемента данных. Формат '''data''' как на выходе метода '''GET/ses/robot/data/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных

*'''robot''' — идентификатор робота
*'''id''' — идентификатор элемента данных
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/delete/{id}'''
! colspan="2" style="width: 85%" |Удаление всех версий робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/add/{robot}'''
! colspan="2" style="width: 85%" | Создание конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами конечной точки

*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "id": "8576593b-b0d8-4b03-a623-74f3132356ea"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/endpoint/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление конечной точки.
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение настроек конечной точки
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор конечной точки
| style="width: 50%" |{ "error": 0, "data": { "id": "...", "name": "...", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}</nowiki>
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/endpoint/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка конечных точек робота
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
| style="width: 50%" |[{ "error": 0, "data": { "id": "...", "name": "точка 1", "comment": "",

 "entryType": "conditions",

 "entry": [{ "conditions": [{ "type": "...", "depth": 5, "id": "...", "operation": "...", "value": ""}], "run": []}],

 "run": [],

 "actions": { "default": [{ "action": "...", "voice": "....", "type": "...", "interruptible": true/false}]},

<nowiki> "type": "report"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/endpoint/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение конечной точки. Формат '''data''' как на выходе метода '''GET/ses/robot/endpoint/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор элемента данных
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/export/{id}'''
! colspan="2" style="width: 85%" |Выгрузка робота в архив
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |zip файл с именем = идентификатор робота
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/files/download/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''id''' - идентификатор файла
| style="width: 50%" |файл
|-
! style="color:green;width: 15%" |'''POST/ses/robot/files/upload/{robot}'''
! colspan="2" style="width: 85%" |Отправка файла.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота
*'''file''' - файл
| style="width: 50%" |{"error": 0, "message": "success", "id": "Id файла"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/get/{id}'''
! colspan="2" style="width: 85%" | Выгрузка основных настроек робота
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "data": {

 "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78",

 "name": "test", "description": "", "voice": "",

 "session": { "lifetime": 600 },

 "models": {}, "servicedata": {},

 "exceptions": {}, "actions": {},

 "holidays": [], "timeintervals": {

 "name": { "weekdays": [ 1, 2, 3, 4, 5, 6, 7 ],

 "dates": [ 0, 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],

"months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ],

<nowiki>"days": "all", "intervals": [ [ 0, 1440 ] ] }}}}</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/import/{id}'''
! colspan="2" style="width: 85%" |Загрузка архива робота в черновик существующего робота
|-
| colspan="2" style="width: 50%" |
*'''zip —''' файл с архивом робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/list'''
! colspan="2" style="width: 85%" |Получение списка роботов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| style="width: 50%" |[ { "id": "9fd7f6f1-2cac-4f0f-a121-75c40f2b5e78", "name": "test",

 "hasProd": true,

 "hasBackup": true } ]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/modify/{id}'''
! colspan="2" style="width: 85%" |Изменение основных настроек робота. Формат '''data''' как в ответе метода '''GET/ses/robot/get/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с новыми настройками робота
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/restore/{id}'''
! colspan="2" style="width: 85%" |Откат рабочей версии из бэкапа. Резервная копия становится рабочей, и удаляется, а черновик остается без изменений
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление нового скрипта. Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/script/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление скрипта
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/get/{robot}/{id}'''
! colspan="2" style="width: 85%" |Получение текста скрипита
|-
| colspan="2" style="width: 50%" |
*'''robot''' — идентификатор робота
*'''id''' — идентификатор скрипта
| style="width: 50%" |{ "error": 0, "data": {

 "id": "6a9f91b6-9634-4079-ac2b-60a944922c61",

"type": "Тип скрипта",

 "name": "Наименование скрипта",

 "code": "Текст скрипта" }

}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/script/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка скриптов
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор робота
| style="width: 50%" |[ { "id": "9b9d83b7-d5c3-49e6-9bd4-a123a9047939", "name": "наименование1",

 "type": "Тип скрипта"},

 { "id": "48b508ba-a32b-4ada-bcc3-66ce26d81c6a",

 "name": "наименование2",

 "type": "Тип скрипта"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Изменение скрипта.Формат '''data''' как в ответе метода '''GET/ses/robot/script/get/{robot}/{id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' — json строка с параметрами элемента данных
*'''id''' — идентификатор скрипта
*'''robot''' — идентификатор робота
| style="width: 50%" |{ "error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/script/test/{robot}/{id}'''
! colspan="2" style="width: 85%" |Тестирование скрипта. Формат '''data''' как в ответе метода '''GET/ses/session/{robot_id}/{session_id}'''
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка с параметрами сессии
*'''id''' - идентификатор скрипта
*'''robot''' - идентификатор робота
| style="width: 50%" |<nowiki>{"error": 0, "message": "success", "result": {.....}, "variables": {}}</nowiki>
|-
! style="color:blue;width: 15%" |'''POST/ses/robot/userdata/data/add/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление записи в пользовательский справочник.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "id": "id записи"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/data/delete/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Удаление записи из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/data/list/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Получение данных из пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |[{ "колонка 1": "значение 1", "колонка n": "значение n", "id": "id записи"}]
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}'''
! colspan="2" style="width: 85%" | Массовое изменение данных в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/modify/{robot}/{structure}/{id}'''
! colspan="2" style="width: 85%" |Изменение одной записи пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code>{"колонка 1": "значение 1","колонка n":"значение n"}</code>
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
*'''id''' - идентификатор записи (id)
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/data/put/{robot}/{structure}'''
! colspan="2" style="width: 85%" |Добавление данных с заменой в пользовательском справочнике.
|-
| colspan="2" style="width: 50%" |
*'''list''' - json строка в формате <code>[{"колонка 1": "значение 1","колонка n": "значение n", "id": "id строки"}]</code> Поле "id" опционально, при его добавлении данные в строке будут заменены.
*'''replace''' - замена всех данных в справочнике новыми данными. Возможные значения: yes/no. По-умолчанию - yes.
*'''robot''' - идентификатор робота (id)
*'''structure''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/add/{robot}'''
! colspan="2" style="width: 85%" |Добавление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"id": "id справочника", "name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code> Поле "id" опционально.
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |{"error": 0, "id": "id справочника"}
|-
! style="color:red;width: 15%" |'''DELETE/ses/robot/userdata/structure/delete/{robot}/{id}'''
! colspan="2" style="width: 85%" |Удаление пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/robot/userdata/structure/list/{robot}'''
! colspan="2" style="width: 85%" |Получение списка пользовательских справочников.
|-
| colspan="2" style="width: 50%" |
*'''robot''' - идентификатор робота (id)
| style="width: 50%" |<nowiki>[{"id": "id справочника", "name": "справочник", "fields": {"колонка1": "значение по умолчанию"}}]</nowiki>
|-
! style="color:green;width: 15%" |'''POST/ses/robot/userdata/structure/modify/{robot}/{id}'''
! colspan="2" style="width: 85%" |Модификация структуры пользовательского справочника.
|-
| colspan="2" style="width: 50%" |
*'''data''' - json строка в формате <code><nowiki>{"name": "справочник", "fields": {"колонка 1": "значение по умолчанию","колонка n":"значение по умолчанию"}}.</nowiki></code>
*'''robot''' - идентификатор робота (id)
*'''id''' - идентификатор пользовательского справочника
| style="width: 50%" |{"error": 0, "message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/ses/session/{robot_id}/{session_id}'''
! colspan="2" style="width: 85%" |Выдает параметры сессии. Для отображения на боковой панели тестирования в UPS. Основные блоки результата:
|-
| colspan="2" style="width: 50%" |
*'''robot_id''' — id робота

*'''session_id''' — id незакрытой сессии
| style="width: 50%" |{ "started": "", "modified": "",

 "robot": "",

 "session": "",

 "channel": "",

 "connector": "",

 "unknown": true/false,

 "current": {"id": "", "qas": "", "answered": true/false, "category": "",

 "nearest": "", "entry": [.....], "missingRunData": [],

 "passedRunData": [.....], "waitingRunData": null,

 "border": int, "preborder": int, "lastreply": ""},

 "models": [.....],

 "scripts": [.....],

<nowiki> "data": [{"request": {.....}, "reply": {.....}}],</nowiki>

 "timers": [],

 "variables": {},

 "error": "",

 "events": {.....},

 "closed": "" }
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/config'''
! colspan="3" style="width: 85%" |Выдает параметры виджета для web канала по запросу js скрипта
|-
| colspan="2" style="width: 50%" |
*'''token''' — уникальный код виджета, создается при внедрении
| colspan="2" style="width: 50%" |Состав конфига канала, для передачи виджету. Подробней в [https://wiki.connect2ai.net/index.php/SES._%D0%A0%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0#%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B0_%D0%B4%D0%BB%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%B0 Руководстве администратора]
|-
! style="color:blue;width: 15%" |'''GET/ses/widget/js'''
! colspan="3" style="width: 85%" |Выдает код js скрипта виджета для web-канала
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |Код скрипта
|}

====='''/res: методы работы с сервисом отчетов'''=====

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/res/dashboards'''
! colspan="3" style="width: 85%" |Получить список рабочих столов kibana с наборами отчетов
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |{ "error": 0, "message": "success",

 "dashboards": {

"Наименование1": "https://........",

<nowiki>"Наименование2": "https://........." }}</nowiki>
|}

====='''/transcription: методы работы со стенографией'''=====

{| class="wikitable" style="width: 110%"
|+
! style="color:blue;width: 15%" |'''GET/transcription/audio/{id}'''
! colspan="3" style="width: 85%" | Получить аудиофайл по id стенограммы. Идентификатор нужной стенограммы можно получить методом
"GET /transcription/list"
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |wav файл сохраненной стенограммы
|-
! style="color:green;width: 15%" |'''POST/transcription/create'''
! colspan="3" style="width: 85%" |Создание стенограммы из завершенного задания в очереди распознавания. В ответ придет id созданной стенограммы
|-
| colspan="2" style="width: 50%" |
*'''taskID''' — идентификатор задания из очереди

*'''name''' — имя создаваемой стенограммы
| colspan="2" style="width: 50%" |{"error": 0,

"message": "success",

"id": "74721a3b-9055-4650-9afb-de4d103cafc7"}
|-
! style="color:red;width: 15%" |'''DELETE/transcription/delete/{id}'''
! colspan="3" style="width: 85%" |Удаление стенограммы
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/get/{id}'''
! colspan="3" style="width: 85%" |Получение стенограммы. Используется для отображения стенограммы в веб интерфейсе
|-
| colspan="2" style="width: 50%" |
*'''id''' — идентификатор стенограммы
| colspan="2" style="width: 50%" |стенограмма в json формате
|-
! style="color:blue;width: 15%" |'''GET/transcription/list'''
! colspan="3" style="width: 85%" |Получение списка сохраненных стенограмм
|-
| colspan="2" style="width: 50%" |Входные параметры отсутствуют
| colspan="2" style="width: 50%" |[ { "id": "926e8d25-4275-4a78-906b-a1109cdacbea",

"name": "название",

"model": "big",

"created": "2024-03-29 12:37:42",

"modified": "2024-04-24 16:09:09",

"user": "0",

"dataset": "0" }, .... ]
|-
! style="color:green;width: 15%" |'''POST/transcription/save/{id}'''
! colspan="3" style="width: 85%" |Сохранение стенограмы. Используется для сохранения изменений по нажатию кнопки «Сохранить».
|-
| colspan="2" style="width: 50%" |
*'''data''' — стенограмма в json формате

*'''id''' стенограммы
| colspan="2" style="width: 50%" |{"error": 0,"message": "success"}
|-
! style="color:blue;width: 15%" |'''GET/transcription/waveform/{id}'''
! colspan="3" style="width: 85%" |Служебный метод для отображения аудио в графическом виде, ответ содержит пики сигнала
|-
| colspan="2" style="width: 50%" |
*'''id''' стенограммы
| colspan="2" style="width: 50%" |{ "error": 0,

"waveform": [

 0.016,

 ..........

 ..........

 0.015,

 0.01 ] }
|}

SPR. Руководство пользователя

2026-01-12T08:01:41Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short phrase recognizer предназначен для преобразования речи в текст. Принимает на вход аудиофайл в формате wav и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — предварительно обученная специализированная нейронная сеть для распознавания естественной речи в аудиозаписях.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SPR в реальном времени.

===== '''Описание методов API SPR''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SPR. По умолчанию используется порт 6183/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6183 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

<onlyinclude>
{| class="wikitable" style="width: 110%"
|+
|-
! style="color:blue;width: 15%"|'''GET:/spr/models'''
! colspan="3" |Вывод списка моделей.
|-
| colspan="3" |Без входных параметров.
|<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/audio/{taskID}'''
! colspan="3" |Получение файла аудиозаписи отложенного задания.
|-
| colspan="3" |taskID — идентификатор задания.
|Файл аудиозаписи или <code>{ error: INT , message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/export/{id}'''
! colspan="3" |Получение архива модели.
|-
| colspan="3" |id — идентификатор модели.
|ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/import/{id}'''
! colspan="3" |Добавление модели. Может быть добавлена как из файла архива, так и переименованием существующей модели.
|-
| colspan="3" |id — идентификатор модели, обязательный параметр.
zip-model — zip-архив с файлами модели.

Или

from-existing-model — название модели, которая должна перемещена на место id.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/delete/{id}'''
! colspan="3" |Удаление модели.
|-
| colspan="3" |id — идентификатор модели.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/queue'''
! colspan="3" |Получение очереди отложенных заданий на распознавание.
|-
| colspan="3" |Без входных параметров.
|<code>{</code>

<code>"id задания":</code>

<code>{</code>

<code> "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ",</code>

<code> "status": "waiting", # ready | waiting | failed</code>

<code> "filename": "wav"</code>

<code>}</code>

<code>}</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/queue/{taskID}'''
! colspan="3" |Удаление отложенных заданий на распознавание.
|-
| colspan="3" |taskID — идентификатор задания в очереди.
|<code>{</code>

<code>"error": 0,</code>

<code>"message": "success"</code>

<code>}</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/stt/{id}'''
! colspan="3" |Отправка файла на распознавание речи. Моно-файлы до 60 секунд распознаются без разбивки на фрагменты и определения спикеров. Многоканальные файлы и файлы длиннее 60 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в [[SPR. Руководство администратора.|руководстве администратора]].
|-
| colspan="3" style="width: 50%" |
* '''id''' — идентификатор модели
* '''wav''' — файл для распознавания
* '''speakers''' — опция поиска говорящих по базе SBS. Если 1, то дополнительно производится поиск говорящих и получение метаданных по каждому говорящему (используется сервис SBS с предварительно обученными слепками метаданных говорящих)
* '''punctuation''' — опция для расстановки знаков препинания. Если 1, то дополнительно вызывает метод punctuate в SMC и расставляет знаки препинания в распознанном тексте, значение по умолчанию берётся из файла конфигурации (для модели big пунктуация выполняется в любом случае).
* '''normalization''' — опция обратной нормализации текста, если 1, то выполняется обратная нормализация текста текста (для модели big выполняется в любом случае).
* '''vad''' — используемый VAD, по умолчанию webrtc
* '''toxicity''' — анализировать распознанный текст на токсичность через smc (GET/smc/toxicity).Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:"оскорбление": 0.13, "непристойность": 0, "угроза": 0, "вежливость": 0.53
* '''emotion''' — выявить эмоции из распознанного текста через smc (GET/smc/emotion). Возможные ответы: negative, neutral, positive.
* '''voice_analyzer''' — анализировать аудиофрагменты каждого из говорящих на эмоции, возраст и пол, запрашивается в sbs метод POST/sbs/analyze.Аудио говорящего анализируется на возраст (child, adult, old).Эмоции (ANGER, BORE, DISAPPOINTMENT, DISGUST, EXCITEMENT, FEAR, NEUTRAL, PAIN, PLEASURE, SADNESS, SUPRISE). Пол (male, female).
* '''speaker_counter''' — количество докладчиков, по умолчанию 0, автоматическое определение количества. При отправке значения -1 разделение на докладчиков будет отключено.
* '''async''' — отложенный запуск распознавания
* '''classifiers'''<nowiki> - дополнительно проанализировать все распознанные фразы через модели smc и/или see. отправляется в виде {"smс":"название модели":{ параметры запроса }}. Подробнее о параметрах запроса см. в документации по сервисам </nowiki>[[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].

| style="width: 50%" |В случае '''async=1''' возвращается только '''taskID''', результат по taskID смотреть в методе /spr/result.
'''Для коротких файлов''':

<code>{</code>

<code> "model": "call",</code>

<code> "text": "текст фрагмента",</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "words": [ </code>

<code>{ "word": "текст",</code>

<code> "start": 520,</code>

<code> "stop": 1240 },</code>

<code> { "word": "фрагмента",</code>

<code> "start": 1240,</code>

<code> "stop": 1920 }</code>

<code>]</code>

<code>}</code>

'''Для транскрибации больших файлов:'''

<code>{</code>

<code>"speakers": [</code>

<code> { </code>

<code>"id": null,</code>

<code> "duration": 18980,</code>

<code> "fragments": 3,</code>

<code> "age": "old", # только для voice_analyzer=1</code>

<code> "gender": "female" # только для voice_analyzer=1</code>

<code>}</code>

<code>],</code>

<code>"splitted": [</code>

<code> {</code>

<code>"start": "00:00:01.870",</code>

<code> "text": "текст.",</code>

<code> "words": [</code>

<code> { </code>

<code>"word": "текст.",</code>

<code> "start": 1870,</code>

<code> "stop": 2710,</code>

<code> "confidence": 0.95263671875</code>

<code>}</code>

<code>],</code>

<code> "stop": "00:00:05.510",</code>

<code> "channel": 0,</code>

<code> "duration": "00:00:03.640",</code>

<code> "start_ms": 1870,</code>

<code> "stop_ms": 5510,</code>

<code> "duration_ms": 3640,</code>

<code> "speaker": 4,</code>

<code> "speakerConfidence": 0.87,</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "toxicity": { # только для toxicity=1</code>

<code> "insult": 0,</code>

<code> "obscenity": 0,</code>

<code> "threat": 0,</code>

<code> "politeness": 0.99</code>

<code>},</code>

<code> "emotion": { "neutral": -0.3315 }, # только для emotion=1</code>

<code> "voice_analysis": { # только для voice_analyzer=1</code>

<code> "emotion": {</code>

<code> "class": "NEUTRAL",</code>

<code> "confidence": 0.7554781436920166 } </code>

<code>}</code>

<code>}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/result/{taskID}'''
! colspan="3" |Получение результата отложенного распознавания.
|-
| colspan="2" |taskID — идентификатор задания.
| colspan="2" |Вывод по окончанию распознавания аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи:ready — готово

waiting — ожидание

not found — не найдена

failed — сбой.
|-
! style="color:blue;width: 15%"|'''GET:/spr/waveform/{taskID}'''
! colspan="3" |Служебный метод для отображения аудио в графическом виде, содержит пики сигнала.
|-
| style="width: 50%" colspan="2" |taskID — идентификатор задания.
| colspan="2" |<code>{</code>

<code>"error": 0,</code>

<code>"waveform": [</code>

<code>0.016,</code>

<code> 0.015,</code>

<code> 0.01</code>

<code>]</code>

<code>}</code>
|}
</onlyinclude>

SPR. Руководство пользователя

2026-01-12T07:57:25Z

KorolkovS:

===== '''Общее описание''' =====
Сервис Short phrase recognizer предназначен для преобразования речи в текст. Принимает на вход аудиофайл в формате wav и возвращает структурированные данные в формате JSON.

===== '''Термины и определения''' =====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — предварительно обученная специализированная нейронная сеть для распознавания естественной речи в аудиозаписях.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису SPR в реальном времени.

===== '''Описание методов API SPR''' =====
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SPR. По умолчанию используется порт 6183/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code>

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8 или двоичный файл. Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6183 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

{| class="wikitable" style="width: 110%"
|+
|-
! style="color:blue;width: 15%"|'''GET:/spr/models'''
! colspan="3" |Вывод списка моделей.
|-
| colspan="3" |Без входных параметров.
|<code>{ models: [model1,...,modelN] }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/audio/{taskID}'''
! colspan="3" |Получение файла аудиозаписи отложенного задания.
|-
| colspan="3" |taskID — идентификатор задания.
|Файл аудиозаписи или <code>{ error: INT , message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/export/{id}'''
! colspan="3" |Получение архива модели.
|-
| colspan="3" |id — идентификатор модели.
|ZIP-файл с моделью, либо <code>{ error: INT , message: DESCRIPTION }</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/import/{id}'''
! colspan="3" |Добавление модели. Может быть добавлена как из файла архива, так и переименованием существующей модели.
|-
| colspan="3" |id — идентификатор модели, обязательный параметр.
zip-model — zip-архив с файлами модели.

Или

from-existing-model — название модели, которая должна перемещена на место id.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/delete/{id}'''
! colspan="3" |Удаление модели.
|-
| colspan="3" |id — идентификатор модели.
|<code>{ error: INT, message: DESCRIPTION }</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/queue'''
! colspan="3" |Получение очереди отложенных заданий на распознавание.
|-
| colspan="3" |Без входных параметров.
|<code>{</code>

<code>"id задания":</code>

<code>{</code>

<code> "created": "ХХХХ-ХХ-ХХ ХХ:ХХ:ХХ",</code>

<code> "status": "waiting", # ready | waiting | failed</code>

<code> "filename": "wav"</code>

<code>}</code>

<code>}</code>
|-
!style="color:red;width: 15%"|'''DELETE:/spr/queue/{taskID}'''
! colspan="3" |Удаление отложенных заданий на распознавание.
|-
| colspan="3" |taskID — идентификатор задания в очереди.
|<code>{</code>

<code>"error": 0,</code>

<code>"message": "success"</code>

<code>}</code>
|-
!style="color:green;width: 15%"|'''POST:/spr/stt/{id}'''
! colspan="3" |Отправка файла на распознавание речи. Моно-файлы до 60 секунд распознаются без разбивки на фрагменты и определения спикеров. Многоканальные файлы и файлы длиннее 60 секунд предварительно разбиваются на фрагменты по отсутствию речи. Настройка данных параметров описана в [[SPR. Руководство администратора.|руководстве администратора]].
|-
| colspan="3" style="width: 50%" |
* '''id''' — идентификатор модели
* '''wav''' — файл для распознавания
* '''speakers''' — опция поиска говорящих по базе SBS. Если 1, то дополнительно производится поиск говорящих и получение метаданных по каждому говорящему (используется сервис SBS с предварительно обученными слепками метаданных говорящих)
* '''punctuation''' — опция для расстановки знаков препинания. Если 1, то дополнительно вызывает метод punctuate в SMC и расставляет знаки препинания в распознанном тексте, значение по умолчанию берётся из файла конфигурации (для модели big пунктуация выполняется в любом случае).
* '''normalization''' — опция обратной нормализации текста, если 1, то выполняется обратная нормализация текста текста (для модели big выполняется в любом случае).
* '''vad''' — используемый VAD, по умолчанию webrtc
* '''toxicity''' — анализировать распознанный текст на токсичность через smc (GET/smc/toxicity).Высказывание анализируется по 4 параметрам, по каждому выдается вероятность от 0 до 1:"оскорбление": 0.13, "непристойность": 0, "угроза": 0, "вежливость": 0.53
* '''emotion''' — выявить эмоции из распознанного текста через smc (GET/smc/emotion). Возможные ответы: negative, neutral, positive.
* '''voice_analyzer''' — анализировать аудиофрагменты каждого из говорящих на эмоции, возраст и пол, запрашивается в sbs метод POST/sbs/analyze.Аудио говорящего анализируется на возраст (child, adult, old).Эмоции (ANGER, BORE, DISAPPOINTMENT, DISGUST, EXCITEMENT, FEAR, NEUTRAL, PAIN, PLEASURE, SADNESS, SUPRISE). Пол (male, female).
* '''speaker_counter''' — количество докладчиков, по умолчанию 0, автоматическое определение количества. При отправке значения -1 разделение на докладчиков будет отключено.
* '''async''' — отложенный запуск распознавания
* '''classifiers'''<nowiki> - дополнительно проанализировать все распознанные фразы через модели smc и/или see. отправляется в виде {"smс":"название модели":{ параметры запроса }}. Подробнее о параметрах запроса см. в документации по сервисам </nowiki>[[SMC. Руководство пользователя|smc]] и [[SEE. Руководство пользователя|see]].

| style="width: 50%" |В случае '''async=1''' возвращается только '''taskID''', результат по taskID смотреть в методе /spr/result.
'''Для коротких файлов''':

<code>{</code>

<code> "model": "call",</code>

<code> "text": "текст фрагмента",</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "words": [ </code>

<code>{ "word": "текст",</code>

<code> "start": 520,</code>

<code> "stop": 1240 },</code>

<code> { "word": "фрагмента",</code>

<code> "start": 1240,</code>

<code> "stop": 1920 }</code>

<code>]</code>

<code>}</code>

'''Для транскрибации больших файлов:'''

<code>{</code>

<code>"speakers": [</code>

<code> { </code>

<code>"id": null,</code>

<code> "duration": 18980,</code>

<code> "fragments": 3,</code>

<code> "age": "old", # только для voice_analyzer=1</code>

<code> "gender": "female" # только для voice_analyzer=1</code>

<code>}</code>

<code>],</code>

<code>"splitted": [</code>

<code> {</code>

<code>"start": "00:00:01.870",</code>

<code> "text": "текст.",</code>

<code> "words": [</code>

<code> { </code>

<code>"word": "текст.",</code>

<code> "start": 1870,</code>

<code> "stop": 2710,</code>

<code> "confidence": 0.95263671875</code>

<code>}</code>

<code>],</code>

<code> "stop": "00:00:05.510",</code>

<code> "channel": 0,</code>

<code> "duration": "00:00:03.640",</code>

<code> "start_ms": 1870,</code>

<code> "stop_ms": 5510,</code>

<code> "duration_ms": 3640,</code>

<code> "speaker": 4,</code>

<code> "speakerConfidence": 0.87,</code>

<code>"classifiers": тут ответы от моделей smc и see,</code>

<code> "toxicity": { # только для toxicity=1</code>

<code> "insult": 0,</code>

<code> "obscenity": 0,</code>

<code> "threat": 0,</code>

<code> "politeness": 0.99</code>

<code>},</code>

<code> "emotion": { "neutral": -0.3315 }, # только для emotion=1</code>

<code> "voice_analysis": { # только для voice_analyzer=1</code>

<code> "emotion": {</code>

<code> "class": "NEUTRAL",</code>

<code> "confidence": 0.7554781436920166 } </code>

<code>}</code>

<code>}</code>

<code>]</code>

<code>}</code>
|-
! style="color:blue;width: 15%"|'''GET:/spr/result/{taskID}'''
! colspan="3" |Получение результата отложенного распознавания.
|-
| colspan="2" |taskID — идентификатор задания.
| colspan="2" |Вывод по окончанию распознавания аналогичен выводу метода stt + добавлено поле status, которое содержит информацию о статусе отложенной задачи:ready — готово

waiting — ожидание

not found — не найдена

failed — сбой.
|-
! style="color:blue;width: 15%"|'''GET:/spr/waveform/{taskID}'''
! colspan="3" |Служебный метод для отображения аудио в графическом виде, содержит пики сигнала.
|-
| style="width: 50%" colspan="2" |taskID — идентификатор задания.
| colspan="2" |<code>{</code>

<code>"error": 0,</code>

<code>"waveform": [</code>

<code>0.016,</code>

<code> 0.015,</code>

<code> 0.01</code>

<code>]</code>

<code>}</code>
|}

SPR. Руководство администратора

2026-01-12T07:36:34Z

KorolkovS:

===== '''Общее описание сервиса распознавания речи (SPR)''' =====
Сервис предназначен для преобразования естественной речи в текст. Входными данными для сервиса являются аудиофайлы в формате *.wav, результатом работы выступают данные в текстовом формате.

====='''Термины и определения'''=====
Short Phrase Recognizer (SPR) — сервис распознавания речи.

Модель — модель нейронной сети, описывает её архитектуру и конфигурацию, а также используемые алгоритмы обучения.

====='''Расчет нагрузки SPR'''=====
Для нормальной работы сервиса требуются CPU с поддержкой инструкций AVX2 или новее.

Сервис требует разных ресурсов в зависимости от сценария использования.

Распознавание для голосовых помощников — рекомендуется модель common и работа на GPU NVIDIA. Возможна работа на CPU. В этом случае приемлемую задержку распознавания для одиночных фраз можно получить на ВМ с 8 потоками, 6 Гб оперативной памяти с резервом по частоте 9600 МГц (соответствует 4 ядрам по 2,4 ГГц). В этом случае 8-секундная речь будет распознана ориентировочно за 0,8 с. 4 таких ВМ обеспечат распознавание голоса абонента в диалогах длительностью 60–80 с с количеством одновременных диалогов до 60.

В случае использования GPU A16 (одной из 4 голов на ВМ 8 потоков, 6 Гб) 8-секундная речь будет распознана примерно за 0,2 с. На такой ВМ можно распознавать до 100 одновременных диалогов. При расчетах и моделировании предполагалось, что за весь диалог длительностью 60–80 с будет распознано до 6 фраз длительностью до 8 с. GPU A16 содержит 1300 ядер CUDA в одной голове. На более мощных GPU возможности возрастают кратно количеству CUDA ядер.

При распознавании для голосовых помощников рекомендуется использовать от 2-х воркеров gunicorn (-w 2 в строке запуска в файле службы) в зависимости от наличия памяти.

Распознавание для диаризации (транскрибации) длительных переговоров — одновременное, используются модели common и big. Распознавание на CPU в этом режиме не поддерживается. Для распознавания рекомендуется минимум ВМ 8 ядер 16 Гб GPU A16. На такой ВМ время распознавания в 2,5 раза меньше длительности аудио. На GPU V100 время распознавания меньше длительности аудио ориентировочно в 5 раз. Пример распознавания одного и того же файла на разных GPU:
{| class="wikitable" style="text-align: center"
|+
!Карта
!Видеопамять
!Количество ядер CUDA
!Время распознавания
(минут)
!Примечание
|-
|'''<big>A100</big>'''
|80
|6912
|12
|
|-
|'''<big>V100</big>'''
|16
|5120
|16
|
|-
|'''<big>RTX 3060</big>'''
|12
|3584
|24
|
|-
|'''<big>A16</big>'''
|'''16'''
|1280
|33
|1/4 карты
|}

Переключение между режимами распознавания — в зависимости от длительности аудио. Аудио короче 30 с распознаются для голосовых помощников. Остальные аудио разбиваются на фразы и выделяются фрагменты речи, принадлежащие разным лицам, то есть формат вывода тоже изменяется.

Требования к загружаемому аудио

Для преобразования фрагментов речи в текст используйте аудио в форматах, поддерживаемых ffmpeg.

====='''Установка/обновление SPR'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr&fileid=519 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление SPR осуществляется скриптом <code>chmod +x ./spr-<версия>-<релиз>.sh && ./spr-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./spr-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/spr</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить SPR <code>/opt/spr/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/spr/inupdate -b</code> — обновить до последней beta версии;
** <code>/opt/spr/inupdate -r</code> — обновить до последней release версии;
** <code>/opt/spr/inupdate -n</code> — обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/spr/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/spr/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> — это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/spr/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей),
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/spr/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету),

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable spr.service && sudo systemctl start spr.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status spr.service</code>

Разрешите доступ к порту 6183 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/spr/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "spr", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start spr</code> и извлечь UUID, указанный в файле <code>/opt/spr/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

===== '''Установка моделей SPR'''=====
Установка моделей возможна прямым копированием файла модели или загрузкой через API сервиса (метод POST /spr/data/{id}).

Модели располагаются в каталоге /opt/spr/nnets/. Для установки модели необходимо создать каталог /opt/spr/nnets/<название модели>/ и скопировать в него содержимое архива модели, после чего перезагрузить сервис командой systemctl restart spr.

Чтобы убедиться, что модели доступны, выполните запрос

<code>curl -H "accept: application/json" -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>"</code>

В ответе должно содержаться название новой модели или перечень названий моделей в формате json.

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/common</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code>

Некоторые модели работают только на GPU. На данный момент такая модель только одна — «big». 

===== '''Внешние модули распознавания''' =====
Сервис SPR поддерживает установку произвольных модулей распознавания. Для этого папка external должна содержать директорию с нужным модулем, в которой обязательным является наличие файла handler.py с функцией recognize(data, sr). Сервис передаст в данную функцию аудиоданные в переменную data, в формате pydub.AudioSegment, а также значение sample rate в переменной sr. Готовые внешние модули распознавания доступны по [https://cloud.connect2ai.net/index.php/apps/files/?dir=/spr ссылке].

Проверить корректность работы модели можно запросом к API с отправкой файла на распознавание:

<code>curl -X POST "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/stt/Имя_Модуля</nowiki>" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "wav=@ФАЙЛ.wav;type=audio/wav"</code> Со списком методов можно ознакомиться в [[SPR. Руководство пользователя|руководстве пользователя]]. Метод на загрузку модели <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/data/Имя_Модуля</nowiki>" -H "accept: application/json"</code> не работает с модулями в целях безопасности. Также модули не отображаются в списке моделей по запросу <code>curl -X GET "<nowiki>http://АДРЕС_СЕРВЕРА:6183/spr/</nowiki>" -H "accept: application/json"</code>. В некоторых модулях конфигурация может быть вынесена в отдельный файл. Например, для модуля yandex это - /opt/spr/external/config.json.

===== '''Конфигурирование параметров сервиса SPR'''=====
Настройка параметров сервиса spr производится в файле /opt/spr/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
|device
|cuda:0
|Устройство, используемое для работы сервиса (cpu/cuda:N) N - GPU, в ОЗУ которого будут загружены модели сервиса
|-
|max_gpu_memory
|0.99
|Лимит использования ОЗУ видеокарты.
|-
|punctuation
|false
|Расстановка знаков препинания через [[SMC. Руководство пользователя|сервис SMC]].
|-
|normalization
|false
|Обратная нормализация текста через [[SMC. Руководство пользователя|сервис SMC]].
|-
|toxicity
|false
|Анализ текста на токсичность через [[SMC. Руководство пользователя|сервис SMC]].
|-
|emotions
|false
|Анализ текста на эмоции через [[SMC. Руководство пользователя|сервис SMC]].
|-
|voice_analyzer
|false
|Анализ голоса спикера на эмоции, возраст, пол через [[SBS. Руководство пользователя.|сервис SBS]].
|-
|save_audio_requests
|false
|Записывать аудио получаемые для распознавания в синхронном режиме. Будут сохраняться в /tmp/spr/. Только для диагностики. Не применять в нагруженных серверах.
|-
|logs.path
|logs/
|Путь к папке логов.
|-
|logs.backups
|10
|Количество старых сохраняемых логов.
|-
|logs.maxSize
|5242880
|Максимальный размер текущего лог-файла в байтах.
|-
|cache.lifetime
|604800
|Время жизни кэша результатов отложенного распознавания.
|-
| sbs.url
|<nowiki>http://127.0.0.1:6185</nowiki>
|Путь к [[SBS. Руководство пользователя|сервису биометрии]] для получения метаданных голосового фрагмента.
|-
|sbs.conn_timeout
|2
|Таймаут на подключение к API SBS.
|-
|sbs.read_timeout
|30
|Таймаут на получение ответа от API SBS.
|-
|smc.url
|<nowiki>http://127.0.0.1:6181</nowiki>
|Путь к [[SMC. Руководство пользователя|сервису классификации]] для дополнительной работы с распознанным текстом.
|-
|smc.conn_timeout
|2
|Таймаут на подключение к API SMC.
|-
|smc.read_timeout
|30
|Таймаут на получение ответа от API SMC.
|-
|see.url
|<nowiki>http://127.0.0.1:6184</nowiki>
|Путь к [[SEE. Руководство пользователя|сервису поиска сущностей]] для дополнительной работы с распознанным текстом.
|-
|see.conn_timeout
|2
|Таймаут на подключение к API SEE.
|-
|see.read_timeout
|30
|Таймаут на получение ответа от API SEE.
|-
|vad.default
|webrtc
|Тип VAD по умолчанию для разбивки аудиофайлов. Возможные значения — пока только webrtc.
|-
|vad.maxSilence
|2000
|Длительность паузы в речи в миллисекундах для разбивки длинных аудиофайлов на фрагменты.
|-
|speakers.similarityThreshold
|0.7
|Порог различия для разделения говорящих.
|-
|speakers.maxSpeechLength
|10000
|Максимальная длительность фрагмента для сравнения говорящих в миллисекундах.
|-
|speakers.wordMinLimit
|5
|Минимальный размер фразы при определении говорящих.
|-
|speakers.timeMinLimit
|3000
|Минимальная длительность аудио, чтобы оно могло быть использовано для добавления нового говорящего.
|-
|speakers.batch
|4
|Количество одновременного анализируемых аудиофрагментов при разделении говорящих.
|-
|speakers.concatEqual
|true
|Позволяет склеивать последовательные фразы одного и того же говорящего.
|-
|speakers.defaultModel
|call
|Модель определения говорящего.
|-
|blacklist
|[]
|Список моделей распознавания в папках nnets и external, которые не должны быть загружены при старте сервиса SPR.
|-
|corrections
|{ "big": "common" }
|Добавление модели коррекции для стенографирования.
|-
|garbage
|[ "—", "[*]" ]
|Массив фраз, которые считаются мусорными и откидываются из распознанного текста.
|-
|cluster.logfile
|logs/sync.log
|путь к логу синхронизации ноды кластера
|-
|cluster.statusFile
|logs/sync.status
|путь к файлу статуса ноды кластера
|-
|cluster.nodes
|[]
|список IP адресов нод кластера
|}

====='''Сбор данных об ошибках'''=====
Логи сервиса по умолчанию находятся в файле /opt/spr/logs/log.txt 

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/spr/uninstall</code>. Команда удалит сервис и рабочий каталог, включая все установленные модели.

====='''Практические рекомендации'''=====
Сервис spr на системах с видеокартой на большой нагрузке может не полностью использовать ресурсы GPU, при этом могут быть задержки в распознавании. Для более полного использования ресурсов рекомендуется в строке запуска gunicorn в файле сервиса добавить параметр «'''-w 2'''». Это приведет к загрузке в видеопамять 2-х экземпляров приложения и моделей. Таким образом приложение сможет более эффективно использовать ресурсы GPU, но при этом возрастет потребность в памяти GPU.

В случае если в системе обработки речи используется несколько несимметричных по ресурсам серверов spr, регулировать нагрузку на них можно указывая адрес сервера, в котором больше ресурсов, большее количество раз в разделе «spr.cluster» конфигурационного файла ups.

PVE. Установка сервисного пакета окружения

2025-12-26T13:27:29Z

KorolkovS:

===== '''Общее описание''' =====
Пакет Python Virtual Environment (PVE) предназначен для подготовки виртуального Python3 окружения для работы сервисов:
• Simple Entity Extractor
• Simple Message Classifier
• Short Phrase Recognizer
• Simple Biometry Server
• Text To Speech Server
• Question Answering System
• Script Engine Service
• Report Engine Service

====='''Термины и определения'''=====
Python Virtual Environment (PVE) – пакет для установки Python3 окружения для сервисов. Самостоятельно PVE не используется.

====='''Расчет нагрузки'''=====
Для установки пакета требуется свободное место в каталоге /opt не менее 4Gb без поддержки видеокарты и/или 12Gb с поддержкой.

Также при установке используется временная папка /tmp/archive, куда распаковывается содержимое архива до 9Gb.

====='''Установка/обновление пакета окружения'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/pve&fileid=612 Дистрибутив] распространяется в виде универсального установочного пакета. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Пакет может быть установлен в ''онлайн''-режиме при наличии прямого доступа в интернет или через прокси. Для установки в ''оффлайн''-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версии и ядра) с доступом в интернет.
* Загрузить последнюю версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/pve</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить PVE <code>/opt/pve/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/pve/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/pve/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/pve/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с окружением можно добавить 2 файла конфигурации (данные файлы также будут использоваться продуктами при отсутствии у них своих):
** echo -n <code>"[user]:[pass]"</code> > /opt/pve/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/pve/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)
При установке рядом со скриптом окружения можно положить freeze.txt с альтернативным набором модулей. В потоке вывода в результате вы увидите сообщение «Существует внешний файл — список модулей pip3».

===== '''Варианты использование инсталлятора'''=====

Описание ключей установки приведено в таблице
{| class="wikitable"
|+
!Параметр,
назначение
!Параметр,
назначение
!Параметр,
назначение
!Примечание
|-
|''-i/--install - установить окружение''
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы установить в оффлайн-режиме, необходимо собрать скрипт с ключом -b/--build. Установка с ключом CPU актуальна при отсутствии видеокарты в системе, окружение занимает всего ~3Gb.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -u/--update - обновить окружение
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы обновить в оффлайн режиме, необходимо собрать скрипт с ключом -b/--build. Обновление с ключом CPU актуально при отсутствии видеокарты в системе, окружение занимает всего ~3Gb. Обновление отличается от установки тем, что пропускается этап установки системных пакетов. Ставится только окружение с модулями. Оффлайн инсталлятор с ключом обновления становится универсальным под любую ОС, так как не зависим от системных пакетов.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -b/--build - скачать все пакеты, и модули, и упаковать в скрипт
|''-i/--install - для установки с системными пакетами''
| -f/--full - полный набор pip3 модулей под все типы
| rowspan="6" |Данные наборы ключей используются совместно, в разных комбинациях. Сборка с ключом CPU актуальна при отсутствии видеокарты в системе, собранный инсталлятор весит ~1Gb. Ключ полного набора модулей делает инсталлятор универсальным, но такой инсталлятор весит ~12Gb. Если инсталлятор был собран с ключом установки под другую ОС, его также можно использовать с ключом обновления для текущей или любой другой. Если набор модулей, который включен в оффлайн инсталлятор, недостаточен, он попытается загрузить недостающие модули из интернета напрямую или предложит ввести настройки прокси.
|-
|
| -u/--update - для обновления, только окружение
| -cpu/--cpu - полный набор pip3 модулей под CPU
|-
|
|
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -u/--uninstall - удалить окружение
|
|
|Одинарный ключ, удаляет окружение из папки /opt
|-
| -e/--extract - скопировать внутренний архив рядом со скриптом
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки, распакуется архив. С указанием папки, распакуется содержимое архива в указанную папку.
|-
| -p/--pack имя_архива - запаковать архив в скрипт
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки к установщику прикрепляем архив. С указанием папки к установщику прикрепляем содержимое каталога.
|-
| -n/--null - удалить внутренний архив из скрипта
|
|
|Удаляем внутренний архив из инсталлятора. Редактирование инсталлятора с архивом может привести к повреждению архива.
|}
Примеры использования ключей:

-- Установить окружение с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -on</code>

-- Установить окружение из заранее собранного инсталлятора с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -off</code>

-- Собрать все пакеты для установки оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -i -cpu</code>

-- Собрать все пакеты для обновления оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -u -cpu</code>

-- Скопировать внутренний архив рядом со скриптом, не распаковывая в папку.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e</code>

-- Запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p <service>-offline.tgz</code>

-- Сжать каталог и запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p -d <имя каталога></code>

-- Распаковать внутренний архив рядом со скриптом в каталог.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e -d archive</code>

-- Удалить внутренний архив из скрипта.

Пример использования: <code>./pve-<версия>-<релиз>.sh --null</code>

-- Удалить окружение.

Пример использования: <code>./pve-<версия>-<релиз>.sh --uninstall</code>

====='''Удаление окружения'''=====
Для удаления выполните команду: <code>/opt/pve/uninstall</code>.

QAS. Руководство администратора

2025-12-26T09:59:47Z

KorolkovS:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.
====='''Термины и определения'''=====
Question Answering System (QAS) – сервис ответов на вопросы.

====='''Системные требования'''=====
Для нормальной работы сервиса без GPU необходимо не менее 8 CPU (минимальные требования для использования метода ask) >= 2.20 GHz с поддержкой инструкций AVX2 или новее:
*Intel Haswell
*Intel Broadwell
*Intel Skylake
*Intel Kaby Lake
*Intel Coffee Lake
*Intel Comet Lake
*Intel Rocket Lake
*Intel Alder Lake
*AMD Excavator
*AMD Zen (AMD Ryzen)
*AMD Zen 2 (AMD Ryzen)
*AMD Zen 3 (AMD Ryzen)
Работа на CPU при использовании метода ask крайне не рекомендуется. Оперативной памяти необходимо не менее 16Gb для работы без GPU.

====='''Установка/обновление сервиса'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/qas&fileid=26891 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить отдельный сервисный пакет окружения под QAS]].

* Установка/обновление QAS осуществляется скриптом <code>chmod +x ./qas-<версия>-<релиз>.sh && ./qas-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./qas-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s https://repo.connect2ai.net/api/qas --user '[user]:[pass]' 2>&1)"</code>.
* Обновить QAS <code>/opt/qas/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/qas/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/qas/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/qas/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/qas/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/qas/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/qas/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable qas.service && sudo systemctl start qas.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status qas.service</code>

Разрешите доступ к порту 6187 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/qas/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "qas", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start qas</code> и извлечь UUID, указанный в файле <code>/opt/qas/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка моделей'''=====

В составе QAS используются модели векторизации, и генеративные модели LLM.

Модели векторизации располагаются в папках:

* /opt/qas/pretrained/embeddings/questions - для работы с кэшем вопросов
* /opt/qas/pretrained/embeddings/docs - для работы с документами
* /opt/qas/pretrained/embeddings/rerank - для реранжирования документов

Расположение моделей LLM: /opt/qas/pretrained/gpt/<имя_модели>/. Например , встроенная модель LLM: /opt/qas/pretrained/gpt/default/. Модели после установки QAS должны быть добавлены системным администратором.

QAS допускает использование дополнительных моделей LLM. Каждая из таких моделей должна быть в отдельной папке каталога /opt/qas/pretrained/gpt/<имя_модели>/. Если модель формата GGUF, то достаточно поместить ее в свою папку в /opt/qas/pretrained/gpt/. В остальных случаях (в том числе и если необходимо обращаться к стороннему api) в папке модели должен быть файл handler.py с функцией handler(prompt='тут текст',params={параметры запроса, см. в руководстве пользователя в метода добавления шаблона запроса}), которая возвращает сгенерированный текст.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:

* База файловая, в папке data.
* lsync настроен через конфиг QAS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах прописан в конфиге master, чтобы все операции добавления и изменения данных при автокешировании они производили через мастер. Параметр в конфиге questions.master, на мастере значение «<nowiki>http://127.0.0.1:6187»</nowiki>.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером QAS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.qas.trainer указываем мастер-сервер, в servers.qas.cluster перечисляем все сервера кластера QAS, в том числе и мастер.

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса qas производится в файле /opt/qas/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!По умолчанию
!Назначение
|-
|reloader.period
|60
|Период обновления векторов базы вопросов и документов.
|-
|gpt.instances
|1
|Количество экземпляров встроенной нейросети
|-
|gpt.gpu_layers
|12
|Количество слоёв gpt нейросети, загружаемых в память видеокарты. Остальные слои загрузятся в оперативную память. Чтобы загрузить '''всю''' модель в ГПУ использовать значение "'''-1'''"
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|2560000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|fragments.context
|16384
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.5
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|fragments.alpha
|0.5
|Параметр alpha — весовой коэффициент в формуле итоговой релевантности фрагмента, которая объединяет результаты двух моделей: векторизации и реранжирования.
Настройка параметра:

- Высокие значения (близкие к 1.0): Система в большей степени доверяет результатам модели векторизации.

- Низкие значения (близкие к 0.0): Система больше полагается на более точную, но ресурсоемкую модель реранжирования.
|-
|fragments.filters
|[
"^\\d+\\.$",

"^[^\\S\n]*[(\\{\\[«\"]?\\d+\\.[^\\S\\\n]*$",

"^[{}\\[\\]]$",

"^[a-z]{2,3}\\.?$",

"^(?:https?|ftp|www|com|org|net|io|co|edu|gov|html)$"

]
|Список регулярных выражений, который используются как фильтр мусора для векторизации. Все что вызывает положительно срабатывание не будет векторизовано.
|-
|questions.master
|"<nowiki>http://127.0.0.1:6187</nowiki>"
|Адрес мастер-сервера для работы в кластере. Необходим, чтобы добавленные вопросы распространились на серверы кластера.
|-
|questions.threshold
|0.9
|Минимальный уровень достоверности ответа для попадания в кеш.
|-
|cluster.logfile
|logs/sync.log
|Расположение лог-файла синхронизации (актуально для мастер-сервера).
|-
|cluster.logfile
|logs/sync.status
|Расположение файла статуса lsyncd (актуально для мастер-сервера)
|-
|cluster.nodes
|[ ]
|Ноды кластера, на которые с мастер-сервера будут распространяться изменения.
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/qas/logs/log.txt

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/qas/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

PVE. Установка сервисного пакета окружения

2025-12-26T09:55:47Z

KorolkovS:

===== '''Общее описание''' =====
Пакет Python Virtual Environment (PVE) предназначен для подготовки виртуального Python3 окружения для работы сервисов:
• Simple Entity Extractor
• Simple Message Classifier
• Short Phrase Recognizer
• Simple Biometry Server
• Text To Speech Server
• Question Answering System
• Script Engine Service
• Report Engine Service

====='''Термины и определения'''=====
Python Virtual Environment (PVE) – пакет для установки Python3 окружения для сервисов. Самостоятельно PVE не используется.

====='''Расчет нагрузки'''=====
Для установки пакета требуется свободное место в каталоге /opt не менее 4Gb без поддержки видеокарты и/или 12Gb с поддержкой.

Также при установке используется временная папка /tmp/archive, куда распаковывается содержимое архива до 9Gb.

====='''Установка/обновление пакета окружения'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/pve&fileid=612 Дистрибутив] распространяется в виде универсального установочного пакета. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Пакет может быть установлен в ''онлайн''-режиме при наличии прямого доступа в интернет или через прокси. Для установки в ''оффлайн''-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версии и ядра) с доступом в интернет.
* Загрузить последнюю версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/pve</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить PVE <code>/opt/pve/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/pve/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/pve/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/pve/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с окружением можно добавить 2 файла конфигурации (данные файлы также будут использоваться продуктами при отсутствии у них своих):
** echo -n <code>"[user]:[pass]"</code> > /opt/pve/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/pve/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)
При установке рядом со скриптом окружения можно положить freeze.txt с альтернативным набором модулей. В потоке вывода в результате вы увидите сообщение «Существует внешний файл — список модулей pip3».

===== '''Варианты использование инсталлятора'''=====

Описание ключей установки приведено в таблице
{| class="wikitable"
|+
!Параметр,
назначение
!Параметр,
назначение
!Параметр,
назначение
!Примечание
|-
|''-i/--install - установить окружение''
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы установить в оффлайн-режиме, необходимо собрать скрипт с ключом -b/--build. Установка с ключом CPU актуальна при отсутствии видеокарты в системе, окружение занимает всего ~3Gb.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -u/--update - обновить окружение
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы обновить в оффлайн режиме, необходимо собрать скрипт с ключом -b/--build. Обновление с ключом CPU актуально при отсутствии видеокарты в системе, окружение занимает всего ~3Gb. Обновление отличается от установки тем, что пропускается этап установки системных пакетов. Ставится только окружение с модулями. Оффлайн инсталлятор с ключом обновления становится универсальным под любую ОС, так как не зависим от системных пакетов.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -b/--build - скачать все пакеты, и модули, и упаковать в скрипт
|''-i/--install - для установки с системными пакетами''
| -f/--full - полный набор pip3 модулей под все типы
| rowspan="6" |Данные наборы ключей используются совместно, в разных комбинациях. Сборка с ключом CPU актуальна при отсутствии видеокарты в системе, собранный инсталлятор весит ~1Gb. Ключ полного набора модулей делает инсталлятор универсальным, но такой инсталлятор весит ~9Gb. Если инсталлятор был собран с ключом установки под другую ОС, его также можно использовать с ключом обновления для текущей или любой другой. Если набор модулей, который включен в оффлайн инсталлятор, недостаточен, он попытается загрузить недостающие модули из интернета напрямую или предложит ввести настройки прокси.
|-
|
| -u/--update - для обновления, только окружение
| -cpu/--cpu - полный набор pip3 модулей под CPU
|-
|
|
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
|
|
| -ses/--ses - отдельное окружение для ses
|
|-
|
|
| -qas-cpu/--qas-cpu - отдельное окружение для QAS под CPU
|
|-
|
|
| -qas-cu12/--qas-cu12 - отдельное окружение для QAS под CUDA12
|
|-
| -u/--uninstall - удалить окружение
|
|
|Одинарный ключ, удаляет окружение из папки /opt
|-
| -e/--extract - скопировать внутренний архив рядом со скриптом
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки, распакуется архив. С указанием папки, распакуется содержимое архива в указанную папку.
|-
| -p/--pack имя_архива - запаковать архив в скрипт
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки к установщику прикрепляем архив. С указанием папки к установщику прикрепляем содержимое каталога.
|-
| -n/--null - удалить внутренний архив из скрипта
|
|
|Удаляем внутренний архив из инсталлятора. Редактирование инсталлятора с архивом может привести к повреждению архива.
|}
Примеры использования ключей:

-- Установить окружение с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -on</code>

-- Установить окружение из заранее собранного инсталлятора с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -off</code>

-- Собрать все пакеты для установки оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -i -cpu</code>

-- Собрать все пакеты для обновления оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -u -cpu</code>

-- Скопировать внутренний архив рядом со скриптом, не распаковывая в папку.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e</code>

-- Запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p <service>-offline.tgz</code>

-- Сжать каталог и запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p -d <имя каталога></code>

-- Распаковать внутренний архив рядом со скриптом в каталог.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e -d archive</code>

-- Удалить внутренний архив из скрипта.

Пример использования: <code>./pve-<версия>-<релиз>.sh --null</code>

-- Удалить окружение.

Пример использования: <code>./pve-<версия>-<релиз>.sh --uninstall</code>

====='''Удаление окружения'''=====
Для удаления выполните команду: <code>/opt/pve/uninstall</code>.

PVE. Установка сервисного пакета окружения

2025-11-25T10:40:23Z

KorolkovS:

===== '''Общее описание''' =====
Пакет Python Virtual Environment (PVE) предназначен для подготовки виртуального Python3 окружения для работы сервисов:
• Simple Entity Extractor
• Simple Message Classifier
• Short Phrase Recognizer
• Simple Biometry Server
• Text To Speech Server
• Question Answering System
• Script Engine Service
• Report Engine Service

====='''Термины и определения'''=====
Python Virtual Environment (PVE) – пакет для установки Python3 окружения для сервисов. Самостоятельно PVE не используется.

====='''Расчет нагрузки'''=====
Для установки пакета требуется свободное место в каталоге /opt не менее 4Gb без поддержки видеокарты и/или 19Gb с поддержкой.

Также при установке используется временная папка /tmp/archive, куда распаковывается содержимое архива до 17Gb.

====='''Установка/обновление пакета окружения'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/pve&fileid=612 Дистрибутив] распространяется в виде универсального установочного пакета. Для установки пакета запустить инсталлятор с требуемыми ключами. При запуске без ключей инсталлятор выдаст короткую справку. Пакет может быть установлен в ''онлайн''-режиме при наличии прямого доступа в интернет или через прокси. Для установки в ''оффлайн''-режиме сперва нужно запустить экземпляр скрипта на копии целевой системы (версии и ядра) с доступом в интернет.
* Загрузить последнюю версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s <nowiki>https://repo.connect2ai.net/api/pve</nowiki> --user '[user]:[pass]' 2>&1)"</code>.
* Обновить PVE <code>/opt/pve/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/pve/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/pve/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/pve/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Проверить актуальную версию окружения <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/pve/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с окружением можно добавить 2 файла конфигурации (данные файлы также будут использоваться продуктами при отсутствии у них своих):
** echo -n <code>"[user]:[pass]"</code> > /opt/pve/.userapi (это файл авторизации в API, нужен для обновления)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/pve/.proxy (это файл конфигурации proxy, необходим для обновления, при отсутствующем прямом подключении к интернету)
При установке рядом со скриптом окружения можно положить freeze.txt с альтернативным набором модулей. В потоке вывода в результате вы увидите сообщение «Существует внешний файл — список модулей pip3».

===== '''Варианты использование инсталлятора'''=====

Описание ключей установки приведено в таблице
{| class="wikitable"
|+
!Параметр,
назначение
!Параметр,
назначение
!Параметр,
назначение
!Примечание
|-
|''-i/--install - установить окружение''
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы установить в оффлайн-режиме, необходимо собрать скрипт с ключом -b/--build. Установка с ключом CPU актуальна при отсутствии видеокарты в системе, окружение занимает всего ~3Gb.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -u/--update - обновить окружение
| -on/--online - онлайн
| -cpu/--cpu - полный набор pip3 модулей под CPU
| rowspan="5" |Данные наборы ключей используются совместно, в разных комбинациях. Чтобы обновить в оффлайн режиме, необходимо собрать скрипт с ключом -b/--build. Обновление с ключом CPU актуально при отсутствии видеокарты в системе, окружение занимает всего ~3Gb. Обновление отличается от установки тем, что пропускается этап установки системных пакетов. Ставится только окружение с модулями. Оффлайн инсталлятор с ключом обновления становится универсальным под любую ОС, так как не зависим от системных пакетов.
|-
|
| -off/--offline - оффлайн
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -b/--build - скачать все пакеты, и модули, и упаковать в скрипт
|''-i/--install - для установки с системными пакетами''
| -f/--full - полный набор pip3 модулей под все типы
| rowspan="6" |Данные наборы ключей используются совместно, в разных комбинациях. Сборка с ключом CPU актуальна при отсутствии видеокарты в системе, собранный инсталлятор весит ~1Gb. Ключ полного набора модулей делает инсталлятор универсальным, но такой инсталлятор весит ~9Gb. Если инсталлятор был собран с ключом установки под другую ОС, его также можно использовать с ключом обновления для текущей или любой другой. Если набор модулей, который включен в оффлайн инсталлятор, недостаточен, он попытается загрузить недостающие модули из интернета напрямую или предложит ввести настройки прокси.
|-
|
| -u/--update - для обновления, только окружение
| -cpu/--cpu - полный набор pip3 модулей под CPU
|-
|
|
| -cu11/--cu11- полный набор pip3 модулей под GPU CU11.8
|-
|
|
| -cu12/--cu12 - полный набор pip3 модулей под GPU CU12.8
|-
|
|
| -ups/--ups - отдельное окружение для ups
|-
|
|
| -res/--res - отдельное окружение для res
|-
| -u/--uninstall - удалить окружение
|
|
|Одинарный ключ, удаляет окружение из папки /opt
|-
| -e/--extract - скопировать внутренний архив рядом со скриптом
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки, распакуется архив. С указанием папки, распакуется содержимое архива в указанную папку.
|-
| -p/--pack имя_архива - запаковать архив в скрипт
| -d/--dir путь/имя_каталога
|
|Второй аргумент не обязательный. Без указания папки к установщику прикрепляем архив. С указанием папки к установщику прикрепляем содержимое каталога.
|-
| -n/--null - удалить внутренний архив из скрипта
|
|
|Удаляем внутренний архив из инсталлятора. Редактирование инсталлятора с архивом может привести к повреждению архива.
|}
Примеры использования ключей:

-- Установить окружение с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -on</code>

-- Установить окружение из заранее собранного инсталлятора с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -i -cpu -off</code>

-- Собрать все пакеты для установки оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -i -cpu</code>

-- Собрать все пакеты для обновления оффлайн окружения с полным набором модулей под CPU.

Пример использования: <code>./pve-<версия>-<релиз>.sh -b -u -cpu</code>

-- Скопировать внутренний архив рядом со скриптом, не распаковывая в папку.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e</code>

-- Запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p <service>-offline.tgz</code>

-- Сжать каталог и запаковать архив в скрипт.

Пример использования: <code>./pve-<версия>-<релиз>.sh -p -d <имя каталога></code>

-- Распаковать внутренний архив рядом со скриптом в каталог.

Пример использования: <code>./pve-<версия>-<релиз>.sh -e -d archive</code>

-- Удалить внутренний архив из скрипта.

Пример использования: <code>./pve-<версия>-<релиз>.sh --null</code>

-- Удалить окружение.

Пример использования: <code>./pve-<версия>-<релиз>.sh --uninstall</code>

====='''Удаление окружения'''=====
Для удаления выполните команду: <code>/opt/pve/uninstall</code>.